hbbtv_js.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2014 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef HBBTV_JS_H

#define HBBTV_JS_H

#include "techtype.h"
#include "hbbtv_types.h"


/*---Constant and macro definitions for public use-----------------------------*/

/*---Enumerations for public use-----------------------------------------------*/

typedef enum
{
   HBBTV_JSKeySet_RED = 0x1,
   HBBTV_JSKeySet_GREEN = 0x2,
   HBBTV_JSKeySet_YELLOW = 0x4,
   HBBTV_JSKeySet_BLUE = 0x8,
   HBBTV_JSKeySet_NAVIGATION = 0x10,
   HBBTV_JSKeySet_VCR = 0x20,
   HBBTV_JSKeySet_SCROLL = 0x40,
   HBBTV_JSKeySet_INFO = 0x80,
   HBBTV_JSKeySet_NUMERIC = 0x100,
   HBBTV_JSKeySet_ALPHA = 0x200,
   HBBTV_JSKeySet_OTHER = 0x400
} HBBTV_JSKeySet_CONST;

typedef enum
{
   HBBTV_JSSearchManager_STATE_COMPLETED = 0,
   HBBTV_JSSearchManager_STATE_ABORTED = 3,
   HBBTV_JSSearchManager_STATE_NO_RESOURCES = 4
} HBBTV_JSSearchManager_State;

typedef enum
{
   HBBTV_JSMetadataSearch_TARGET_SCHEDULED_CONTENT = 1,
   HBBTV_JSMetadataSearch_TARGET_ON_DEMAND_CONTENT = 2
} HBBTV_JSMetadataSearch_Target;

typedef enum
{
   HBBTV_JSMetadataSearch_COMPARISON_EQUAL = 0,
   HBBTV_JSMetadataSearch_COMPARISON_NOT_EQUAL = 1,
   HBBTV_JSMetadataSearch_COMPARISON_GREATER = 2,
   HBBTV_JSMetadataSearch_COMPARISON_GREATER_EQUAL = 3,
   HBBTV_JSMetadataSearch_COMPARISON_LESS = 4,
   HBBTV_JSMetadataSearch_COMPARISON_LESS_EQUAL = 5,
   HBBTV_JSMetadataSearch_COMPARISON_CONTAINS = 6
} HBBTV_JSMetadataSearch_Comparison;

typedef enum
{
   HBBTV_JSAVComponent_TYPE_UNKNOWN = -1,
   HBBTV_JSAVComponent_TYPE_VIDEO = 0,
   HBBTV_JSAVComponent_TYPE_AUDIO = 1,
   HBBTV_JSAVComponent_TYPE_SUBTITLE = 2
} HBBTV_JSAVComponent_Type;

typedef enum
{
   HBBTV_JSVideoBroadcast_NO_ERROR = -1,
   HBBTV_JSVideoBroadcast_NOT_SUPPORTED = 0,
   HBBTV_JSVideoBroadcast_CANNOT_TUNE,
   HBBTV_JSVideoBroadcast_TUNER_NOT_AVAILABLE,
   HBBTV_JSVideoBroadcast_PARENTAL_LOCK,
   HBBTV_JSVideoBroadcast_ENCRYPTED,
   HBBTV_JSVideoBroadcast_UNKNOWN_CHANNEL,
   HBBTV_JSVideoBroadcast_INTERRUPTED,
   HBBTV_JSVideoBroadcast_RECORDING,
   HBBTV_JSVideoBroadcast_UNKNOWN_URI,
   HBBTV_JSVideoBroadcast_NO_BANDWITH,
   HBBTV_JSVideoBroadcast_CH_UP_DOWN_FORBIDDEN,
   HBBTV_JSVideoBroadcast_NO_RESOURCES,
   HBBTV_JSVideoBroadcast_CHANNEL_NOT_PRESENT,
   HBBTV_JSVideoBroadcast_UNIDENTIFIED = 100,
} HBBTV_JSVideoBroadcast_ERROR_STATE;

typedef enum
{
   BROADCAST_STATE_UNREALIZED = 0,
   BROADCAST_STATE_CONNECTING,
   BROADCAST_STATE_PRESENTING,
   BROADCAST_STATE_STOPPED
} E_HBBTV_BROADCAST_STATE;

typedef enum
{
   HBBTV_SE_STATUS_ERROR,
   HBBTV_SE_STATUS_TRIGGER
} E_HBBTV_SE_STATUS;

typedef struct
{
   S_HBBTV_STRING name;
   S_HBBTV_STRING data;
   S_HBBTV_STRING text;
   E_HBBTV_SE_STATUS status;
} S_HBBTV_SE_INFO;

typedef enum
{
   HBBTV_JSVideoBroadcast_UNREALIZED = 0,
   HBBTV_JSVideoBroadcast_NEWLY_SCHEDULED = 1,
   HBBTV_JSVideoBroadcast_REC_STARTING = 2,
   HBBTV_JSVideoBroadcast_REC_RESOURCES = 3,
   HBBTV_JSVideoBroadcast_REC_STARTED = 4,
   HBBTV_JSVideoBroadcast_REC_UPDATED = 5,
   HBBTV_JSVideoBroadcast_REC_COMPLETED = 6,
   HBBTV_JSVideoBroadcast_TS_RESOURCES = 10,
   HBBTV_JSVideoBroadcast_TS_STARTED = 11
} HBBTV_JSVideoBroadcast_RECORDING_STATE;

