machblue_init.h
上传用户:fy98168
上传日期:2015-06-26
资源大小:13771k
文件大小:5k
源码类别:

DVD

开发平台:

C/C++

  1. /*-----------------------------------------------------------------------------
  2.  | @(#) machblue_init.h
  3.  |
  4.  |  JSWF: The Portable SWF Engine For Embedded Devices,
  5.  |  Copyright (c) 2002-2006, BlueStreak Technology Inc., All Rights Reserved.
  6.  |
  7.  +----------------------------------------------------------------------------*/
  8. #ifndef _MACHBLUE_INIT_H_
  9. #define _MACHBLUE_INIT_H_
  10. /*----------------------------------------------------------
  11.  | Include definition below this line
  12.  +----------------------------------------------------------*/
  13. #include "machblue_defines.h"
  14. #ifdef __cplusplus
  15. extern "C" {
  16. #endif /* __cplusplus */
  17. /*----------------------------------------------------------
  18.  | Macro definition below this line
  19.  +----------------------------------------------------------*/
  20. /*----------------------------------------------------------
  21.  | Type definition below this line
  22.  +----------------------------------------------------------*/
  23. /*----------------------------------------------------------
  24.  | Functions definition below this line
  25.  +----------------------------------------------------------*/
  26. /** @defgroup mb_init_group Machblue Init API
  27.  *  @{
  28.  * This is Machblue Init API. This api gives the ability to manufacturers
  29.  * to configure and initialize Machblue depending on their needs.
  30.  */
  31. /**
  32.  * Initializes Machblue Player. mb_player_delete should be called
  33.  * to release allocated resources when the host is no longer needed.
  34.  * @return MB_SUCCESS in case of success, MB_FAILURE otherwise. Cases of 
  35.  * failure include insufficient memory etc.
  36.  */
  37. extern mb_error_t mb_player_init
  38.     mb_init_config_t *config   /**< pointer to a Machblue configuration structure to use
  39.                                     for initialization values. The default configuration may be
  40.                                     queried using mb_default_config_get */
  41. );
  42. /**
  43.  * Deletes Machblue Player. This releases any resource allocated 
  44.  * by the Machblue Player.
  45.  * @return MB_SUCCESS in case of success, MB_FAILURE otherwise. 
  46.  * Failure can occur when the extension has not been initialized. 
  47.  */
  48. extern mb_error_t mb_player_delete( void );
  49. /**
  50.  * Initializes a Machblue configuration structure with
  51.  * system default values. This does not change the system configuration.
  52.  * @return MB_SUCCESS in case of success, MB_FAILURE otherwise. Cases of 
  53.  * failure include NULL pointer.
  54.  */
  55. extern mb_error_t mb_default_config_get
  56. (
  57.     mb_init_config_t *config   /**< pointer to a machblue configuration structure to fill */
  58. );
  59. /**
  60.  * Adds an additional document url scheme handle into Machblue DVB 
  61.  * host supported url scheme list.
  62.  * @return MB_SUCCESS and updates url_handle in case of success, 
  63.  * MB_FAILURE otherwise. Cases of failure includes invalid url handler
  64.  * function table.
  65.  */
  66. extern mb_error_t mb_url_scheme_handler_add
  67. (
  68.     const char          *url_scheme_name,  /**< name of url scheme to add, ex: "http://" or "ftp://" */
  69.     mb_url_handler_f    *url_handler_f,    /**< pointer to a machblue DVB url handler function that 
  70.                                                 will be used to handle document transcations for that url sheme */
  71.     void                *uh_client_data,   /**< client data that will be passed to the url handler every time
  72.                                                 it is invoked. May be NULL */
  73.     mb_handle_t         *url_handle        /**< pointer to location to store handle of url scheme added */
  74. );
  75. /**
  76.  * Removes a document url scheme from Machblue DVB host supported url 
  77.  * scheme list. @return a MB_SUCCESS on success, MB_FAILURE otherwise. 
  78.  * Cases of failure includes invalid url handler.
  79.  */
  80. extern mb_error_t mb_url_scheme_handler_remove
  81. (
  82.     mb_handle_t   url_handler_h    /**< handle of the url handler to remove */
  83. );
  84. /**
  85.  * Adds a new script object to Machblue host.
  86.  * @return MB_SUCCESS and updates script_handle in case of success,  
  87.  * or MB_FAILURE otherwise.
  88.  */
  89. extern mb_error_t mb_script_object_add
  90. (
  91.     mb_script_object_t *script_object,  /**< pointer to the code of the script object to add */
  92.     mb_handle_t        *script_handle   /**< pointer to location to store handle of script object added */
  93. );
  94. /**
  95.  * Removes a script object from Machblue host.
  96.  * @return MB_SUCCESS in case of success, MB_FAILURE otherwise.
  97.  */
  98. extern mb_error_t mb_script_object_remove
  99. (
  100.     mb_handle_t script_object   /** pointer to handle of the script object to remove */
  101. );
  102. /** @} */
  103. #ifdef __cplusplus
  104. }      /* extern "C" */  
  105. #endif /* __cplusplus */
  106. #endif /* _MACHBLUE_HOST_H_ */