typedef enum
{
   HBBTV_JSVideoBroadcast_REC_NO_ERROR = -1,
   HBBTV_JSVideoBroadcast_REC_NO_RESOURCES = 0,
   HBBTV_JSVideoBroadcast_REC_NO_SPACE = 1,
   HBBTV_JSVideoBroadcast_REC_CONFLICT = 2,
   HBBTV_JSVideoBroadcast_REC_NOT_PERMITTED = 3,
   HBBTV_JSVideoBroadcast_REC_UNKNOWN = 4,
   HBBTV_JSVideoBroadcast_TS_NO_RESOURCES = 10,
   HBBTV_JSVideoBroadcast_TS_NOT_PERMITTED = 11,
   HBBTV_JSVideoBroadcast_TS_UNKNOWN = 12,
} HBBTV_JSVideoBroadcast_RECORDING_ERROR;

typedef enum
{
   HBBTV_JSChannel_TYPE_TV = 0,
   HBBTV_JSChannel_TYPE_RADIO = 1,
   HBBTV_JSChannel_TYPE_OTHER = 2,
   HBBTV_JSChannel_TYPE_HBBTV_DATA = 256
} HBBTV_JSChannel_TYPE;

typedef enum
{
   HBBTV_Channel_ID_ANALOG = 0,
   HBBTV_Channel_ID_DVB_C = 10,
   HBBTV_Channel_ID_DVB_S = 11,
   HBBTV_Channel_ID_DVB_T = 12,
   HBBTV_Channel_ID_DVB_SI_DIRECT = 13,
   HBBTV_Channel_ID_DVB_C2 = 14,
   HBBTV_Channel_ID_DVB_S2 = 15,
   HBBTV_Channel_ID_DVB_T2 = 16,
   HBBTV_Channel_ID_ISDB_C = 20,
   HBBTV_Channel_ID_ISDB_S = 21,
   HBBTV_Channel_ID_ISDB_T = 22,
   HBBTV_Channel_ID_ATSC_T = 30,
   HBBTV_Channel_ID_IPTV_SDS = 40,
   HBBTV_Channel_ID_IPTV_URI = 41
} HBBTV_JSChannel_ID;

typedef enum
{
   HBBTV_AVControl_NO_ERROR = -1,              /* no error */
   HBBTV_AVControl_FORMAT_NOT_SUPPORTED = 0,   /* 0 - A/V format not supported */
   HBBTV_AVControl_CONNECTION_ERROR,           /* 1 - cannot connect to server or connection lost.*/
   HBBTV_AVControl_UNDEFINED,                  /* 2 - unidentified error */
   HBBTV_AVControl_NO_RESOURCES,               /* 3 – insufficient resources */
   HBBTV_AVControl_CORRUPT,                    /* 4 – content corrupt or invalid */
   HBBTV_AVControl_NOT_AVAILABLE,              /* 5 – content not available */
   HBBTV_AVControl_NOT_AVAILABLE_POSITION,     /* 6 – content not available at given position */
   HBBTV_AVControl_BLOCKED                     /* 7 - content blocked due to parental control */
} HBBTV_JSAVControl_ERROR;

typedef enum
{
   HBBTV_JSProgrammeID_TVA_CRID = 0,
   HBBTV_JSProgrammeID_DVB_EVENT = 1
} HBBTV_JSProgrammeID_TYPE;

typedef enum
{
   HBBTV_JSScheduledRecording_SCHEDULED = 0,
   HBBTV_JSScheduledRecording_STARTED,
   HBBTV_JSScheduledRecording_COMPLETED,
   HBBTV_JSScheduledRecording_PARTIALLY_COMPLETED,
   HBBTV_JSScheduledRecording_ERROR
} HBBTV_JSScheduledRecording_STATE;

typedef enum
{
   HBBTV_JSObjType_String,
   HBBTV_JSObjType_Channel,
   HBBTV_JSObjType_Programme,
   HBBTV_JSObjType_AVComponent,
   HBBTV_JSObjType_ParentalRating,
   HBBTV_JSObjType_ParentalRatingScheme,
   HBBTV_JSObjType_ScheduledRecording,
   HBBTV_JSObjType_NetworkInterface,
   HBBTV_JSObjType_Collection,
   HBBTV_JSObjType_Other
} HBBTV_JSObjType_CONST;


/*---Global type defs for public use-------------------------------------------*/

typedef void (*F_AppMgr_onLowMemory)(void *app_mgr);

typedef void (*F_AppMgr_onApplicationLoadError)(void *app_mgr);

typedef void (*F_SearchManager_onMetadataSearch)(void *search_manager, void *metadata_search, HBBTV_JSSearchManager_State state);

typedef void (*F_Broadcast_onFullScreenChange)(void *video_broadcast);

typedef void (*F_Broadcast_onChannelChangeError)(void *video_broadcast, void *channel,
   HBBTV_JSVideoBroadcast_ERROR_STATE error_state);

typedef void (*F_Broadcast_onChannelChangeSucceeded)(void *video_broadcast, void *channel);

typedef void (*F_Broadcast_onPlayStateChange)(void *video_broadcast, E_HBBTV_BROADCAST_STATE state,
   HBBTV_JSVideoBroadcast_ERROR_STATE error);

typedef void (*F_Broadcast_onProgrammesChanged)(void *video_broadcast);

typedef void (*F_Broadcast_onParentalRatingChange)(void *video_broadcast, void *content_id,
   void *parental_ratings, void *drm_system_id, BOOLEAN blocked);

typedef void (*F_Broadcast_onParentalRatingError)(void *video_broadcast, void *content_id,
   void *parental_ratings, void *drm_system_id);

typedef void (*F_Broadcast_onStreamEvent)(void *video_broadcast, U32BIT listener_id, S_HBBTV_SE_INFO *event);

typedef void (*F_Broadcast_onSelectedComponentChanged)(void *video_broadcast, HBBTV_JSAVComponent_Type type);

typedef void (*F_Broadcast_onRecordingEvent)(void *video_broadcast, HBBTV_JSVideoBroadcast_RECORDING_STATE state,
   HBBTV_JSVideoBroadcast_RECORDING_ERROR error, void *id);

typedef void (*F_Broadcast_onPlaySpeedChanged)(void *video_broadcast, float speed);

typedef void (*F_Broadcast_onPlayPositionChanged)(void *video_broadcast, U32BIT position);

typedef void (*F_Broadcast_onDRMRightsError)(void *video_broadcast, U8BIT error_state, 
   void *content_id, void *drm_system_id, void *rights_issuer_url);

typedef void (*F_AVControl_onPlayStateChange)(void *avControl);

typedef void (*F_AVControl_onFullScreenChange)(void *avControl);

typedef void (*F_AVControl_onPlayPositionChanged)(void *avControl, U32BIT position);

typedef void (*F_AVControl_onSelectedComponentChanged)(void *avControl, HBBTV_JSAVComponent_Type type);

typedef void (*F_AVControl_onDRMRightsError)(void *av_control, U8BIT error_state, 
   void *content_id, void *drm_system_id, void *rights_issuer_url);

typedef void (*F_LocalSystem_onPvrStatusChange)(void *local_system, U8BIT result);

typedef void (*F_NetworkInterface_onNetworkStatusChange)(void *network_interface, U8BIT result);

typedef void (*F_DRMAgent_onDRMMessageResult)(void *drm_agent, void *message_id, 
   void *message_result, U8BIT result_code);

typedef void (*F_DRMAgent_onDRMSystemMessage)(void *drm_agent, void *message, void *drm_system_id);

typedef struct
{
   F_AppMgr_onLowMemory AppMgr_onLowMemory;
   F_AppMgr_onApplicationLoadError AppMgr_onApplicationLoadError;
   F_SearchManager_onMetadataSearch SearchManager_onMetadataSearch;
   F_AVControl_onPlayStateChange AVControl_onPlayStateChange;
   F_AVControl_onFullScreenChange AVControl_onFullScreenChange;
   F_AVControl_onPlayPositionChanged AVControl_onPlayPositionChanged;
   F_AVControl_onSelectedComponentChanged AVControl_onSelectedComponentChanged;
   F_AVControl_onDRMRightsError AVControl_onDRMRightsError;
   F_Broadcast_onFullScreenChange Broadcast_onFullScreenChange;
   F_Broadcast_onChannelChangeError Broadcast_onChannelChangeError;
   F_Broadcast_onChannelChangeSucceeded Broadcast_onChannelChangeSucceeded;
   F_Broadcast_onPlayStateChange Broadcast_onPlayStateChange;
   F_Broadcast_onProgrammesChanged Broadcast_onProgrammesChanged;
   F_Broadcast_onParentalRatingChange Broadcast_onParentalRatingChange;
   F_Broadcast_onParentalRatingError Broadcast_onParentalRatingError;
   F_Broadcast_onSelectedComponentChanged Broadcast_onSelectedComponentChanged;
   F_Broadcast_onStreamEvent Broadcast_onStreamEvent;
   F_Broadcast_onRecordingEvent Broadcast_onRecordingEvent;
   F_Broadcast_onPlaySpeedChanged Broadcast_onPlaySpeedChanged;
   F_Broadcast_onPlayPositionChanged Broadcast_onPlayPositionChanged;
   F_Broadcast_onDRMRightsError Broadcast_onDRMRightsError;
   F_LocalSystem_onPvrStatusChange LocalSystem_onPvrStatusChange;
   F_NetworkInterface_onNetworkStatusChange NetworkInterface_onNetworkStatusChange;
   F_DRMAgent_onDRMMessageResult DRMAgent_onDRMMessageResult;
   F_DRMAgent_onDRMSystemMessage DRMAgent_onDRMSystemMessage;
} S_PLUGIN_FUNCS;


/*---Global Function prototypes for public use---------------------------------*/

/***************************************************************************/
/* class:       oipfObjectFactory                                          */
/* reference:   Section 7.1                                                */
/***************************************************************************/

BOOLEAN HBBTV_JSOipfObjFactory_isObjSupported(S_HBBTV_STRING *mime_type);

void* HBBTV_JSOipfObjFactory_createVideoBroadcastObject(void);

void* HBBTV_JSOipfObjFactory_createVideoMpegObject(void);

void* HBBTV_JSOipfObjFactory_createAppMgrObject(void);

void* HBBTV_JSOipfObjFactory_createConfigObject(void);

void* HBBTV_JSOipfObjFactory_createParentalControlMgrObject(void);

void* HBBTV_JSOipfObjFactory_createCapabilitiesObject(void);

void* HBBTV_JSOipfObjFactory_createSearchManagerObject(void);

void* HBBTV_JSOipfObjFactory_createRecordingSchedulerObject(void);

void *HBBTV_JSOipfObjFactory_createDRMAgentObject(void);


/***************************************************************************/
/* class:       application/oipfApplicationManager                         */
/* reference:   Section 7.2.1                                              */
/***************************************************************************/

void* HBBTV_JSOipfAppMgr_getOwnerApp(void *app_mgr, S_HBBTV_STRING *url);

void HBBTV_AppMgr_loadXmlAit(void *app_mgr, U8BIT *data, U32BIT size, S_HBBTV_STRING *url);


/***************************************************************************/
/* class:       Application                                                */
/* reference:   Section 7.2.2                                              */
/***************************************************************************/

void* HBBTV_JSApp_getPrivateData(void *app);

void* HBBTV_JSApp_createApp(void *app, S_HBBTV_STRING *uri, BOOLEAN create_child);

void HBBTV_JSApp_destroyApp(void *app);

void HBBTV_JSApp_show(void *app);

void HBBTV_JSApp_hide(void *app);


/***************************************************************************/
/* class:       ApplicationPrivateData                                     */
/* reference:   Section 7.2.4                                              */
/***************************************************************************/

void* HBBTV_JSAppPrivateData_getKeyset(void *app_private_data);

S32BIT HBBTV_JSAppPrivateData_getFreeMem(void *app_private_data);

void* HBBTV_JSAppPrivateData_getCurrentChannel(void *app_private_data);


/***************************************************************************/
/* class:       KeySet                                                     */
/* reference:   Section 7.2.5                                              */
/***************************************************************************/

S32BIT HBBTV_JSKeySet_getValue(void *key_set);

S32BIT HBBTV_JSKeySet_getMaximumValue(void *key_set);

S32BIT HBBTV_JSKeySet_setValue(void *key_set, S32BIT value);

U32BIT HBBTV_JSKeySet_getOtherKeys(void *obj, U32BIT **other_keys);


/***************************************************************************/
/* class:       application/oipfConfiguration                              */
/* reference:   Section 7.3.1                                              */
/***************************************************************************/

void* HBBTV_JSOipfConfig_getConfig(void *config);

void* HBBTV_JSOipfConfig_getLocalSystem(void *obj);


/***************************************************************************/
/* class:       Configuration                                              */
/* reference:   Section 7.3.2                                              */
/***************************************************************************/

void* HBBTV_JSConfig_getPreferredAudioLang(void *config);

void* HBBTV_JSConfig_getPreferredSubtitleLang(void *config);

void* HBBTV_JSConfig_getPreferredUILang(void *config);

void* HBBTV_JSConfig_getCountryId(void *config);

void *HBBTV_JSConfig_getPostcode(void *obj);

S8BIT HBBTV_JSConfig_getSpeechDescriptionEnabled(void *obj);

S8BIT HBBTV_JSConfig_getVoiceControlEnabled(void *obj);

U8BIT HBBTV_JSConfig_getTerminalMode(void *obj);


/***************************************************************************/
/* class:       application/oipfParentalControlManager                     */
/* reference:   Section 7.9.1                                              */
/***************************************************************************/

void* HBBTV_JSOipfParentalControlMgr_getParentalRatingSchemes(void *parental_control_mgr);


/***************************************************************************/
/* class:       application/oipfSearchManager                              */
/* reference:   Section 7.12.1                                             */
/***************************************************************************/

void* HBBTV_JSOipfSearchManager_createSearch(void *search_manager, HBBTV_JSMetadataSearch_Target search_target);

void* HBBTV_JSOipfSearchManager_getChannelConfig(void *search_manager);


/***************************************************************************/
/* class:       MetadataSearch class                                       */
/* reference:   Section 7.12.2                                             */
/***************************************************************************/

HBBTV_JSMetadataSearch_Target HBBTV_JSMetadataSearch_getSearchTarget(void *metadata_search);

void* HBBTV_JSMetadataSearch_getResult(void *metadata_search);

void HBBTV_JSMetadataSearch_setQuery(void *metadata_search, void *query);

void HBBTV_JSMetadataSearch_addChannelConstraint(void *metadata_search, void *channel);

void* HBBTV_JSMetadataSearch_createQuery(void *metadata_search, S_HBBTV_STRING *field,
   HBBTV_JSMetadataSearch_Comparison comparison, S_HBBTV_STRING *value);

void HBBTV_JSMetadataSearch_findProgrammesFromStream(void *metadata_search, void *channel, U32BIT start_time);


/***************************************************************************/
/* class:       Query class                                                */
/* reference:   Section 7.12.3                                             */
/***************************************************************************/

void* HBBTV_JSQuery_and(void *query, void *operand_query);

void* HBBTV_JSQuery_or(void *query, void *operand_query);

void* HBBTV_JSQuery_not(void *query);


/***************************************************************************/
/* class:       SearchResults class                                        */
/* reference:   Section 7.12.4                                             */
/***************************************************************************/

U32BIT HBBTV_JSSearchResults_getOffset(void *search_result);

U32BIT HBBTV_JSSearchResults_getTotalSize(void *search_result);

BOOLEAN HBBTV_JSSearchResults_getResults(void *search_result, U32BIT offset, U32BIT count);

void HBBTV_JSSearchResults_abort(void *search_result);


/***************************************************************************/
/* class:       AVComponent                                                */
/* reference:   Section 7.16.5.2                                           */
/***************************************************************************/

U32BIT HBBTV_JSAVComponent_getType(void *av_component);

void* HBBTV_JSAVComponent_getEncoding(void *av_component);

BOOLEAN HBBTV_JSAVComponent_getEncrypted(void *av_component);

float HBBTV_JSAVComponent_getAspectRatio(void *av_component);

void* HBBTV_JSAVComponent_getLanguage(void *av_component);

BOOLEAN HBBTV_JSAVComponent_getAudioDescription(void *av_component);

U32BIT HBBTV_JSAVComponent_getAudioChannels(void *av_component);

BOOLEAN HBBTV_JSAVComponent_getHearingImpaired(void *av_component);

S8BIT HBBTV_JSAVComponent_getComponentTag(void *obj);

U16BIT HBBTV_JSAVComponent_getPid(void *obj);


/***************************************************************************/
/* class:       video/broadcast                                            */
/* reference:   Section 7.13.1                                             */
/***************************************************************************/

void HBBTV_JSVideoBroadcast_setPosition(void *video_broadcast, S32BIT x, S32BIT y);

S32BIT HBBTV_JSVideoBroadcast_getWidth(void *video_broadcast);

void HBBTV_JSVideoBroadcast_setWidth(void *video_broadcast, S32BIT width);

S32BIT HBBTV_JSVideoBroadcast_getHeight(void *video_broadcast);

void HBBTV_JSVideoBroadcast_setHeight(void *video_broadcast, S32BIT height);

void HBBTV_JSVideoBroadcast_setVideoWindow(void *obj, S32BIT x, S32BIT y, S32BIT width, S32BIT height);

BOOLEAN HBBTV_JSVideoBroadcast_getFullScreen(void *video_broadcast);

E_HBBTV_BROADCAST_STATE HBBTV_JSVideoBroadcast_getPlayState(void *video_broadcast);

void* HBBTV_JSVideoBroadcast_getData(void *video_broadcast);

void HBBTV_JSVideoBroadcast_setData(void *video_broadcast, S_HBBTV_STRING *data);

void* HBBTV_JSVideoBroadcast_getChannelConfig(void *video_broadcast);

void HBBTV_JSVideoBroadcast_bindToCurrentChannel(void *video_broadcast);

void* HBBTV_JSVideoBroadcast_createChannelObject(void *video_broadcast,
   S32BIT id_type, S_HBBTV_STRING *dsd,
   S32BIT sid);

void* HBBTV_JSVideoBroadcast_createChannelObject2(void *video_broadcast,
   S32BIT id_type, S32BIT onid,
   S32BIT tsid, S32BIT sid,
   S32BIT source_id,
   S_HBBTV_STRING *ip_broadcast_id);

void HBBTV_JSVideoBroadcast_setChannel(void *video_broadcast, void *channel,
   BOOLEAN trickplay,
   S_HBBTV_STRING *content_access_desc_url);

void HBBTV_JSVideoBroadcast_prevChannel(void *video_broadcast);

void HBBTV_JSVideoBroadcast_nextChannel(void *video_broadcast);

void HBBTV_JSVideoBroadcast_setFullScreen(void *video_broadcast,
   BOOLEAN fullscreen);

void HBBTV_JSVideoBroadcast_release(void *video_broadcast);

void HBBTV_JSVideoBroadcast_stop(void *video_broadcast);

void* HBBTV_JSVideoBroadcast_getCurrentChannel(void *video_broadcast);

void* HBBTV_JSVideoBroadcast_getProgrammes(void *video_broadcast);

void* HBBTV_JSVideoBroadcast_getComponents(void *video_broadcast, HBBTV_JSAVComponent_Type type);

void* HBBTV_JSVideoBroadcast_getCurrentActiveComponents(void *video_broadcast, HBBTV_JSAVComponent_Type type);

void HBBTV_JSVideoBroadcast_selectComponent(void *video_broadcast, void *component);

void HBBTV_JSVideoBroadcast_selectComponentType(void *obj, HBBTV_JSAVComponent_Type comp_type);

void HBBTV_JSVideoBroadcast_unselectComponent(void *video_broadcast, void *component);

void HBBTV_JSVideoBroadcast_unselectComponentType(void *obj, HBBTV_JSAVComponent_Type comp_type);

BOOLEAN HBBTV_JSVideoBroadcast_addStreamEventListener(void *video_broadcast, S_HBBTV_STRING dvb_url,
   S_HBBTV_STRING name, U32BIT listener_id);

BOOLEAN HBBTV_JSVideoBroadcast_loadStreamEventListener(void *video_broadcast, S_HBBTV_STRING xml_data,
   S_HBBTV_STRING name, U32BIT listener_id);

BOOLEAN HBBTV_JSVideoBroadcast_removeStreamEventListener(void *video_broadcast, S_HBBTV_STRING name, U32BIT listener_id);

void* HBBTV_JSVideoBroadcast_recordNow(void *obj, S32BIT duration);

void HBBTV_JSVideoBroadcast_stopRecording(void *obj);

HBBTV_JSVideoBroadcast_RECORDING_STATE HBBTV_JSVideoBroadcast_getRecordingState(void *video_broadcast);

float HBBTV_JSVideoBroadcast_getPlaySpeed(void *video_broadcast);

U32BIT HBBTV_JSVideoBroadcast_getPlayPosition(void *video_broadcast);


/***************************************************************************/
/* class:       ChannelConfig                                              */
/* reference:   Section 7.13.9                                             */
/***************************************************************************/

void* HBBTV_JSChannelConfig_getChannelList(void *obj);

void* HBBTV_JSChannelConfig_getGenres(void *obj);


/***************************************************************************/
/* class:       ChannelList                                                */
/* reference:   Section 7.13.10                                            */
/***************************************************************************/

void* HBBTV_JSChannelList_getChannel(void *obj, S_HBBTV_STRING *channel_id);

void* HBBTV_JSChannelList_getChannelByTriplet(void *obj, S32BIT onid, S32BIT tsid, S32BIT sid);


/***************************************************************************/
/* class:       Channel                                                    */
/* reference:   Section 7.13.11                                            */
/***************************************************************************/

S32BIT HBBTV_JSChannel_getChannelType(void *channel);

void* HBBTV_JSChannel_getCcid(void *channel);

void* HBBTV_JSChannel_getDsd(void *channel);

S32BIT HBBTV_JSChannel_getOnid(void *channel);

S32BIT HBBTV_JSChannel_getTsid(void *channel);

S32BIT HBBTV_JSChannel_getSid(void *channel);

void* HBBTV_JSChannel_getName(void *channel);

S32BIT HBBTV_JSChannel_getNid(void *obj);

S32BIT HBBTV_JSChannel_getMajorChannel(void *obj);

BOOLEAN HBBTV_JSChannel_getLocked(void *obj);

void* HBBTV_JSChannel_getShortName(void *obj);

BOOLEAN HBBTV_JSChannel_getRunningStatus(void *obj);

BOOLEAN HBBTV_JSChannel_getHidden(void *obj);

U16BIT HBBTV_JSChannel_getOpalChannelType(void *obj);

U16BIT HBBTV_JSChannel_getFreesatServiceID(void *obj);

void* HBBTV_JSChannel_getGenre(void *obj);


/***************************************************************************/
/* class:       A/V Control                                                */
/* reference:   CEA-2014-A Section 5.7.1                                   */
/***************************************************************************/

void* HBBTV_JSAVControl_createVideoMpeg(void);

void* HBBTV_JSAVControl_createVideoMp4(void);

void* HBBTV_JSAVControl_createAudioMpeg(void);

void* HBBTV_JSAVControl_createAudioMp4(void);

void* HBBTV_JSAVControl_getData(void *avControl);

void HBBTV_JSAVControl_setData(void *avControl, S_HBBTV_STRING *data);

U32BIT HBBTV_JSAVControl_getPlayPosition(void *avControl);

U32BIT HBBTV_JSAVControl_getPlayTime(void *avControl);

S32BIT HBBTV_JSAVControl_getPlayState(void *avControl);

S32BIT HBBTV_JSAVControl_getError(void *avControl);

S32BIT HBBTV_JSAVControl_getNrTracks(void *avControl);

S32BIT HBBTV_JSAVControl_getSpeed(void *avControl);

S32BIT HBBTV_JSAVControl_getCurrentTrackIndex(void *avControl);

void HBBTV_JSAVControl_setCurrentTrackIndex(void *avControl, S32BIT trackIndex);

BOOLEAN HBBTV_JSAVControl_getPersist(void *avControl);

void HBBTV_JSAVControl_setPersist(void *avControl, BOOLEAN persist);

BOOLEAN HBBTV_JSAVControl_play(void *avControl, S32BIT speed);

BOOLEAN HBBTV_JSAVControl_stop(void *avControl);

BOOLEAN HBBTV_JSAVControl_seek(void *avControl, U32BIT pos);

BOOLEAN HBBTV_JSAVControl_setVolume(void *avControl, S32BIT volume);

BOOLEAN HBBTV_JSAVControl_next(void *avControl);

BOOLEAN HBBTV_JSAVControl_previous(void *avControl);

S32BIT HBBTV_JSAVControl_getWidth(void *avControl);

void HBBTV_JSAVControl_setWidth(void *avControl, S32BIT width);

S32BIT HBBTV_JSAVControl_getHeight(void *avControl);

void HBBTV_JSAVControl_setHeight(void *avControl, S32BIT height);

BOOLEAN HBBTV_JSAVControl_getFullScreen(void *avControl);

void HBBTV_JSAVControl_setFullScreen(void *avControl, BOOLEAN fullscreen);

void HBBTV_JSAVControl_setPosition(void *avControl, S32BIT x, S32BIT y);

void* HBBTV_JSAVControl_getComponents(void *avControl, HBBTV_JSAVComponent_Type component_type);

void* HBBTV_JSAVControl_getCurrentActiveComponents(void *avControl, HBBTV_JSAVComponent_Type component_type);

void HBBTV_JSAVControl_selectComponent(void *avControl, void *component);

void HBBTV_JSAVControl_selectComponentType(void *avControl, HBBTV_JSAVComponent_Type component_type);

void HBBTV_JSAVControl_unselectComponent(void *avControl, void *component);

void HBBTV_JSAVControl_unselectComponentType(void *obj, HBBTV_JSAVComponent_Type comp_type);

void HBBTV_JSAVControl_setCache(void *avControl, BOOLEAN cache);

void HBBTV_JSAVControl_setLoop(void *avControl, S32BIT loopParam);

BOOLEAN HBBTV_JSAVControl_queue(void *avControl, S_HBBTV_STRING *url);

BOOLEAN HBBTV_JSAVControl_setSource(void *avControl, S_HBBTV_STRING *id);


/***************************************************************************/
/* class:       ParentalRatingScheme                                       */
/* reference:   Section 7.9.2                                              */
/***************************************************************************/

void* HBBTV_JSParentalRatingScheme_getName(void *parental_rating_scheme);

U32BIT HBBTV_JSParentalRatingScheme_getLength(void *parental_rating_scheme);

void* HBBTV_JSParentalRatingScheme_getThreshold(void *parental_rating_scheme);

S32BIT HBBTV_JSParentalRatingScheme_indexOf(void *parental_rating_scheme, S_HBBTV_STRING *ratingValue);

void* HBBTV_JSParentalRatingScheme_item(void *parental_rating_scheme, U32BIT index);

void* HBBTV_JSParentalRatingScheme_iconUri(void *parental_rating_scheme, U32BIT index);


/***************************************************************************/
/* class:       ParentalRatingSchemeCollection                             */
/* reference:   Section 7.9.3                                              */
/***************************************************************************/

void* HBBTV_JSCollection_addParentalRatingScheme(void *collection, S_HBBTV_STRING *name,
   S_HBBTV_STRING *values);

void* HBBTV_JSCollection_getParentalRatingScheme(void *collection, S_HBBTV_STRING *name);


/***************************************************************************/
/* class:       ParentalRating                                             */
/* reference:   Section 7.9.4                                              */
/***************************************************************************/

void* HBBTV_JSParentalRating_getName(void *parental_rating);

void* HBBTV_JSParentalRating_getScheme(void *parental_rating);

U32BIT HBBTV_JSParentalRating_getValue(void *parental_rating);

U32BIT HBBTV_JSParentalRating_getLabels(void *parental_rating);

void* HBBTV_JSParentalRating_getRegion(void *parental_rating);


/***************************************************************************/
/* class:       ParentalRatingCollection                                   */
/* reference:   Section 7.9.5                                              */
/***************************************************************************/

void HBBTV_JSCollection_addParentalRating(void *collection,
   S_HBBTV_STRING *scheme, S_HBBTV_STRING *name, U32BIT value, U32BIT labels, S_HBBTV_STRING *region);


/***************************************************************************/
/* class        application/oipfCapabilities                               */
/* reference:   Section 7.15.3                                             */
/***************************************************************************/

void* HBBTV_JSOipfCapabilities_getXmlCapabilities(void *obj);

U8BIT HBBTV_JSOipfCapabilities_getExtraSDVideoDecodes(void *obj);

U8BIT HBBTV_JSOipfCapabilities_getExtraHDVideoDecodes(void *obj);

BOOLEAN HBBTV_JSOipfCapabilities_hasCapability(void *obj, S_HBBTV_STRING *profileName);

void* HBBTV_Capabilities_getOptionsString(void);


/***************************************************************************/
/* class:       Programme                                                  */
/* reference:   Section 7.16.2                                             */
/***************************************************************************/

void* HBBTV_JSProgramme_getName(void *programme);

void* HBBTV_JSProgramme_getProgrammeID(void *programme);

U32BIT HBBTV_JSProgramme_getProgrammeIDType(void *programme);

void* HBBTV_JSProgramme_getDescription(void *programme);

void* HBBTV_JSProgramme_getLongDescription(void *programme);

U32BIT HBBTV_JSProgramme_getStartTime(void *programme);

U32BIT HBBTV_JSProgramme_getDuration(void *programme);

void* HBBTV_JSProgramme_getChannelID(void *programme);

void* HBBTV_JSProgramme_getParentalRatings(void *programme);

void* HBBTV_JSProgramme_getSIDescriptors(void *programme, S32BIT desc_tag_id, S32BIT ext_desc_tag_id);

U32BIT HBBTV_JSProgramme_getAudioType(void *obj);

BOOLEAN HBBTV_JSProgramme_getIsMultilingual(void *obj);

void* HBBTV_JSProgramme_getAudioLanguages(void *obj);

BOOLEAN HBBTV_JSProgramme_getIsHd(void *obj);

BOOLEAN HBBTV_JSProgramme_getHasAudioDescription(void *obj);

BOOLEAN HBBTV_JSProgramme_getHasSignLanguage(void *obj);

void* HBBTV_JSProgramme_getGenre(void *obj);

BOOLEAN HBBTV_JSProgramme_getHasGuidance(void *obj);

void* HBBTV_JSProgramme_getGuidance(void *obj);

void* HBBTV_JSProgramme_getMediaAssets(void *obj);

void* HBBTV_JSProgramme_getPromotionalContentText(void *obj);

BOOLEAN HBBTV_JSProgramme_getHasHDSimulcast(void *obj);

void* HBBTV_JSProgramme_getCRIDS(void *obj);

BOOLEAN HBBTV_JSProgramme_getHasRecording(void *obj);

void* HBBTV_JSProgramme_getRecording(void *obj);


/***************************************************************************/
/* class:       ScheduledRecording                                         */
/* reference:   Section 7.10.2                                             */
/***************************************************************************/

S32BIT HBBTV_JSScheduledRecording_getStartPadding(void *obj);

void HBBTV_JSScheduledRecording_setStartPadding(void *obj, S32BIT start_padding);

S32BIT HBBTV_JSScheduledRecording_getEndPadding(void *obj);

void HBBTV_JSScheduledRecording_setEndPadding(void *obj, S32BIT end_padding);

void* HBBTV_JSScheduledRecording_getName(void *obj);

void HBBTV_JSScheduledRecording_setName(void *obj, S_HBBTV_STRING *name);

void* HBBTV_JSScheduledRecording_getParentalRatings(void *obj);

void* HBBTV_JSScheduledRecording_getDescription(void *obj);

void HBBTV_JSScheduledRecording_setDescription(void *obj, S_HBBTV_STRING *description);

U32BIT HBBTV_JSScheduledRecording_getStartTime(void *obj);

U32BIT HBBTV_JSScheduledRecording_getDuration(void *obj);

HBBTV_JSScheduledRecording_STATE HBBTV_JSScheduledRecording_getState(void *obj);

void* HBBTV_JSScheduledRecording_getParentalRatings(void *obj);

void* HBBTV_JSScheduledRecording_getChannel(void *obj);

/***************************************************************************/
/* class:       Recording                                                  */
/* reference:   Section 7.10.5                                             */
/***************************************************************************/

void* HBBTV_JSScheduledRecording_getId(void *obj);

U32BIT HBBTV_JSScheduledRecording_getRecordingStartTime(void *obj);

U32BIT HBBTV_JSScheduledRecording_getRecordingDuration(void *obj);


/***************************************************************************/
/* class:       application/OipfRecordingScheduler                         */
/* reference:   Section 7.10.1                                             */
/***************************************************************************/

void* HBBTV_JSOipfRecordingScheduler_getChannelConfig(void *obj);

void* HBBTV_JSOipfRecordingScheduler_record(void *obj, void *programme);

void* HBBTV_JSOipfRecordingScheduler_createProgrammeObject(void *obj);

void* HBBTV_JSOipfRecordingScheduler_recordAt(void *obj, U32BIT start_time, U32BIT duration,
   U8BIT repeat_days, S_HBBTV_STRING *channel_id);

void* HBBTV_JSOipfRecordingScheduler_getScheduledRecordings(void *obj);

void HBBTV_JSOipfRecordingScheduler_remove(void *obj, void *scheduled_recording);

void* HBBTV_JSOipfRecordingScheduler_getRecordings(void *obj);

/***************************************************************************/
/* Collection Functions                                                    */
/***************************************************************************/

U32BIT HBBTV_JSCollection_getLength(void *collection);

void* HBBTV_JSCollection_getItem(void *collection, U32BIT index);

/***************************************************************************/
/* String Functions                                                        */
/***************************************************************************/

S_HBBTV_STRING HBBTV_JSString_getValue(void *string);

U16BIT* HBBTV_JSString_getString16(void *string);

U8BIT* HBBTV_JSString_getString8(void *string);

void HBBTV_JSString_releaseString(U8BIT *utf_string);

U32BIT HBBTV_JSString_utf8ByteLen(void *obj);

void HBBTV_JSString_utf8CopyData(void *obj, U8BIT *output);

U32BIT HBBTV_JSString_strlen(void *obj);

/***************************************************************************/
/* Utility Functions                                                       */
/***************************************************************************/

HBBTV_JSObjType_CONST HBBTV_JSObject_type(void *obj);

void* HBBTV_JSObject_incref(void *obj);

void HBBTV_JSObject_release(void *obj);

void HBBTV_JSObjectPrint(void);

void HBBTV_JSObject_addObjectReference(void *obj, void *reference);

void HBBTV_JSObject_removeObjectReference(void *obj, void *reference);

void HBBTV_JSObject_getObjectReferences(void *obj, void ***references, U32BIT *number);

void HBBTV_JSObject_releaseObjectReferences(void *obj, void **references);


/***************************************************************************/
/* LocalSystem class                                                       */
/***************************************************************************/

void *HBBTV_JSLocalSystem_getDeviceID(void *obj);

void *HBBTV_JSLocalSystem_getVendorName(void *obj);

void *HBBTV_JSLocalSystem_getFamilyName(void *obj);

void *HBBTV_JSLocalSystem_getModelName(void *obj);

void *HBBTV_JSLocalSystem_getSoftwareVersion(void *obj);

void *HBBTV_JSLocalSystem_getHardwareVersion(void *obj);

BOOLEAN HBBTV_JSLocalSystem_getPvrEnabled(void *obj);

void *HBBTV_JSLocalSystem_getNetworkInterfaces(void *obj);

void *HBBTV_JSLocalSystem_getOipfProfile(void *obj);

BOOLEAN HBBTV_JSLocalSystem_getPvrStatus(void *obj);


/***************************************************************************/
/* NetworkInterface class                                                  */
/***************************************************************************/

void *HBBTV_JSNetworkInterface_getIpAddress(void *obj);

void *HBBTV_JSNetworkInterface_getMacAddress(void *obj);

BOOLEAN HBBTV_JSNetworkInterface_getEnabled(void *obj);

BOOLEAN HBBTV_JSNetworkInterface_getConnected(void *obj);


/***************************************************************************/
/* class:       application/oipfDRMAgent                                   */
/* reference:   Section 7.6.1                                              */
/***************************************************************************/

void *HBBTV_JSOipfDRMAgent_sendDRMMessage(void *obj, S_HBBTV_STRING *type, S_HBBTV_STRING *message,
   S_HBBTV_STRING *drm_system_id);


/***************************************************************************/
/* Exporting Plugin Callback Functions                                     */
/***************************************************************************/

void HBBTV_JSExportPluginCallbacks(const S_PLUGIN_FUNCS *p_funcs);

#endif /* HBBTV_JS_H */