Definition of functions implementing the HbbTV Javascript extension. More...

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

Data Structures
struct	S_HBBTV_SE_INFO

struct	S_PLUGIN_FUNCS

Typedefs
typedef void(*	F_AppMgr_onLowMemory )(void *app_mgr)
	onLowMemory, Section 7.2.1.3

typedef void(*	F_AppMgr_onApplicationLoadError )(void *app_mgr)
	onApplicationLoadError, Section 7.2.1.3

typedef void(*	F_SearchManager_onMetadataSearch )(void search_manager, void metadata_search, HBBTV_JSSearchManager_State state)
	onMetadataSearch, Section 7.12.1.1

typedef void(*	F_Broadcast_onFullScreenChange )(void *video_broadcast)
	onFullScreenChange, Section 7.13.1.4

typedef void(*	F_Broadcast_onChannelChangeError )(void video_broadcast, void channel, HBBTV_JSVideoBroadcast_ERROR_STATE error_state)
	onChannelChangeError, Section 7.13.1.4

typedef void(*	F_Broadcast_onChannelChangeSucceeded )(void video_broadcast, void channel)
	onChannelChangeSucceeded, Section 7.13.1.4

typedef void(*	F_Broadcast_onPlayStateChange )(void *video_broadcast, E_HBBTV_BROADCAST_STATE state, HBBTV_JSVideoBroadcast_ERROR_STATE error)
	onPlayStateChange, Section 7.13.1.4

typedef void(*	F_Broadcast_onProgrammesChanged )(void *video_broadcast)
	onProgrammesChanged, Section 7.13.3

typedef void(*	F_Broadcast_onParentalRatingChange )(void video_broadcast, void content_id, void parental_ratings, void drm_system_id, BOOLEAN blocked)
	onParentalRatingChange, Section 7.13.5

typedef void(*	F_Broadcast_onParentalRatingError )(void video_broadcast, void content_id, void parental_ratings, void drm_system_id)
	onParentalRatingError, Section 7.13.5

typedef void(*	F_Broadcast_onStreamEvent )(void video_broadcast, U32BIT listener_id, S_HBBTV_SE_INFO event)
	onStreamEvent, TS102796 Section 8.2.1.2

typedef void(*	F_Broadcast_onSelectedComponentChanged )(void *video_broadcast, HBBTV_JSAVComponent_Type type)
	void onSelectedComponentChanged, Section 7.16.5.1.2

typedef void(*	F_Broadcast_onRecordingEvent )(void video_broadcast, HBBTV_JSVideoBroadcast_RECORDING_STATE state, HBBTV_JSVideoBroadcast_RECORDING_ERROR error, void id)
	function onRecordingEvent( Integer state, Integer error, String recordingId ), Section 7.13.2.2

typedef void(*	F_Broadcast_onPlaySpeedChanged )(void *video_broadcast, float speed)
	function onPlaySpeedChanged( Number speed ), Section 7.13.2.2

typedef void(*	F_Broadcast_onPlayPositionChanged )(void *video_broadcast, U32BIT position)
	function onPlayPositionChanged( Integer position ), Section 7.13.2.2

typedef void(*	F_Broadcast_onDRMRightsError )(void video_broadcast, U8BIT error_state, void content_id, void drm_system_id, void rights_issuer_url)
	onDRMRightsError, OIPF Vol.5, section 7.13.6

typedef void(*	F_AVControl_onPlayStateChange )(void *avControl)
	onPlayStateChange, CEA-2014-A Section 5.7.1.f

typedef void(*	F_AVControl_onFullScreenChange )(void *avControl)
	onFullScreenChange, CEA-2014-A Section 5.7.1.g

typedef void(*	F_AVControl_onPlayPositionChanged )(void *avControl, U32BIT position)
	onPlayPositionChanged, Section 7.14.3.1

typedef void(*	F_AVControl_onSelectedComponentChanged )(void *avControl, HBBTV_JSAVComponent_Type type)
	onSelectedComponentChanged, Section 7.16.5.1.2

typedef void(*	F_AVControl_onDRMRightsError )(void av_control, U8BIT error_state, void content_id, void drm_system_id, void rights_issuer_url)
	onDRMRightsError, OIPF Vol.5, section 7.14.7

typedef void(*	F_LocalSystem_onPvrStatusChange )(void *local_system, U8BIT result)
	onPvrStatusChange, Freesat OPAL v1.0, section 8.5.1.4

typedef void(*	F_NetworkInterface_onNetworkStatusChange )(void *network_interface, U8BIT result)
	onNetworkStatusChange, Freesat OPAL v1.0, section 8.6.1.1

typedef void(*	F_DRMAgent_onDRMMessageResult )(void drm_agent, void message_id, void *message_result, U8BIT result_code)
	onDRMMessageResult, Section 7.6.1.1

typedef void(*	F_DRMAgent_onDRMSystemMessage )(void drm_agent, void message, void *drm_system_id)
	onDRMSystemMessage, Section 7.6.1.1

Enumerations
enum	HBBTV_JSKeySet_CONST { 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 }

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

enum	HBBTV_JSMetadataSearch_Target { HBBTV_JSMetadataSearch_TARGET_SCHEDULED_CONTENT = 1, HBBTV_JSMetadataSearch_TARGET_ON_DEMAND_CONTENT = 2 }

enum	HBBTV_JSMetadataSearch_Comparison { 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 }

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

enum	HBBTV_JSVideoBroadcast_ERROR_STATE { 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 }

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

enum	E_HBBTV_SE_STATUS { HBBTV_SE_STATUS_ERROR, HBBTV_SE_STATUS_TRIGGER }

enum	HBBTV_JSVideoBroadcast_RECORDING_STATE { 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 }

enum	HBBTV_JSVideoBroadcast_RECORDING_ERROR { 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 }

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

enum	HBBTV_JSChannel_ID { 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 }

enum	HBBTV_JSAVControl_ERROR { HBBTV_AVControl_NO_ERROR = -1, HBBTV_AVControl_FORMAT_NOT_SUPPORTED = 0, HBBTV_AVControl_CONNECTION_ERROR, HBBTV_AVControl_UNDEFINED, HBBTV_AVControl_NO_RESOURCES, HBBTV_AVControl_CORRUPT, HBBTV_AVControl_NOT_AVAILABLE, HBBTV_AVControl_NOT_AVAILABLE_POSITION, HBBTV_AVControl_BLOCKED }

enum	HBBTV_JSProgrammeID_TYPE { HBBTV_JSProgrammeID_TVA_CRID = 0, HBBTV_JSProgrammeID_DVB_EVENT = 1 }

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

enum	HBBTV_JSObjType_CONST { 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 }

Functions
BOOLEAN	HBBTV_JSOipfObjFactory_isObjSupported (S_HBBTV_STRING *mime_type)
	Boolean isObjectSupported( String mimeType ), Section 7.1.1. More...

void *	HBBTV_JSOipfObjFactory_createVideoBroadcastObject (void)
	HTMLObjectElement createVideoBroadcastObject(), Section 7.1.1.1. More...

void *	HBBTV_JSOipfObjFactory_createVideoMpegObject (void)
	HTMLObjectElement createVideoMpegObject(), Section 7.1.1.1. More...

void *	HBBTV_JSOipfObjFactory_createAppMgrObject (void)
	Object createApplicationManagerObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createConfigObject (void)
	Object createConfigurationObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createParentalControlMgrObject (void)
	Object createParentalControlManagerObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createCapabilitiesObject (void)
	Object createCapabilitiesObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createSearchManagerObject (void)
	Object createSearchManagerObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createRecordingSchedulerObject (void)
	Object createRecordingSchedulerObject(), Section 7.1.1.2. More...

void *	HBBTV_JSOipfObjFactory_createDRMAgentObject (void)
	Object createDRMAgentObject(), section 7.1.1.2.

void *	HBBTV_JSOipfAppMgr_getOwnerApp (void app_mgr, S_HBBTV_STRING url)
	Application getOwnerApplication( Document document ), Section 7.2.1.2. More...

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

void *	HBBTV_JSApp_getPrivateData (void *app)
	readonly ApplicationPrivateData privateData, Section 7.2.2.1 More...

void *	HBBTV_JSApp_createApp (void app, S_HBBTV_STRING uri, BOOLEAN create_child)
	Application createApplication( String uri, Boolean createChild ), Section 7.2.2.2. More...

void	HBBTV_JSApp_destroyApp (void *app)
	void destroyApplication(), Section 7.2.2.2 More...

void	HBBTV_JSApp_show (void *app)
	void show(), Section 7.2.2.2 More...

void	HBBTV_JSApp_hide (void *app)
	void hide(), Section 7.2.2.2 More...

void *	HBBTV_JSAppPrivateData_getKeyset (void *app_private_data)
	readonly Keyset keyset, Section 7.2.4.1 More...

S32BIT	HBBTV_JSAppPrivateData_getFreeMem (void *app_private_data)
	Integer getFreeMem(), Section 7.2.4.2. More...

void *	HBBTV_JSAppPrivateData_getCurrentChannel (void *app_private_data)
	Channel getCurrentChannel(), TS102796, Annex A.2.2. More...

S32BIT	HBBTV_JSKeySet_getValue (void *key_set)
	readonly Integer value, Section 7.2.5.2 More...

S32BIT	HBBTV_JSKeySet_getMaximumValue (void *key_set)
	readonly Integer maximumValue, Section 7.2.5.2 More...

S32BIT	HBBTV_JSKeySet_setValue (void *key_set, S32BIT value)
	Integer setValue( Integer value, Integer otherKeys[] ), Section 7.2.5.3. More...

U32BIT	HBBTV_JSKeySet_getOtherKeys (void obj, U32BIT *other_keys)
	readonly Integer otherKeys[]. More...

void *	HBBTV_JSOipfConfig_getConfig (void *config)
	readonly Configuration configuration, Section 7.3.1.1 More...

void *	HBBTV_JSOipfConfig_getLocalSystem (void *obj)
	readonly LocalSystem localSystem, Section 7.3.1.1 More...

void *	HBBTV_JSConfig_getPreferredAudioLang (void *config)
	String preferredAudioLanguage, Section 7.3.2.1. More...

void *	HBBTV_JSConfig_getPreferredSubtitleLang (void *config)
	String preferredSubtitleLanguage, Section 7.3.2.1. More...

void *	HBBTV_JSConfig_getPreferredUILang (void *config)
	String preferredUILanguage, Section 7.3.2.1. String data is valid only while the Configuration object is valid. More...

void *	HBBTV_JSConfig_getCountryId (void *config)
	String countryId, Section 7.3.2.1. String data is valid only while the Configuration object is valid. More...

void *	HBBTV_JSConfig_getPostcode (void *obj)
	readonly String postcode, Freesat OPAL v1.0, section 8.4.1.1. More...

S8BIT	HBBTV_JSConfig_getSpeechDescriptionEnabled (void *obj)
	readonly Boolean speechDescriptionEnabled, Freesat OPAL v1.0, section 8.4.1.2. More...

S8BIT	HBBTV_JSConfig_getVoiceControlEnabled (void *obj)
	readonly Boolean voiceControlEnabled, Freesat OPAL v1.0, section 8.4.1.3. More...

U8BIT	HBBTV_JSConfig_getTerminalMode (void *obj)
	readonly Integer terminalMode, Freesat OPAL v1.0, section 8.4.1.4 More...

void *	HBBTV_JSOipfParentalControlMgr_getParentalRatingSchemes (void *parental_control_mgr)
	readonly ParentalRatingSchemeCollection parentalRatingSchemes, Section 7.9.1.1 More...

void *	HBBTV_JSOipfSearchManager_createSearch (void *search_manager, HBBTV_JSMetadataSearch_Target search_target)
	createSearch, Section 7.12.1.2. Only HBBTV_JSMetadataSearch_TARGET_SCHEDULED_CONTENT is supported as value for searchTarget (TS102796 v1.2.1 Section A1). More...

void *	HBBTV_JSOipfSearchManager_getChannelConfig (void *search_manager)
	ChannelConfig getChannelConfig, Section 7.12.1.2. More...

HBBTV_JSMetadataSearch_Target	HBBTV_JSMetadataSearch_getSearchTarget (void *metadata_search)
	readonly Integer searchTarget, Section 7.12.2.1. Only HBBTV_JSSearchManager_TARGET_SCHEDULED_CONTENT is supported as value for searchTarget (TS102796 v1.2.1 Section A1). More...

void *	HBBTV_JSMetadataSearch_getResult (void *metadata_search)
	readonly SearchResults result, Section 7.12.2.1 More...

void	HBBTV_JSMetadataSearch_setQuery (void metadata_search, void query)
	void setQuery(Query query), Section 7.12.2.2 More...

void	HBBTV_JSMetadataSearch_addChannelConstraint (void metadata_search, void channel)
	void addChannelConstraint(Channel channel), Section 7.12.2.2 More...

void *	HBBTV_JSMetadataSearch_createQuery (void metadata_search, S_HBBTV_STRING field, HBBTV_JSMetadataSearch_Comparison comparison, S_HBBTV_STRING *value)
	Query createQuery(String field, Integer comparison, String value), Section 7.12.2.2. More...

void	HBBTV_JSMetadataSearch_findProgrammesFromStream (void metadata_search, void channel, U32BIT start_time)
	void findProgrammesFromStream ( Channel channel, Integer startTime ), Section 7.12.2.2 More...

void *	HBBTV_JSQuery_and (void query, void operand_query)
	Query and( Query query ), Section 7.12.3.2. More...

void *	HBBTV_JSQuery_or (void query, void operand_query)
	Query or( Query query ), Section 7.12.3.2. More...

void *	HBBTV_JSQuery_not (void *query)
	Query not( ), Section 7.12.3.2. More...

U32BIT	HBBTV_JSSearchResults_getOffset (void *search_result)
	readonly Integer offset, Section 7.12.4.1 More...

U32BIT	HBBTV_JSSearchResults_getTotalSize (void *search_result)
	readonly Integer totalSize, Section 7.12.4.1 More...

BOOLEAN	HBBTV_JSSearchResults_getResults (void *search_result, U32BIT offset, U32BIT count)
	Boolean getResults( Integer offset, Integer count ), Section 7.12.4.2. More...

void	HBBTV_JSSearchResults_abort (void *search_result)
	void abort( ), Section 7.12.4.2 More...

U32BIT	HBBTV_JSAVComponent_getType (void *av_component)
	Integer type, Section 7.16.5.2.1. More...

void *	HBBTV_JSAVComponent_getEncoding (void *av_component)
	String encoding, Section 7.16.5.2.1. More...

BOOLEAN	HBBTV_JSAVComponent_getEncrypted (void *av_component)
	Boolean encrypted, Section 7.16.5.2.1. More...

float	HBBTV_JSAVComponent_getAspectRatio (void *av_component)
	Number aspectRatio, Section 7.16.5.3.1. More...

void *	HBBTV_JSAVComponent_getLanguage (void *av_component)
	String language, Section 7.16.5.4.1. More...

BOOLEAN	HBBTV_JSAVComponent_getAudioDescription (void *av_component)
	Boolean audioDescription, Section 7.16.5.4.1. More...

U32BIT	HBBTV_JSAVComponent_getAudioChannels (void *av_component)
	Integer audioChannels, Section 7.16.5.4.1. More...

BOOLEAN	HBBTV_JSAVComponent_getHearingImpaired (void *av_component)
	Boolean hearingImpaired, Section 7.16.5.5.1. More...

S8BIT	HBBTV_JSAVComponent_getComponentTag (void *obj)
	Integer componentTag, Section 7.16.5.2.1. More...

U16BIT	HBBTV_JSAVComponent_getPid (void *obj)
	Integer pid, Section 7.16.5.2.1. More...

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

S32BIT	HBBTV_JSVideoBroadcast_getWidth (void *video_broadcast)
	Integer width, Section 7.13.1.2. More...

void	HBBTV_JSVideoBroadcast_setWidth (void *video_broadcast, S32BIT width)
	Integer width, Section 7.13.1.2. More...

S32BIT	HBBTV_JSVideoBroadcast_getHeight (void *video_broadcast)
	Integer height, Section 7.13.1.2. More...

void	HBBTV_JSVideoBroadcast_setHeight (void *video_broadcast, S32BIT height)
	Integer height, Section 7.13.1.2. More...

void	HBBTV_JSVideoBroadcast_setVideoWindow (void *obj, S32BIT x, S32BIT y, S32BIT width, S32BIT height)
	Changes the video position and dimensions at once. More...

BOOLEAN	HBBTV_JSVideoBroadcast_getFullScreen (void *video_broadcast)
	readonly Boolean fullScreen, Section 7.13.1.2 More...

E_HBBTV_BROADCAST_STATE	HBBTV_JSVideoBroadcast_getPlayState (void *video_broadcast)
	Integer playState, Section 7.13.1.2. More...

void *	HBBTV_JSVideoBroadcast_getData (void *video_broadcast)
	String data, Section 7.13.1.2. More...

void	HBBTV_JSVideoBroadcast_setData (void video_broadcast, S_HBBTV_STRING data)
	String data, Section 7.13.1.2. More...

void *	HBBTV_JSVideoBroadcast_getChannelConfig (void *video_broadcast)
	ChannelConfig getChannelConfig(), Section 7.13.1.3. More...

void	HBBTV_JSVideoBroadcast_bindToCurrentChannel (void *video_broadcast)
	void bindToCurrentChannel(), Section 7.13.1.3 More...

void *	HBBTV_JSVideoBroadcast_createChannelObject (void video_broadcast, S32BIT id_type, S_HBBTV_STRING dsd, S32BIT sid)
	Channel createChannelObject(Integer idType, String dsd, Integer sid), Section 7.13.1.3. Although dsd property of the channel object is defined as ISO Latin1, the HbbTV engine expects dsd to be UTF-8 encoded as Latin1 is not supported. More...

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)
	Channel createChannelObject(Integer idType, Integer onid, Integer tsid, Integer sid, Integer sourceID, String ipBroadcastID), Section 7.13.1.3. More...

void	HBBTV_JSVideoBroadcast_setChannel (void video_broadcast, void channel, BOOLEAN trickplay, S_HBBTV_STRING *content_access_desc_url)
	void setChannel(Channel channel, Boolean trickplay, String contentAccessDescriptorURL), Section 7.13.1.3 More...

void	HBBTV_JSVideoBroadcast_prevChannel (void *video_broadcast)
	void prevChannel(), Section 7.13.1.3 More...

void	HBBTV_JSVideoBroadcast_nextChannel (void *video_broadcast)
	void nextChannel(), Section 7.13.1.3 More...

void	HBBTV_JSVideoBroadcast_setFullScreen (void *video_broadcast, BOOLEAN fullscreen)
	void setFullScreen(Boolean fullscreen), Section 7.13.1.3 More...

void	HBBTV_JSVideoBroadcast_release (void *video_broadcast)
	void release(), Section 7.13.1.3 More...

void	HBBTV_JSVideoBroadcast_stop (void *video_broadcast)
	void stop(), Section 7.13.1.3 More...

void *	HBBTV_JSVideoBroadcast_getCurrentChannel (void *video_broadcast)
	readonly Channel currentChannel, Section 7.13.7.1 More...

void *	HBBTV_JSVideoBroadcast_getProgrammes (void *video_broadcast)
	readonly ProgrammeCollection programmes, Section 7.13.3 More...

void *	HBBTV_JSVideoBroadcast_getComponents (void *video_broadcast, HBBTV_JSAVComponent_Type type)
	AVComponentCollection getComponents, Section 7.16.5.1.3. HBBTV_JSAVComponent_TYPE_UNKNOWN is used for parameter 'type' for values null or undefined in javascript. More...

void *	HBBTV_JSVideoBroadcast_getCurrentActiveComponents (void *video_broadcast, HBBTV_JSAVComponent_Type type)
	AVComponentCollection getCurrentActiveComponents, Section 7.16.5.1.3. More...

void	HBBTV_JSVideoBroadcast_selectComponent (void video_broadcast, void component)
	void selectComponent( AVComponent component ), Section 7.16.5.1.3

void	HBBTV_JSVideoBroadcast_selectComponentType (void *obj, HBBTV_JSAVComponent_Type comp_type)
	void void selectComponent( Integer componentType ), Section 7.16.5.1.3

void	HBBTV_JSVideoBroadcast_unselectComponent (void video_broadcast, void component)
	void unselectComponent( AVComponent component ), Section 7.16.5.1.3

void	HBBTV_JSVideoBroadcast_unselectComponentType (void *obj, HBBTV_JSAVComponent_Type comp_type)
	void unselectComponent( Integer componentType ), Section 7.16.5.1.3

BOOLEAN	HBBTV_JSVideoBroadcast_addStreamEventListener (void *video_broadcast, S_HBBTV_STRING dvb_url, S_HBBTV_STRING name, U32BIT listener_id)
	void addStreamEventListener, TS 102796, Section 8.2.1.1 More...

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 removeStreamEventListener, TS 102796, Section 8.2.1.1 More...

void *	HBBTV_JSVideoBroadcast_recordNow (void *obj, S32BIT duration)
	void recordNow, section 7.13.2.3 More...

void	HBBTV_JSVideoBroadcast_stopRecording (void *obj)
	void stopRecording(), sectuion 7.13.2.3 More...

HBBTV_JSVideoBroadcast_RECORDING_STATE	HBBTV_JSVideoBroadcast_getRecordingState (void *video_broadcast)
	readonly Integer recordingState, Section 7.13.2.2 More...

float	HBBTV_JSVideoBroadcast_getPlaySpeed (void *video_broadcast)
	readonly Number playSpeed, Section 7.13.2.2 More...

U32BIT	HBBTV_JSVideoBroadcast_getPlayPosition (void *video_broadcast)
	readonly Integer playPosition, Section 7.13.2.2 More...

void *	HBBTV_JSChannelConfig_getChannelList (void *obj)
	readonly ChannelList channelList, Section 7.13.9.1 More...

void *	HBBTV_JSChannelConfig_getGenres (void *obj)
	readonly StringCollection genres OPAL version 1.3, section 13.2.2.12.2.2 More...

void *	HBBTV_JSChannelList_getChannel (void obj, S_HBBTV_STRING channel_id)
	Channel getChannel, Section 7.13.10.2. More...

void *	HBBTV_JSChannelList_getChannelByTriplet (void *obj, S32BIT onid, S32BIT tsid, S32BIT sid)
	Channel getChannelByTriplet, Section 7.13.10.2. More...

S32BIT	HBBTV_JSChannel_getChannelType (void *channel)
	readonly Integer channelType, Section 7.13.11.2 More...

void *	HBBTV_JSChannel_getCcid (void *channel)
	readonly readonly String ccid, Section 7.13.11.2 More...

void *	HBBTV_JSChannel_getDsd (void *channel)
	readonly String dsd, Section 7.13.11.2. This string is empty unless the channel has been created by the video/broadcast method createChannelObject(Integer idType, String dsd, Integer sid). More...

S32BIT	HBBTV_JSChannel_getOnid (void *channel)
	readonly Integer onid, Section 7.13.11.2 More...

S32BIT	HBBTV_JSChannel_getTsid (void *channel)
	readonly Integer tsid, Section 7.13.11.2 More...

S32BIT	HBBTV_JSChannel_getSid (void *channel)
	readonly Integer sid, Section 7.13.11.2 More...

void *	HBBTV_JSChannel_getName (void *channel)
	readonly String name, Section 7.13.11.2 More...

S32BIT	HBBTV_JSChannel_getNid (void *obj)
	readonly Integer nid, OIPF vol. 5, section 7.13.11.2 More...

S32BIT	HBBTV_JSChannel_getMajorChannel (void *obj)
	readonly Integer majorChannel, OIPF vol. 5, section 7.13.11.2 More...

BOOLEAN	HBBTV_JSChannel_getLocked (void *obj)
	readonly Boolean locked, OIPF vol. 5, section 7.13.11.2 More...

void *	HBBTV_JSChannel_getShortName (void *obj)
	readonly String shortName. This property is not part of OIPF Vol. 5. This implements the Channel's shortName property as defined by Freesat Opal v1.0, section 14.6.9 More...

BOOLEAN	HBBTV_JSChannel_getRunningStatus (void *obj)
	readonly Boolean runningStatus. This property is not part of OIPF Vol. 5. This implements the Channel's runningStatus property as defined by Freesat OPAL v1.0, section 14.6.15 More...

BOOLEAN	HBBTV_JSChannel_getHidden (void *obj)
	readonly Boolean hidden. This property is not part of OIPF Vol. 5. This implements the Channel's hidden property as defined by Freesat OPAL v1.0, section 14.6.17 More...

U16BIT	HBBTV_JSChannel_getOpalChannelType (void *obj)
	readonly Integer opalChannelType. This property is not part of OIPF Vol. 5. This implements the Channel's opalChannelType property as defined by Freesat OPAL v1.0, section 14.6.3 More...

U16BIT	HBBTV_JSChannel_getFreesatServiceID (void *obj)
	readonly Integer freesatServiceID. This property is not part of OIPF Vol. 5. This implements the Channel's freesatServiceID property as defined by Freesat OPAL v1.0, section 14.6.1 More...

void *	HBBTV_JSChannel_getGenre (void *obj)
	readonly StringCollection genre OPAL version 1.3, section 14.4.13.13.4.13 More...

void *	HBBTV_JSAVControl_createVideoMpeg (void)
	Creation of an AV control object of mime type "video/mpeg". More...

void *	HBBTV_JSAVControl_createVideoMp4 (void)
	Creation of an AV control object of mime type "video/mp4". More...

void *	HBBTV_JSAVControl_createAudioMpeg (void)
	Creation of an AV control object of mime type "audio/mpeg". More...

void *	HBBTV_JSAVControl_createAudioMp4 (void)
	Creation of an AV control object of mime type "audio/mp4". More...

void *	HBBTV_JSAVControl_getData (void *avControl)
	String data [RW], CEA-2014-A Section 5.7.1.f. More...

void	HBBTV_JSAVControl_setData (void avControl, S_HBBTV_STRING data)
	String data [RW], CEA-2014-A Section 5.7.1.f. More...

U32BIT	HBBTV_JSAVControl_getPlayPosition (void *avControl)
	Number playPosition [R], CEA-2014-A Section 5.7.1.f. More...

U32BIT	HBBTV_JSAVControl_getPlayTime (void *avControl)
	Number playTime [R], CEA-2014-A Section 5.7.1.f. More...

S32BIT	HBBTV_JSAVControl_getPlayState (void *avControl)
	Number playState [R], CEA-2014-A Section 5.7.1.f. More...

S32BIT	HBBTV_JSAVControl_getError (void *avControl)
	Number error [R], CEA-2014-A Section 5.7.1.f. More...

S32BIT	HBBTV_JSAVControl_getNrTracks (void *avControl)
	Number nrTracks [R], CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns 1 if the content identified by 'data' has been found and 0 otherwise. More...

S32BIT	HBBTV_JSAVControl_getSpeed (void *avControl)
	Number speed [R], CEA-2014-A Section 5.7.1.f. More...

S32BIT	HBBTV_JSAVControl_getCurrentTrackIndex (void *avControl)
	Number currentTrackIndex [RW], CEA-2014-A Section 5.7.1.f. Playlists are not supported. More...

void	HBBTV_JSAVControl_setCurrentTrackIndex (void *avControl, S32BIT trackIndex)
	Number currentTrackIndex [RW], CEA-2014-A Section 5.7.1.f. Playlists are not supported. More...

BOOLEAN	HBBTV_JSAVControl_getPersist (void *avControl)
	Boolean persist [RW], CEA-2014-A Section 5.7.1.f. More...

void	HBBTV_JSAVControl_setPersist (void *avControl, BOOLEAN persist)
	Boolean persist [RW], CEA-2014-A Section 5.7.1.f. This function only stores the property value but doesn't perform any action, as persist attribute is not currently supported. More...

BOOLEAN	HBBTV_JSAVControl_play (void *avControl, S32BIT speed)
	Boolean play(Number speed), CEA-2014-A Section 5.7.1.f. More...

BOOLEAN	HBBTV_JSAVControl_stop (void *avControl)
	Boolean stop(), CEA-2014-A Section 5.7.1.f. More...

BOOLEAN	HBBTV_JSAVControl_seek (void *avControl, U32BIT pos)
	Boolean seek(Number pos), CEA-2014-A Section 5.7.1.f. More...

BOOLEAN	HBBTV_JSAVControl_setVolume (void *avControl, S32BIT volume)
	Boolean setVolume(Number volume), CEA-2014-A Section 5.7.1.f. More...

BOOLEAN	HBBTV_JSAVControl_next (void *avControl)
	Boolean next(), CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns FALSE. More...

BOOLEAN	HBBTV_JSAVControl_previous (void *avControl)
	Boolean previous(), CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns FALSE. More...

S32BIT	HBBTV_JSAVControl_getWidth (void *avControl)
	Integer width, CEA-2014-A Section 5.7.1.g. More...

void	HBBTV_JSAVControl_setWidth (void *avControl, S32BIT width)
	Integer width, CEA-2014-A Section 5.7.1.g. More...

S32BIT	HBBTV_JSAVControl_getHeight (void *avControl)
	Integer height, CEA-2014-A Section 5.7.1.g. More...

void	HBBTV_JSAVControl_setHeight (void *avControl, S32BIT height)
	Integer height, CEA-2014-A Section 5.7.1.g. More...

BOOLEAN	HBBTV_JSAVControl_getFullScreen (void *avControl)
	readonly Boolean fullScreen, CEA-2014-A Section 5.7.1.g More...

void	HBBTV_JSAVControl_setFullScreen (void *avControl, BOOLEAN fullscreen)
	void setFullScreen(Boolean fullscreen), CEA-2014-A Section 5.7.1.g More...

void	HBBTV_JSAVControl_setPosition (void *avControl, S32BIT x, S32BIT y)
	Sets the object's position on screen. More...

void *	HBBTV_JSAVControl_getComponents (void *avControl, HBBTV_JSAVComponent_Type component_type)
	AVComponent[] getComponents, Section 7.16.5.1.3. More...

void *	HBBTV_JSAVControl_getCurrentActiveComponents (void *avControl, HBBTV_JSAVComponent_Type component_type)
	AVComponent[] getCurrentActiveComponents, Section 7.16.5.1.3. More...

void	HBBTV_JSAVControl_selectComponent (void avControl, void component)
	void selectComponent( AVComponent component ), Section 7.16.5.1.3

void	HBBTV_JSAVControl_selectComponentType (void *avControl, HBBTV_JSAVComponent_Type component_type)
	void selectComponent( Integer componentType ), Section 7.16.5.1.3

void	HBBTV_JSAVControl_unselectComponent (void avControl, void component)
	void unselectComponent( AVComponent component ), Section 7.16.5.1.3

void	HBBTV_JSAVControl_unselectComponentType (void *obj, HBBTV_JSAVComponent_Type comp_type)
	void unselectComponent( Integer componentType ), Section 7.16.5.1.3

void	HBBTV_JSAVControl_setCache (void *avControl, BOOLEAN cache)
	boolean cache, Section 7.14.10.1. This function is used to set the cache parameter value when it's present in the tag of the <object>. More...

void	HBBTV_JSAVControl_setLoop (void *avControl, S32BIT loopParam)
	loop, Section 7.14.10.1. This function is used to set the loop parameter value when it's present in the tag of the <object>. Value -1 represents 'infinite'. More...

BOOLEAN	HBBTV_JSAVControl_queue (void avControl, S_HBBTV_STRING url)
	Boolean queue( String url ), TS102796 v1.2.1, Section A.2.5. More...

BOOLEAN	HBBTV_JSAVControl_setSource (void avControl, S_HBBTV_STRING id)
	Boolean setSource( String id ), Section 7.14.7. More...

void *	HBBTV_JSParentalRatingScheme_getName (void *parental_rating_scheme)
	readonly String name, Section 7.9.2.1 More...

U32BIT	HBBTV_JSParentalRatingScheme_getLength (void *parental_rating_scheme)
	readonly Integer length, Section 7.9.2.1 More...

void *	HBBTV_JSParentalRatingScheme_getThreshold (void *parental_rating_scheme)
	readonly ParentalRating threshold, Section 7.9.2.1 More...

S32BIT	HBBTV_JSParentalRatingScheme_indexOf (void parental_rating_scheme, S_HBBTV_STRING ratingValue)
	Integer indexOf, Section 7.9.2.2. More...

void *	HBBTV_JSParentalRatingScheme_item (void *parental_rating_scheme, U32BIT index)
	String item, Section 7.9.2.2. More...

void *	HBBTV_JSParentalRatingScheme_iconUri (void *parental_rating_scheme, U32BIT index)
	String iconUri, Section 7.9.2.2. More...

void *	HBBTV_JSCollection_addParentalRatingScheme (void collection, S_HBBTV_STRING name, S_HBBTV_STRING *values)
	ParentalRatingScheme addParentalRatingScheme, Section 7.9.3.2. More...

void *	HBBTV_JSCollection_getParentalRatingScheme (void collection, S_HBBTV_STRING name)
	ParentalRatingScheme getParentalRatingScheme, Section 7.9.3.2. More...

void *	HBBTV_JSParentalRating_getName (void *parental_rating)
	String name, Section 7.9.4.1. More...

void *	HBBTV_JSParentalRating_getScheme (void *parental_rating)
	String scheme, Section 7.9.4.1. More...

U32BIT	HBBTV_JSParentalRating_getValue (void *parental_rating)
	Integer value, Section 7.9.4.1. More...

U32BIT	HBBTV_JSParentalRating_getLabels (void *parental_rating)
	Integer labels, Section 7.9.4.1. More...

void *	HBBTV_JSParentalRating_getRegion (void *parental_rating)
	String region, Section 7.9.4.1. More...

void	HBBTV_JSCollection_addParentalRating (void collection, S_HBBTV_STRING scheme, S_HBBTV_STRING name, U32BIT value, U32BIT labels, S_HBBTV_STRING region)
	void addParentalRating, Section 7.9.5.2 More...

void *	HBBTV_JSOipfCapabilities_getXmlCapabilities (void *obj)
	readonly Document xmlCapabilities, Section 7.15.3.1 More...

U8BIT	HBBTV_JSOipfCapabilities_getExtraSDVideoDecodes (void *obj)
	readonly Number extraSDVideoDecodes, Section 7.15.3.1. This property is not implemented and returns 0. More...

U8BIT	HBBTV_JSOipfCapabilities_getExtraHDVideoDecodes (void *obj)
	readonly Number extraHDVideoDecodes, Section 7.15.3.1. This property is not implemented and returns 0. More...

BOOLEAN	HBBTV_JSOipfCapabilities_hasCapability (void obj, S_HBBTV_STRING profileName)
	Boolean hasCapability( String profileName ), Section 7.15.3.2. More...

void *	HBBTV_Capabilities_getOptionsString (void)
	Returns a string object containing the supported options as defined in TS102796, section 10.2.4. The returned string can be used to form the correct User-Agent value. The string object must be released using HBBTV_JSObject_release. More...

void *	HBBTV_JSProgramme_getName (void *programme)
	String name, Section 7.16.2.2. More...

void *	HBBTV_JSProgramme_getProgrammeID (void *programme)
	String programmeID, Section 7.16.2.2.

U32BIT	HBBTV_JSProgramme_getProgrammeIDType (void *programme)
	Integer programmeIDType, Section 7.16.2.2. More...

void *	HBBTV_JSProgramme_getDescription (void *programme)
	String description, Section 7.16.2.2. More...

void *	HBBTV_JSProgramme_getLongDescription (void *programme)
	String longDescription, Section 7.16.2.2. More...

U32BIT	HBBTV_JSProgramme_getStartTime (void *programme)
	Integer startTime, Section 7.16.2.2. More...

U32BIT	HBBTV_JSProgramme_getDuration (void *programme)
	Integer duration, Section 7.16.2.2. More...

void *	HBBTV_JSProgramme_getChannelID (void *programme)
	String channelID, Section 7.16.2.2. More...

void *	HBBTV_JSProgramme_getParentalRatings (void *programme)
	readonly ParentalRatingCollection parentalRatings, Section 7.16.2.2 More...

void *	HBBTV_JSProgramme_getSIDescriptors (void *programme, S32BIT desc_tag_id, S32BIT ext_desc_tag_id)
	StringCollection getSIDescriptors, Section 7.16.2.4. More...

U32BIT	HBBTV_JSProgramme_getAudioType (void *obj)
	readonly Integer audioType, section 7.10.5.1, extended by Freesat OPAL v1.0, section 17.2.10. More...

BOOLEAN	HBBTV_JSProgramme_getIsMultilingual (void *obj)
	readonly Boolean isMultilingual, section 7.16.2.3.1

void *	HBBTV_JSProgramme_getAudioLanguages (void *obj)
	readonly StringCollection audioLanguages, Freesat OPAL v1.0, section 17.2.14 More...

BOOLEAN	HBBTV_JSProgramme_getIsHd (void *obj)
	readonly Boolean isHD, section 7.16.2.3.1

BOOLEAN	HBBTV_JSProgramme_getHasAudioDescription (void *obj)
	readonly Boolean hasAudioDescription, OPAL v1.0, section 17.2.19

BOOLEAN	HBBTV_JSProgramme_getHasSignLanguage (void *obj)
	readonly Boolean hasSignLanguage, OPAL v1.0, section 17.2.18

void *	HBBTV_JSProgramme_getGenre (void *obj)
	readonly StringCollection genre, Freesat OPAL v1.0, section 17.2.12 More...

BOOLEAN	HBBTV_JSProgramme_getHasGuidance (void *obj)
	readonly Boolean hasGuidance, OPAL v1.0, section 17.2.23

void *	HBBTV_JSProgramme_getGuidance (void *obj)
	readonly StringCollection guidance, Freesat OPAL v1.0, section 17.2.24 More...

void *	HBBTV_JSProgramme_getMediaAssets (void *obj)
	readonly StringCollection mediaAssets[], Freesat OPAL v1.0, section 17.2.21 More...

void *	HBBTV_JSProgramme_getPromotionalContentText (void *obj)
	readonly String promotionalContentText, Freesat OPAL v1.0, section 17.2.22 More...

BOOLEAN	HBBTV_JSProgramme_getHasHDSimulcast (void *obj)
	readonly Boolean hasHDSimulcast, Freesat OPAL v1.0, section 17.2.25 More...

void *	HBBTV_JSProgramme_getCRIDS (void *obj)
	readonly StringCollection CRIDS, Freesat OPAL v1.0, section 17.2.27 More...

BOOLEAN	HBBTV_JSProgramme_getHasRecording (void *obj)
	readonly Boolean hasRecording, section 7.16.2.3.1 More...

void *	HBBTV_JSProgramme_getRecording (void *obj)
	readonly ScheduledRecording recording, section 7.16.2.5 More...

S32BIT	HBBTV_JSScheduledRecording_getStartPadding (void *obj)
	Integer startPadding, Section 7.10.2.2. More...

void	HBBTV_JSScheduledRecording_setStartPadding (void *obj, S32BIT start_padding)
	Integer startPadding, Section 7.10.2.2. More...

S32BIT	HBBTV_JSScheduledRecording_getEndPadding (void *obj)
	Integer endPadding, Section 7.10.2.2. More...

void	HBBTV_JSScheduledRecording_setEndPadding (void *obj, S32BIT end_padding)
	Integer endPadding, Section 7.10.2.2. More...

void *	HBBTV_JSScheduledRecording_getName (void *obj)
	String name, Section 7.10.2.2. More...

void	HBBTV_JSScheduledRecording_setName (void obj, S_HBBTV_STRING name)
	String name, Section 7.10.2.2. More...

void *	HBBTV_JSScheduledRecording_getParentalRatings (void *obj)
	readonly ParentalRatingCollection parentalRatings, Section 7.10.2.2 More...

void *	HBBTV_JSScheduledRecording_getDescription (void *obj)
	String description, Section 7.10.2.2. More...

void	HBBTV_JSScheduledRecording_setDescription (void obj, S_HBBTV_STRING description)
	String description, Section 7.10.2.2. More...

U32BIT	HBBTV_JSScheduledRecording_getStartTime (void *obj)
	readonly Integer startTime, Section 7.10.2.2 More...

U32BIT	HBBTV_JSScheduledRecording_getDuration (void *obj)
	readonly Integer duration, Section 7.10.2.2 More...

HBBTV_JSScheduledRecording_STATE	HBBTV_JSScheduledRecording_getState (void *obj)
	readonly Integer state, Section 7.10.2.2 More...

void *	HBBTV_JSScheduledRecording_getChannel (void *obj)
	readonly Channel channel, Section 7.10.2.2 More...

void *	HBBTV_JSScheduledRecording_getId (void *obj)
	readonly String id, Section 7.10.5.1. Returns a pointer to a string object if called on a Recording object, NULL otherwise. More...

U32BIT	HBBTV_JSScheduledRecording_getRecordingStartTime (void *obj)
	readonly Integer recordingStartTime, Section 7.10.5.1 More...

U32BIT	HBBTV_JSScheduledRecording_getRecordingDuration (void *obj)
	readonly Integer recordingDuration, Section 7.10.5.1 More...

void *	HBBTV_JSOipfRecordingScheduler_getChannelConfig (void *obj)
	ChannelConfig getChannelConfig(), Section 7.10.1.1. More...

void *	HBBTV_JSOipfRecordingScheduler_record (void obj, void programme)
	ScheduledRecording record( Programme programme ), Section 7.10.1.1. More...

void *	HBBTV_JSOipfRecordingScheduler_createProgrammeObject (void *obj)
	Programme createProgrammeObject(), Section 7.10.1.1. More...

void *	HBBTV_JSOipfRecordingScheduler_recordAt (void obj, U32BIT start_time, U32BIT duration, U8BIT repeat_days, S_HBBTV_STRING channel_id)
	ScheduledRecording recordAt( Integer startTime, Integer duration, Integer repeatDays, String channelID ), Section 7.10.1.1. More...

void *	HBBTV_JSOipfRecordingScheduler_getScheduledRecordings (void *obj)
	ScheduledRecordingCollection getScheduledRecordings(), Section 7.10.1.1. More...

void	HBBTV_JSOipfRecordingScheduler_remove (void obj, void scheduled_recording)
	void remove( ScheduledRecording recording ), Section 7.10.1.1 More...

void *	HBBTV_JSOipfRecordingScheduler_getRecordings (void *obj)
	readonly ScheduledRecordingCollection recordings, Section 7.10.4.1 More...

U32BIT	HBBTV_JSCollection_getLength (void *collection)
	readonly Integer Collection length, Section 7.16.1.1

void *	HBBTV_JSCollection_getItem (void *collection, U32BIT index)
	readonly Collection item, Section 7.16.1.2

S_HBBTV_STRING	HBBTV_JSString_getValue (void *string)
	Return string's value. The value is only valid while the string object is valid. More...

U16BIT *	HBBTV_JSString_getString16 (void *string)
	Returns a string in HbbTV UTF-16 format, with conversion taking place if necessary. More...

U8BIT *	HBBTV_JSString_getString8 (void *string)
	Returns a string in HbbTV UTF-8 format, with conversion taking place if necessary. More...

void	HBBTV_JSString_releaseString (U8BIT *utf_string)
	Releases a UTF-8 or UTF-16 string obtained using HBBTV_JSString_getStringX. More...

U32BIT	HBBTV_JSString_utf8ByteLen (void *obj)
	Returns byte length of UTF-8 string (conversion may be needed). This would be used prior to calling HBBTV_JSString_utf8CopyData(). More...

void	HBBTV_JSString_utf8CopyData (void obj, U8BIT output)
	Fills output of UTF-8 string, (conversion may be needed). This would be used after calling HBBTV_JSString_utf8ByteLen(). More...

U32BIT	HBBTV_JSString_strlen (void *obj)
	Returns the number of characters in the string. More...

HBBTV_JSObjType_CONST	HBBTV_JSObject_type (void *obj)
	Returns type of object - can use with collection class. More...

void *	HBBTV_JSObject_incref (void *obj)
	Increases reference count of an object. More...

void	HBBTV_JSObject_release (void *obj)
	Releases an object. More...

void	HBBTV_JSObjectPrint (void)

void	HBBTV_JSObject_addObjectReference (void obj, void reference)
	Add a new reference to the list of references associated with this object. A reference is usually the pointer to an object in the JS extensions associated with this HbbTV engine object. Multiple JS object can be associated to one HbbTV engine object. This function can be blocking while other calls related to references for the same HbbTV engine object are being called. More...

void	HBBTV_JSObject_removeObjectReference (void obj, void reference)
	Removes a reference from the list of references associated to this object. A reference is usually removed when a JS object associated with a HbbTV engine object is destroyed. This function can be blocking while other calls related to references for the same HbbTV engine object are being called. More...

void	HBBTV_JSObject_getObjectReferences (void obj, void *references, U32BIT number)
	Retrieves the list of references associated with this object. The HbbTV engine allocates the memory and return the pointers to the list nd to the number of elements it contains. The list will have to be freed with a call to HBBTV_JSObject_releaseObjectReferences. This function can be blocking while other calls related to references for the same HbbTV engine object are being called. More...

void	HBBTV_JSObject_releaseObjectReferences (void obj, void *references)
	Releases a list of references returned by HBBTV_JSObject_getObjectReferences. This function can be blocking while other calls related to references for the same HbbTV engine object are being called. More...

void *	HBBTV_JSLocalSystem_getDeviceID (void *obj)
	readonly String deviceID, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getVendorName (void *obj)
	readonly String vendorName, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getFamilyName (void *obj)
	readonly String familyName, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getModelName (void *obj)
	readonly String modelName, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getSoftwareVersion (void *obj)
	readonly String softwareVersion, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getHardwareVersion (void *obj)
	readonly String hardwareVersion, section 7.3.3.1 More...

BOOLEAN	HBBTV_JSLocalSystem_getPvrEnabled (void *obj)
	readonly Boolean pvrEnabled, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getNetworkInterfaces (void *obj)
	readonly NetworkInterfaceCollection networkInterfaces, section 7.3.3.1 More...

void *	HBBTV_JSLocalSystem_getOipfProfile (void *obj)
	readonly String oipfProfile. This property is not part of OIPF Vol. 5, it implements the LocalSystem oipfProfile property as defined by Freesat Opal v1.0, section 8.5.1.2 More...

BOOLEAN	HBBTV_JSLocalSystem_getPvrStatus (void *obj)
	readonly Boolean pvrStatus This property is not part of OIPF Vol. 5, it implements the LocalSystem pvrStatus property as defined by Freesat Opal v1.0, section 8.5.1.3 More...

void *	HBBTV_JSNetworkInterface_getIpAddress (void *obj)
	readonly String ipAddress, section 7.3.4.1 More...

void *	HBBTV_JSNetworkInterface_getMacAddress (void *obj)
	readonly String macAddress, section 7.3.4.1 More...

BOOLEAN	HBBTV_JSNetworkInterface_getEnabled (void *obj)
	readonly Boolean enabled, section 7.3.4.1 More...

BOOLEAN	HBBTV_JSNetworkInterface_getConnected (void *obj)
	readonly Boolean connected, section 7.3.4.1 More...

void *	HBBTV_JSOipfDRMAgent_sendDRMMessage (void obj, S_HBBTV_STRING type, S_HBBTV_STRING message, S_HBBTV_STRING drm_system_id)
	String sendDRMMessage( String msgType, String msg, String DRMSystemID ), section 7.6.1.2. More...

void	HBBTV_JSExportPluginCallbacks (const S_PLUGIN_FUNCS *p_funcs)

Detailed Description

Definition of functions implementing the HbbTV Javascript extension.

Date: January 2014

Author: Sergio Panseri

Enumeration Type Documentation

enum HBBTV_JSAVComponent_Type

Note: Constants, Section 7.16.5.1.1

enum HBBTV_JSAVControl_ERROR

Note: Error codes, Annex B

enum HBBTV_JSChannel_TYPE

Note: Constants, Section 7.13.11.1

enum HBBTV_JSKeySet_CONST

Note: Constants, Section 7.2.5.1

enum HBBTV_JSMetadataSearch_Comparison

Note: comparison, Section 7.12.2.2

enum HBBTV_JSMetadataSearch_Target

Note: searchTarget, Section 7.12.1.2

enum HBBTV_JSProgrammeID_TYPE

Note: Constants, Section 7.16.2.1

enum HBBTV_JSSearchManager_State

Note: state, Section 7.12.1.1

enum HBBTV_JSVideoBroadcast_ERROR_STATE

Note: Error State, Section 7.13.1.2

Function Documentation

void* HBBTV_Capabilities_getOptionsString ( void )

Returns a string object containing the supported options as defined in TS102796, section 10.2.4. The returned string can be used to form the correct User-Agent value. The string object must be released using HBBTV_JSObject_release.

Returns: String object. NULL if no option is supported.

Returns a string object containing the supported options as defined in TS102796, section 10.2.4. The returned string can be used to form the correct User-Agent value. The string object must be released using HBBTV_JSObject_release.

Returns: String object. NULL if no option is supported.

void* HBBTV_JSApp_createApp	(	void *	obj,
		S_HBBTV_STRING *	uri,
		BOOLEAN	create_child
	)

Application createApplication( String uri, Boolean createChild ), Section 7.2.2.2.

Note: Application createApplication( String uri, Boolean createChild ); Section 7.2.2.2

void HBBTV_JSApp_destroyApp ( void * obj )

void destroyApplication(), Section 7.2.2.2

Note: void destroyApplication(); Section 7.2.2.2

void* HBBTV_JSApp_getPrivateData ( void * obj )

readonly ApplicationPrivateData privateData, Section 7.2.2.1

Note: readonly ApplicationPrivateData privateData; Section 7.2.2.1

void HBBTV_JSApp_hide ( void * obj )

void hide(), Section 7.2.2.2

Note: void hide(); Section 7.2.2.2

void HBBTV_JSApp_show ( void * obj )

void show(), Section 7.2.2.2

Note: void show(); Section 7.2.2.2

void* HBBTV_JSAppPrivateData_getCurrentChannel ( void * obj )

Channel getCurrentChannel(), TS102796, Annex A.2.2.

Note: Channel getCurrentChannel(); ETSI 102 796, Annex A.2.2

S32BIT HBBTV_JSAppPrivateData_getFreeMem ( void * obj )

Integer getFreeMem(), Section 7.2.4.2.

Note: Integer getFreeMem(); Section 7.2.4.2

void* HBBTV_JSAppPrivateData_getKeyset ( void * obj )

readonly Keyset keyset, Section 7.2.4.1

Note: readonly Keyset keyset; Section 7.2.4.1

float HBBTV_JSAVComponent_getAspectRatio ( void * obj )

Number aspectRatio, Section 7.16.5.3.1.

Note: Number aspectRatio; Section 7.14.4.2.1

U32BIT HBBTV_JSAVComponent_getAudioChannels ( void * obj )

Integer audioChannels, Section 7.16.5.4.1.

Note: Integer audioChannels; Section 7.14.4.2.1

BOOLEAN HBBTV_JSAVComponent_getAudioDescription ( void * obj )

Boolean audioDescription, Section 7.16.5.4.1.

Note: Boolean audioDescription; Section 7.14.4.2.1

S8BIT HBBTV_JSAVComponent_getComponentTag ( void * obj )

Integer componentTag, Section 7.16.5.2.1.

Note: Integer componentTag; Section 7.16.5.2.1

void* HBBTV_JSAVComponent_getEncoding ( void * obj )

String encoding, Section 7.16.5.2.1.

Note: String encoding; Section 7.16.5.2.1

BOOLEAN HBBTV_JSAVComponent_getEncrypted ( void * obj )

Boolean encrypted, Section 7.16.5.2.1.

Note: Boolean encrypted; Section 7.16.5.2.1

BOOLEAN HBBTV_JSAVComponent_getHearingImpaired ( void * obj )

Boolean hearingImpaired, Section 7.16.5.5.1.

Note: Boolean hearingImpaired; Section 7.14.4.2.1

void* HBBTV_JSAVComponent_getLanguage ( void * obj )

String language, Section 7.16.5.4.1.

Note: String language; Section 7.14.4.2.1

U16BIT HBBTV_JSAVComponent_getPid ( void * obj )

Integer pid, Section 7.16.5.2.1.

Note: Integer pid; Section 7.16.5.2.1

U32BIT HBBTV_JSAVComponent_getType ( void * obj )

Integer type, Section 7.16.5.2.1.

Note: Integer type; Section 7.16.5.2.1

void* HBBTV_JSAVControl_createAudioMp4 ( void )

Creation of an AV control object of mime type "audio/mp4".

Note: Creation of an AV control object of mime type "audio/mp4"

void* HBBTV_JSAVControl_createAudioMpeg ( void )

Creation of an AV control object of mime type "audio/mpeg".

Note: Creation of an AV control object of mime type "audio/mpeg"

void* HBBTV_JSAVControl_createVideoMp4 ( void )

Creation of an AV control object of mime type "video/mp4".

Note: Creation of an AV control object of mime type "video/mp4"

void* HBBTV_JSAVControl_createVideoMpeg ( void )

Creation of an AV control object of mime type "video/mpeg".

Note: Creation of an AV control object of mime type "video/mpeg"

void* HBBTV_JSAVControl_getComponents	(	void *	obj,
		HBBTV_JSAVComponent_Type	component_type
	)

AVComponent[] getComponents, Section 7.16.5.1.3.

Note: AVComponent[] getComponents; DAE Section 7.14.4.1.2

void* HBBTV_JSAVControl_getCurrentActiveComponents	(	void *	obj,
		HBBTV_JSAVComponent_Type	component_type
	)

AVComponent[] getCurrentActiveComponents, Section 7.16.5.1.3.

Note: AVComponent[] getCurrentActiveComponents; DAE Section 7.14.4.1.2

S32BIT HBBTV_JSAVControl_getCurrentTrackIndex ( void * obj )

Number currentTrackIndex [RW], CEA-2014-A Section 5.7.1.f. Playlists are not supported.

Note: Number currentTrackIndex [RW]; CEA-2014-A Section 5.7.1.f

void* HBBTV_JSAVControl_getData ( void * obj )

String data [RW], CEA-2014-A Section 5.7.1.f.

Note: String data [RW]; CEA-2014-A Section 5.7.1.f

S32BIT HBBTV_JSAVControl_getError ( void * obj )

Number error [R], CEA-2014-A Section 5.7.1.f.

Note: Number error [R]; CEA-2014-A Section 5.7.1.f

BOOLEAN HBBTV_JSAVControl_getFullScreen ( void * obj )

readonly Boolean fullScreen, CEA-2014-A Section 5.7.1.g

Note: readonly Boolean fullScreen; CEA-2014-A Section 5.7.1.g

S32BIT HBBTV_JSAVControl_getHeight ( void * obj )

Integer height, CEA-2014-A Section 5.7.1.g.

Note: Integer height; CEA-2014-A Section 5.7.1.g

S32BIT HBBTV_JSAVControl_getNrTracks ( void * obj )

Number nrTracks [R], CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns 1 if the content identified by 'data' has been found and 0 otherwise.

Note: Number nrTracks [R]; CEA-2014-A Section 5.7.1.f

BOOLEAN HBBTV_JSAVControl_getPersist ( void * obj )

Boolean persist [RW], CEA-2014-A Section 5.7.1.f.

Note: Boolean persist [RW]; CEA-2014-A Section 5.7.1.f

U32BIT HBBTV_JSAVControl_getPlayPosition ( void * obj )

Number playPosition [R], CEA-2014-A Section 5.7.1.f.

Note: Number playPosition [R]; CEA-2014-A Section 5.7.1.f

S32BIT HBBTV_JSAVControl_getPlayState ( void * obj )

Number playState [R], CEA-2014-A Section 5.7.1.f.

Note: Number playState [R]; CEA-2014-A Section 5.7.1.f

U32BIT HBBTV_JSAVControl_getPlayTime ( void * obj )

Number playTime [R], CEA-2014-A Section 5.7.1.f.

Note: Number playTime [R]; CEA-2014-A Section 5.7.1.f

S32BIT HBBTV_JSAVControl_getSpeed ( void * obj )

Number speed [R], CEA-2014-A Section 5.7.1.f.

Note: Number speed [R]; CEA-2014-A Section 5.7.1.f

S32BIT HBBTV_JSAVControl_getWidth ( void * obj )

Integer width, CEA-2014-A Section 5.7.1.g.

Note: Integer width; CEA-2014-A Section 5.7.1.g

BOOLEAN HBBTV_JSAVControl_next ( void * obj )

Boolean next(), CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns FALSE.

Note: Boolean next(); CEA-2014-A Section 5.7.1.f

BOOLEAN HBBTV_JSAVControl_play	(	void *	obj,
		S32BIT	speed
	)

Boolean play(Number speed), CEA-2014-A Section 5.7.1.f.

Note: Boolean play(Number speed); CEA-2014-A Section 5.7.1.f

BOOLEAN HBBTV_JSAVControl_previous ( void * obj )

Boolean previous(), CEA-2014-A Section 5.7.1.f. Playlists are not supported, this function returns FALSE.

Note: Boolean previous(); CEA-2014-A Section 5.7.1.f

BOOLEAN HBBTV_JSAVControl_queue	(	void *	obj,
		S_HBBTV_STRING *	url
	)

Boolean queue( String url ), TS102796 v1.2.1, Section A.2.5.

Note: Boolean queue( String url ); TS102796 v1.2.1, Section A.2.5

BOOLEAN HBBTV_JSAVControl_seek	(	void *	obj,
		U32BIT	pos
	)

Boolean seek(Number pos), CEA-2014-A Section 5.7.1.f.

Note: Boolean seek(Number pos); CEA-2014-A Section 5.7.1.f

void HBBTV_JSAVControl_setCache	(	void *	obj,
		BOOLEAN	cache
	)

boolean cache, Section 7.14.10.1. This function is used to set the cache parameter value when it's present in the tag of the <object>.

Note: Sets the cache paramenter as present in the elements of an A/V control object; Section DAE 7.14.10.1

void HBBTV_JSAVControl_setCurrentTrackIndex	(	void *	obj,
		S32BIT	trackIndex
	)

Number currentTrackIndex [RW], CEA-2014-A Section 5.7.1.f. Playlists are not supported.

Note: Number currentTrackIndex [RW]; CEA-2014-A Section 5.7.1.f

void HBBTV_JSAVControl_setData	(	void *	obj,
		S_HBBTV_STRING *	data
	)

String data [RW], CEA-2014-A Section 5.7.1.f.

Note: String data [RW]; CEA-2014-A Section 5.7.1.f

void HBBTV_JSAVControl_setFullScreen	(	void *	obj,
		BOOLEAN	full_screen
	)

void setFullScreen(Boolean fullscreen), CEA-2014-A Section 5.7.1.g

Note: void setFullScreen(Boolean fullscreen); CEA-2014-A Section 5.7.1.g

void HBBTV_JSAVControl_setHeight	(	void *	obj,
		S32BIT	height
	)

Integer height, CEA-2014-A Section 5.7.1.g.

Note: Integer height; CEA-2014-A Section 5.7.1.g

void HBBTV_JSAVControl_setLoop	(	void *	obj,
		S32BIT	loop
	)

loop, Section 7.14.10.1. This function is used to set the loop parameter value when it's present in the tag of the <object>. Value -1 represents 'infinite'.

Note: Sets the loop paramenter as present in the elements of an A/V control object; Section DAE 7.14.10.1

void HBBTV_JSAVControl_setPersist	(	void *	obj,
		BOOLEAN	persist
	)

Boolean persist [RW], CEA-2014-A Section 5.7.1.f. This function only stores the property value but doesn't perform any action, as persist attribute is not currently supported.

Note: Boolean persist [RW]; CEA-2014-A Section 5.7.1.f

void HBBTV_JSAVControl_setPosition	(	void *	obj,
		S32BIT	x,
		S32BIT	y
	)

Sets the object's position on screen.

Parameters

x	Number of pixels from the screen's left margin.
y	Number of pixels from the screen's top margin.

Note: sets the object's horizontal position on screen.; x is the number of pixels from the screen's left margin.

BOOLEAN HBBTV_JSAVControl_setSource	(	void *	obj,
		S_HBBTV_STRING *	id
	)

Boolean setSource( String id ), Section 7.14.7.

Note: Boolean setSource( String id ); 7.14.7

BOOLEAN HBBTV_JSAVControl_setVolume	(	void *	obj,
		S32BIT	volume
	)

Boolean setVolume(Number volume), CEA-2014-A Section 5.7.1.f.

Note: Boolean setVolume(Number volume); CEA-2014-A Section 5.7.1.f

void HBBTV_JSAVControl_setWidth	(	void *	obj,
		S32BIT	width
	)

Integer width, CEA-2014-A Section 5.7.1.g.

Note: Integer width; CEA-2014-A Section 5.7.1.g

BOOLEAN HBBTV_JSAVControl_stop ( void * obj )

Boolean stop(), CEA-2014-A Section 5.7.1.f.

Note: Boolean stop(); CEA-2014-A Section 5.7.1.f

void* HBBTV_JSChannel_getCcid ( void * obj )

readonly readonly String ccid, Section 7.13.11.2

Note: readonly readonly String ccid; Section 7.13.11.2

S32BIT HBBTV_JSChannel_getChannelType ( void * obj )

readonly Integer channelType, Section 7.13.11.2

Note: readonly Integer channelType; Section 7.13.11.2

void* HBBTV_JSChannel_getDsd ( void * obj )

readonly String dsd, Section 7.13.11.2. This string is empty unless the channel has been created by the video/broadcast method createChannelObject(Integer idType, String dsd, Integer sid).

Note: readonly String dsd; Section 7.13.11.2

U16BIT HBBTV_JSChannel_getFreesatServiceID ( void * obj )

readonly Integer freesatServiceID. This property is not part of OIPF Vol. 5. This implements the Channel's freesatServiceID property as defined by Freesat OPAL v1.0, section 14.6.1

Parameters

obj	Channel object

void* HBBTV_JSChannel_getGenre ( void * obj )

readonly StringCollection genre OPAL version 1.3, section 14.4.13.13.4.13

Returns: Collection of string objects

BOOLEAN HBBTV_JSChannel_getHidden ( void * obj )

readonly Boolean hidden. This property is not part of OIPF Vol. 5. This implements the Channel's hidden property as defined by Freesat OPAL v1.0, section 14.6.17

Parameters

obj	Channel object

readonly Boolean hidden. This property is not part of OIPF Vol. 5. This implements the Channel's hidden property as defined by Freesat OPAL v1.0, section 14.6.17

Parameters

obj	Channel object

BOOLEAN HBBTV_JSChannel_getLocked ( void * obj )

readonly Boolean locked, OIPF vol. 5, section 7.13.11.2

Parameters

obj	Channel object

Returns: locked status

S32BIT HBBTV_JSChannel_getMajorChannel ( void * obj )

readonly Integer majorChannel, OIPF vol. 5, section 7.13.11.2

Parameters

obj	Channel object

Returns: Major channel numumber, in the current implementation this is the LCN

void* HBBTV_JSChannel_getName ( void * obj )

readonly String name, Section 7.13.11.2

Note: readonly String name; Section 7.13.11.2

S32BIT HBBTV_JSChannel_getNid ( void * obj )

readonly Integer nid, OIPF vol. 5, section 7.13.11.2

Parameters

obj	Channel object

S32BIT HBBTV_JSChannel_getOnid ( void * obj )

readonly Integer onid, Section 7.13.11.2

Note: readonly Integer onid; Section 7.13.11.2

U16BIT HBBTV_JSChannel_getOpalChannelType ( void * obj )

readonly Integer opalChannelType. This property is not part of OIPF Vol. 5. This implements the Channel's opalChannelType property as defined by Freesat OPAL v1.0, section 14.6.3

Parameters

obj	Channel object

BOOLEAN HBBTV_JSChannel_getRunningStatus ( void * obj )

readonly Boolean runningStatus. This property is not part of OIPF Vol. 5. This implements the Channel's runningStatus property as defined by Freesat OPAL v1.0, section 14.6.15

Parameters

obj	Channel object

readonly Boolean runningStatus. This property is not part of OIPF Vol. 5. This implements the Channel's runningStatus property as defined by Freesat OPAL v1.0, section 14.6.15

Parameters

obj	Channel object

void* HBBTV_JSChannel_getShortName ( void * obj )

readonly String shortName. This property is not part of OIPF Vol. 5. This implements the Channel's shortName property as defined by Freesat Opal v1.0, section 14.6.9

Parameters

obj	Channel object

Returns: String object

readonly String shortName. This property is not part of OIPF Vol. 5. This implements the Channel's shortName property as defined by Freesat Opal v1.0, section 14.6.9

Parameters

obj	Channel object

Returns: String object

S32BIT HBBTV_JSChannel_getSid ( void * obj )

readonly Integer sid, Section 7.13.11.2

Note: readonly Integer sid; Section 7.13.11.2

S32BIT HBBTV_JSChannel_getTsid ( void * obj )

readonly Integer tsid, Section 7.13.11.2

Note: readonly Integer tsid; Section 7.13.11.2

void* HBBTV_JSChannelConfig_getChannelList ( void * obj )

readonly ChannelList channelList, Section 7.13.9.1

Note: readonly ChannelList channelList; Section 7.13.9.1

void* HBBTV_JSChannelConfig_getGenres ( void * obj )

readonly StringCollection genres OPAL version 1.3, section 13.2.2.12.2.2

Returns: Collection of string objects

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

Channel getChannel, Section 7.13.10.2.

Note: readonly Channel channel; Section 7.13.10.2

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

Channel getChannelByTriplet, Section 7.13.10.2.

Note: readonly Integer sid; Section 7.13.11.2

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

void addParentalRating, Section 7.9.5.2

Note: void addParentalRating; Section 7.9.5.2

void* HBBTV_JSCollection_addParentalRatingScheme	(	void *	obj,
		S_HBBTV_STRING *	name,
		S_HBBTV_STRING *	values
	)

ParentalRatingScheme addParentalRatingScheme, Section 7.9.3.2.

Note: ParentalRatingScheme addParentalRatingScheme; Section 7.9.3.2

void* HBBTV_JSCollection_getParentalRatingScheme	(	void *	obj,
		S_HBBTV_STRING *	name
	)

ParentalRatingScheme getParentalRatingScheme, Section 7.9.3.2.

Note: ParentalRatingScheme getParentalRatingScheme; Section 7.9.3.2

void* HBBTV_JSConfig_getCountryId ( void * obj )

String countryId, Section 7.3.2.1. String data is valid only while the Configuration object is valid.

Returns: Handle to JSString object; Handle to JSString object

Note: String countryId; Section 7.3.2.1

void* HBBTV_JSConfig_getPostcode ( void * obj )

readonly String postcode, Freesat OPAL v1.0, section 8.4.1.1.

Parameters

obj	Configure object

Returns: String object

void* HBBTV_JSConfig_getPreferredAudioLang ( void * obj )

String preferredAudioLanguage, Section 7.3.2.1.

Returns: Handle to JSString object; Handle to JSString object

Note: String preferredAudioLanguage; Section 7.3.2.1

void* HBBTV_JSConfig_getPreferredSubtitleLang ( void * obj )

String preferredSubtitleLanguage, Section 7.3.2.1.

Returns: Handle to JSString object; Handle to JSString object

Note: String preferredSubtitleLanguage; Section 7.3.2.1

void* HBBTV_JSConfig_getPreferredUILang ( void * obj )

String preferredUILanguage, Section 7.3.2.1. String data is valid only while the Configuration object is valid.

Returns: Handle to JSString object; Handle to JSString object

Note: String preferredUILanguage; Section 7.3.2.1

S8BIT HBBTV_JSConfig_getSpeechDescriptionEnabled ( void * obj )

readonly Boolean speechDescriptionEnabled, Freesat OPAL v1.0, section 8.4.1.2.

Parameters

obj	Configure object

Returns: -1 if the terminal does not support speech description, 0 if speech description is disabled, 1 if speech description is enabled

U8BIT HBBTV_JSConfig_getTerminalMode ( void * obj )

readonly Integer terminalMode, Freesat OPAL v1.0, section 8.4.1.4

Parameters

obj	Configure object

S8BIT HBBTV_JSConfig_getVoiceControlEnabled ( void * obj )

readonly Boolean voiceControlEnabled, Freesat OPAL v1.0, section 8.4.1.3.

Parameters

obj	Configure object

Returns: -1 if the terminal does not support voice control, 0 if voice control is disabled, 1 if voice control is enabled

S32BIT HBBTV_JSKeySet_getMaximumValue ( void * obj )

readonly Integer maximumValue, Section 7.2.5.2

Note: readonly Integer maximumValue; Section 7.2.5.2

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

readonly Integer otherKeys[].

Parameters

obj	Keyset object
other_keys	Pointer to an array containing the keys mapped to the OTHER mask

Returns: Number of keys in the array.

S32BIT HBBTV_JSKeySet_getValue ( void * obj )

readonly Integer value, Section 7.2.5.2

Note: readonly Integer value; Section 7.2.5.2

S32BIT HBBTV_JSKeySet_setValue	(	void *	obj,
		S32BIT	value
	)

Integer setValue( Integer value, Integer otherKeys[] ), Section 7.2.5.3.

Note: Integer setValue( Integer value ); Section 7.2.5.3

void* HBBTV_JSLocalSystem_getDeviceID ( void * obj )

readonly String deviceID, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void* HBBTV_JSLocalSystem_getFamilyName ( void * obj )

readonly String familyName, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void* HBBTV_JSLocalSystem_getHardwareVersion ( void * obj )

readonly String hardwareVersion, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void* HBBTV_JSLocalSystem_getModelName ( void * obj )

readonly String modelName, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void* HBBTV_JSLocalSystem_getNetworkInterfaces ( void * obj )

readonly NetworkInterfaceCollection networkInterfaces, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: NetworkInterface collection

void* HBBTV_JSLocalSystem_getOipfProfile ( void * obj )

readonly String oipfProfile. This property is not part of OIPF Vol. 5, it implements the LocalSystem oipfProfile property as defined by Freesat Opal v1.0, section 8.5.1.2

Parameters

obj	LocalSystem object

Returns: String object

BOOLEAN HBBTV_JSLocalSystem_getPvrEnabled ( void * obj )

readonly Boolean pvrEnabled, section 7.3.3.1

Parameters

obj	LocalSystem object

BOOLEAN HBBTV_JSLocalSystem_getPvrStatus ( void * obj )

readonly Boolean pvrStatus This property is not part of OIPF Vol. 5, it implements the LocalSystem pvrStatus property as defined by Freesat Opal v1.0, section 8.5.1.3

Parameters

obj	LocalSystem object

void* HBBTV_JSLocalSystem_getSoftwareVersion ( void * obj )

readonly String softwareVersion, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void* HBBTV_JSLocalSystem_getVendorName ( void * obj )

readonly String vendorName, section 7.3.3.1

Parameters

obj	LocalSystem object

Returns: String object

void HBBTV_JSMetadataSearch_addChannelConstraint	(	void *	obj,
		void *	channel
	)

void addChannelConstraint(Channel channel), Section 7.12.2.2

Note: void addChannelConstraint(Channel channel); Section 7.12.2.2

void* HBBTV_JSMetadataSearch_createQuery	(	void *	obj,
		S_HBBTV_STRING *	field,
		HBBTV_JSMetadataSearch_Comparison	comparison,
		S_HBBTV_STRING *	value
	)

Query createQuery(String field, Integer comparison, String value), Section 7.12.2.2.

Returns: Handle to JSQuery

Note: Query createQuery(String field, Integer comparison, String value); Section 7.12.2.2

void HBBTV_JSMetadataSearch_findProgrammesFromStream	(	void *	obj,
		void *	channel,
		U32BIT	start_time
	)

void findProgrammesFromStream ( Channel channel, Integer startTime ), Section 7.12.2.2

Note: void findProgrammesFromStream(Channel channel, Integer startTime); Section 7.12.2.2

void* HBBTV_JSMetadataSearch_getResult ( void * obj )

readonly SearchResults result, Section 7.12.2.1

Returns: Handle to a SearchResult object implementing a Collection. 'length' property and 'item' method can be accessed via the HBBTV_JSCollection API.

Note: readonly SearchResults result; Section 7.12.2.1

HBBTV_JSMetadataSearch_Target HBBTV_JSMetadataSearch_getSearchTarget ( void * obj )

readonly Integer searchTarget, Section 7.12.2.1. Only HBBTV_JSSearchManager_TARGET_SCHEDULED_CONTENT is supported as value for searchTarget (TS102796 v1.2.1 Section A1).

Note: readonly Integer searchTarget; Section 7.12.2.1

void HBBTV_JSMetadataSearch_setQuery	(	void *	obj,
		void *	query
	)

void setQuery(Query query), Section 7.12.2.2

Note: void setQuery(Query query); Section 7.12.2.2

BOOLEAN HBBTV_JSNetworkInterface_getConnected ( void * obj )

readonly Boolean connected, section 7.3.4.1

Parameters

obj	NetworkInterface object

BOOLEAN HBBTV_JSNetworkInterface_getEnabled ( void * obj )

readonly Boolean enabled, section 7.3.4.1

Parameters

obj	NetworkInterface object

void* HBBTV_JSNetworkInterface_getIpAddress ( void * obj )

readonly String ipAddress, section 7.3.4.1

Parameters

obj	NetworkInterface object

Returns: String object

void* HBBTV_JSNetworkInterface_getMacAddress ( void * obj )

readonly String macAddress, section 7.3.4.1

Parameters

obj	NetworkInterface object

Returns: String object

void HBBTV_JSObject_addObjectReference	(	void *	obj,
		void *	reference
	)

Add a new reference to the list of references associated with this object. A reference is usually the pointer to an object in the JS extensions associated with this HbbTV engine object. Multiple JS object can be associated to one HbbTV engine object. This function can be blocking while other calls related to references for the same HbbTV engine object are being called.

Parameters

obj	The HbbTV engine object
reference	The reference associated to this object.

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

Retrieves the list of references associated with this object. The HbbTV engine allocates the memory and return the pointers to the list nd to the number of elements it contains. The list will have to be freed with a call to HBBTV_JSObject_releaseObjectReferences. This function can be blocking while other calls related to references for the same HbbTV engine object are being called.

Parameters

obj	The HbbTV engine object
references	Pointer to the list of references allocated and returned by the HbbTV engine
number	Pointer to the number of elements contained in the returned list

void* HBBTV_JSObject_incref ( void * obj )

Increases reference count of an object.

Parameters

object The object

Returns: The object after increasing the reference count

Increases reference count of an object.

Parameters

object - the object

Returns: The object after increasing the reference count

void HBBTV_JSObject_release ( void * obj )

Releases an object.

Parameters

obj	The object to release

Releases an object.

Parameters

object - the object to release

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

Releases a list of references returned by HBBTV_JSObject_getObjectReferences. This function can be blocking while other calls related to references for the same HbbTV engine object are being called.

Parameters

obj	The HbbTV engine object
references	The list of references to be freed

void HBBTV_JSObject_removeObjectReference	(	void *	obj,
		void *	reference
	)

Removes a reference from the list of references associated to this object. A reference is usually removed when a JS object associated with a HbbTV engine object is destroyed. This function can be blocking while other calls related to references for the same HbbTV engine object are being called.

Parameters

obj	The HbbTV engine object
reference	The reference to be removed.

HBBTV_JSObjType_CONST HBBTV_JSObject_type ( void * obj )

Returns type of object - can use with collection class.

Parameters

obj	the object

Returns type of object - can use with collection class.

Parameters

obj	- the object

void* HBBTV_JSOipfAppMgr_getOwnerApp	(	void *	obj,
		S_HBBTV_STRING *	url
	)

Application getOwnerApplication( Document document ), Section 7.2.1.2.

Note: Application getOwnerApplication( Document document ); Section 7.2.1.2

U8BIT HBBTV_JSOipfCapabilities_getExtraHDVideoDecodes ( void * obj )

readonly Number extraHDVideoDecodes, Section 7.15.3.1. This property is not implemented and returns 0.

Returns: number of additional decoders for SD video

Note: readonly Number extraHDVideoDecodes; Section 7.15.3.1; This property is not implemented and returns 0

Returns: number of additional decoders for SD video

U8BIT HBBTV_JSOipfCapabilities_getExtraSDVideoDecodes ( void * obj )

readonly Number extraSDVideoDecodes, Section 7.15.3.1. This property is not implemented and returns 0.

Returns: number of additional decoders for SD video

Note: readonly Number extraSDVideoDecodes; Section 7.15.3.1; This property is not implemented and returns 0

Returns: number of additional decoders for SD video

void* HBBTV_JSOipfCapabilities_getXmlCapabilities ( void * obj )

readonly Document xmlCapabilities, Section 7.15.3.1

Returns: Handle to a string containg the XML that describes the capabilities.

Note: readonly Document xmlCapabilities; Section 7.3.1.1

BOOLEAN HBBTV_JSOipfCapabilities_hasCapability	(	void *	obj,
		S_HBBTV_STRING *	profileName
	)

Boolean hasCapability( String profileName ), Section 7.15.3.2.

Note: Boolean hasCapability( String profileName ); Section 7.15.3.2

void* HBBTV_JSOipfConfig_getConfig ( void * obj )

readonly Configuration configuration, Section 7.3.1.1

Note: readonly Configuration configuration; Section 7.3.1.1

void* HBBTV_JSOipfConfig_getLocalSystem ( void * obj )

readonly LocalSystem localSystem, Section 7.3.1.1

Parameters

obj	OipfConfiguration object

Returns: LocalSystem object

readonly LocalSystem localSystem, Section 7.3.1.1

Parameters

obj	OipfConfiguration object

Returns: LocalSystem object

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

String sendDRMMessage( String msgType, String msg, String DRMSystemID ), section 7.6.1.2.

Returns: String object

void* HBBTV_JSOipfObjFactory_createAppMgrObject ( void )

Object createApplicationManagerObject(), Section 7.1.1.2.

Note: Object createApplicationManagerObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createCapabilitiesObject ( void )

Object createCapabilitiesObject(), Section 7.1.1.2.

Note: Object createCapabilitiesObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createConfigObject ( void )

Object createConfigurationObject(), Section 7.1.1.2.

Note: Object createConfigurationObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createParentalControlMgrObject ( void )

Object createParentalControlManagerObject(), Section 7.1.1.2.

Note: Object createParentalControlManagerObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createRecordingSchedulerObject ( void )

Object createRecordingSchedulerObject(), Section 7.1.1.2.

Note: Object createRecordingSchedulerObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createSearchManagerObject ( void )

Object createSearchManagerObject(), Section 7.1.1.2.

Note: Object createSearchManagerObject(); Section 7.1.1.2

void* HBBTV_JSOipfObjFactory_createVideoBroadcastObject ( void )

HTMLObjectElement createVideoBroadcastObject(), Section 7.1.1.1.

Note: HTMLObjectElement createVideoBroadcastObject(); Section 7.1.1.1

void* HBBTV_JSOipfObjFactory_createVideoMpegObject ( void )

HTMLObjectElement createVideoMpegObject(), Section 7.1.1.1.

Note: HTMLObjectElement createVideoMpegObject(); Section 7.1.1.1

BOOLEAN HBBTV_JSOipfObjFactory_isObjSupported ( S_HBBTV_STRING * mime_type )

Boolean isObjectSupported( String mimeType ), Section 7.1.1.

Note: Boolean isObjectSupported( String mimeType ); Section 7.1.1

void* HBBTV_JSOipfParentalControlMgr_getParentalRatingSchemes ( void * obj )

readonly ParentalRatingSchemeCollection parentalRatingSchemes, Section 7.9.1.1

Note: readonly ParentalRatingSchemeCollection parentalRatingSchemes; Section 7.9.1.1

void* HBBTV_JSOipfRecordingScheduler_createProgrammeObject ( void * obj )

Programme createProgrammeObject(), Section 7.10.1.1.

Note: Programme createProgrammeObject(); Section 7.10.1.1

void* HBBTV_JSOipfRecordingScheduler_getChannelConfig ( void * obj )

ChannelConfig getChannelConfig(), Section 7.10.1.1.

Note: ChannelConfig getChannelConfig(); Section 7.10.1.1

void* HBBTV_JSOipfRecordingScheduler_getRecordings ( void * obj )

readonly ScheduledRecordingCollection recordings, Section 7.10.4.1

Note: readonly ScheduledRecordingCollection recordings; Section 7.10.4.1

void* HBBTV_JSOipfRecordingScheduler_getScheduledRecordings ( void * obj )

ScheduledRecordingCollection getScheduledRecordings(), Section 7.10.1.1.

Note: ScheduledRecordingCollection getScheduledRecordings(); Section 7.10.1.1

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

ScheduledRecording record( Programme programme ), Section 7.10.1.1.

Note: ScheduledRecording record( Programme programme ); Section 7.10.1.1

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

ScheduledRecording recordAt( Integer startTime, Integer duration, Integer repeatDays, String channelID ), Section 7.10.1.1.

Note: ScheduledRecording recordAt( Integer startTime, Integer duration, Integer repeatDays, String channelID ); Section 7.10.1.1

void HBBTV_JSOipfRecordingScheduler_remove	(	void *	obj,
		void *	scheduled_recording
	)

void remove( ScheduledRecording recording ), Section 7.10.1.1

Note: void remove( ScheduledRecording recording ); Section 7.10.1.1

void* HBBTV_JSOipfSearchManager_createSearch	(	void *	obj,
		HBBTV_JSMetadataSearch_Target	search_target
	)

createSearch, Section 7.12.1.2. Only HBBTV_JSMetadataSearch_TARGET_SCHEDULED_CONTENT is supported as value for searchTarget (TS102796 v1.2.1 Section A1).

Returns: Handle to JSMetadataSearch object

Note: MetadataSearch createSearch(Integer searchTarget); Section 7.12.1.2

void* HBBTV_JSOipfSearchManager_getChannelConfig ( void * obj )

ChannelConfig getChannelConfig, Section 7.12.1.2.

Returns: Handle to JSChannelConfig

Note: ChannelConfig getChannelConfig(); Section 7.12.1.2

U32BIT HBBTV_JSParentalRating_getLabels ( void * obj )

Integer labels, Section 7.9.4.1.

Note: Integer labels; Section 7.9.4.1

void* HBBTV_JSParentalRating_getName ( void * obj )

String name, Section 7.9.4.1.

Note: String name; Section 7.9.4.1

void* HBBTV_JSParentalRating_getRegion ( void * obj )

String region, Section 7.9.4.1.

Note: String region; Section 7.9.4.1

void* HBBTV_JSParentalRating_getScheme ( void * obj )

String scheme, Section 7.9.4.1.

Note: String scheme; Section 7.9.4.1

U32BIT HBBTV_JSParentalRating_getValue ( void * obj )

Integer value, Section 7.9.4.1.

Note: Integer encrypted; Section 7.9.4.1

U32BIT HBBTV_JSParentalRatingScheme_getLength ( void * obj )

readonly Integer length, Section 7.9.2.1

Note: readonly Integer length; Section 7.9.2.1

void* HBBTV_JSParentalRatingScheme_getName ( void * obj )

readonly String name, Section 7.9.2.1

Note: readonly String name; Section 7.9.2.1

void* HBBTV_JSParentalRatingScheme_getThreshold ( void * obj )

readonly ParentalRating threshold, Section 7.9.2.1

Note: readonly ParentalRating threshold; Section 7.9.2.1

void* HBBTV_JSParentalRatingScheme_iconUri	(	void *	obj,
		U32BIT	index
	)

String iconUri, Section 7.9.2.2.

Note: String iconUri; Section 7.9.2.2

S32BIT HBBTV_JSParentalRatingScheme_indexOf	(	void *	obj,
		S_HBBTV_STRING *	ratingValue
	)

Integer indexOf, Section 7.9.2.2.

Note: Integer indexOf; Section 7.9.2.2

void* HBBTV_JSParentalRatingScheme_item	(	void *	obj,
		U32BIT	index
	)

String item, Section 7.9.2.2.

Note: String item; Section 7.9.2.2

void* HBBTV_JSProgramme_getAudioLanguages ( void * obj )

readonly StringCollection audioLanguages, Freesat OPAL v1.0, section 17.2.14

Parameters

obj	Programme object

Returns: String collection object

U32BIT HBBTV_JSProgramme_getAudioType ( void * obj )

readonly Integer audioType, section 7.10.5.1, extended by Freesat OPAL v1.0, section 17.2.10.

void* HBBTV_JSProgramme_getChannelID ( void * obj )

String channelID, Section 7.16.2.2.

Note: String channelID; Section 7.16.2.2

void* HBBTV_JSProgramme_getCRIDS ( void * obj )

readonly StringCollection CRIDS, Freesat OPAL v1.0, section 17.2.27

Parameters

obj	Programme object

Returns: String collection object

void* HBBTV_JSProgramme_getDescription ( void * obj )

String description, Section 7.16.2.2.

Note: String description; Section 7.16.2.2

U32BIT HBBTV_JSProgramme_getDuration ( void * obj )

Integer duration, Section 7.16.2.2.

Note: Integer duration; Section 7.16.2.2

void* HBBTV_JSProgramme_getGenre ( void * obj )

readonly StringCollection genre, Freesat OPAL v1.0, section 17.2.12

Parameters

obj	Programme object

Returns: String collection object

void* HBBTV_JSProgramme_getGuidance ( void * obj )

readonly StringCollection guidance, Freesat OPAL v1.0, section 17.2.24

Parameters

obj	Programme object

Returns: String collection object

BOOLEAN HBBTV_JSProgramme_getHasHDSimulcast ( void * obj )

readonly Boolean hasHDSimulcast, Freesat OPAL v1.0, section 17.2.25

Parameters

obj	Programme object

BOOLEAN HBBTV_JSProgramme_getHasRecording ( void * obj )

readonly Boolean hasRecording, section 7.16.2.3.1

Parameters

obj	Programme object

void* HBBTV_JSProgramme_getLongDescription ( void * obj )

String longDescription, Section 7.16.2.2.

Note: String longDescription; Section 7.16.2.2

void* HBBTV_JSProgramme_getMediaAssets ( void * obj )

readonly StringCollection mediaAssets[], Freesat OPAL v1.0, section 17.2.21

Parameters

obj	Programme object

Returns: Collection object containing string collections

void* HBBTV_JSProgramme_getName ( void * obj )

String name, Section 7.16.2.2.

Note: String name; Section 7.16.2.2

void* HBBTV_JSProgramme_getParentalRatings ( void * obj )

readonly ParentalRatingCollection parentalRatings, Section 7.16.2.2

Note: readonly ParentalRatingCollection parentalRatings; Section 7.16.2.2

U32BIT HBBTV_JSProgramme_getProgrammeIDType ( void * obj )

Integer programmeIDType, Section 7.16.2.2.

Note: Integer programmeIDType; Section 7.16.2.2

void* HBBTV_JSProgramme_getPromotionalContentText ( void * obj )

readonly String promotionalContentText, Freesat OPAL v1.0, section 17.2.22

Parameters

obj	Programme object

Returns: String object

void* HBBTV_JSProgramme_getRecording ( void * obj )

readonly ScheduledRecording recording, section 7.16.2.5

Parameters

obj	Programme object

Returns: ScheduledRecording object

void* HBBTV_JSProgramme_getSIDescriptors	(	void *	obj,
		S32BIT	desc_tag_id,
		S32BIT	ext_desc_tag_id
	)

StringCollection getSIDescriptors, Section 7.16.2.4.

Note: StringCollection getSIDescriptors; Section 7.16.2.4

U32BIT HBBTV_JSProgramme_getStartTime ( void * obj )

Integer startTime, Section 7.16.2.2.

Note: Integer startTime; Section 7.16.2.2

void* HBBTV_JSQuery_and	(	void *	obj,
		void *	query2
	)

Query and( Query query ), Section 7.12.3.2.

Note: Query and(Query); Section 7.12.3.2

void* HBBTV_JSQuery_not ( void * obj )

Query not( ), Section 7.12.3.2.

Note: Query not; Section 7.12.3.2

void* HBBTV_JSQuery_or	(	void *	obj,
		void *	query2
	)

Query or( Query query ), Section 7.12.3.2.

Note: Query or(Query); Section 7.12.3.2

void* HBBTV_JSScheduledRecording_getChannel ( void * obj )

readonly Channel channel, Section 7.10.2.2

Note: readonly Channel channel; Section 7.10.2.2

void* HBBTV_JSScheduledRecording_getDescription ( void * obj )

String description, Section 7.10.2.2.

Note: String description; Section 7.10.2.2

U32BIT HBBTV_JSScheduledRecording_getDuration ( void * obj )

readonly Integer duration, Section 7.10.2.2

Note: readonly Integer duration; Section 7.10.2.2

S32BIT HBBTV_JSScheduledRecording_getEndPadding ( void * obj )

Integer endPadding, Section 7.10.2.2.

Note: Integer endPadding; Section 7.10.2.2

void* HBBTV_JSScheduledRecording_getId ( void * obj )

readonly String id, Section 7.10.5.1. Returns a pointer to a string object if called on a Recording object, NULL otherwise.

Note: readonly String id; Section 7.10.5.1; Returns a pointer to a string object if called on a Recording object, NULL otherwise

void* HBBTV_JSScheduledRecording_getName ( void * obj )

String name, Section 7.10.2.2.

Note: String name; Section 7.10.2.2

void * HBBTV_JSScheduledRecording_getParentalRatings ( void * obj )

readonly ParentalRatingCollection parentalRatings, Section 7.10.2.2

Note: readonly ParentalRatingCollection parentalRatings; Section 7.10.2.2

U32BIT HBBTV_JSScheduledRecording_getRecordingDuration ( void * obj )

readonly Integer recordingDuration, Section 7.10.5.1

Note: readonly Integer recordingDuration; Section 7.10.5.1

U32BIT HBBTV_JSScheduledRecording_getRecordingStartTime ( void * obj )

readonly Integer recordingStartTime, Section 7.10.5.1

Note: readonly Integer recordingStartTime; Section 7.10.5.1

S32BIT HBBTV_JSScheduledRecording_getStartPadding ( void * obj )

Integer startPadding, Section 7.10.2.2.

Note: Integer startPadding; Section 7.10.2.2

U32BIT HBBTV_JSScheduledRecording_getStartTime ( void * obj )

readonly Integer startTime, Section 7.10.2.2

Note: readonly Integer startTime; Section 7.10.2.2

HBBTV_JSScheduledRecording_STATE HBBTV_JSScheduledRecording_getState ( void * obj )

readonly Integer state, Section 7.10.2.2

Note: readonly Integer state; Section 7.10.2.2

void HBBTV_JSScheduledRecording_setDescription	(	void *	obj,
		S_HBBTV_STRING *	description
	)

String description, Section 7.10.2.2.

Note: String description; Section 7.10.2.2

void HBBTV_JSScheduledRecording_setEndPadding	(	void *	obj,
		S32BIT	end_padding
	)

Integer endPadding, Section 7.10.2.2.

Note: Integer endPadding; Section 7.10.2.2

void HBBTV_JSScheduledRecording_setName	(	void *	obj,
		S_HBBTV_STRING *	name
	)

String name, Section 7.10.2.2.

Note: String name; Section 7.10.2.2

void HBBTV_JSScheduledRecording_setStartPadding	(	void *	obj,
		S32BIT	start_padding
	)

Integer startPadding, Section 7.10.2.2.

Note: Integer startPadding; Section 7.10.2.2

void HBBTV_JSSearchResults_abort ( void * obj )

void abort( ), Section 7.12.4.2

Note: void abort(); Section 7.12.4.2

U32BIT HBBTV_JSSearchResults_getOffset ( void * obj )

readonly Integer offset, Section 7.12.4.1

Note: readonly Integer offset; Section 7.12.4.1

BOOLEAN HBBTV_JSSearchResults_getResults	(	void *	obj,
		U32BIT	offset,
		U32BIT	count
	)

Boolean getResults( Integer offset, Integer count ), Section 7.12.4.2.

Note: Boolean getResults(Integer offset, Integer count); Section 7.12.4.2

U32BIT HBBTV_JSSearchResults_getTotalSize ( void * obj )

readonly Integer totalSize, Section 7.12.4.1

Note: readonly Integer totalSize; Section 7.12.4.1

U16BIT* HBBTV_JSString_getString16 ( void * obj )

Returns a string in HbbTV UTF-16 format, with conversion taking place if necessary.

Parameters

obj	String object

Returns: UTF-16 format string which should be released using HBBTV_JSString_releaseString

Returns a string in HbbTV UTF-16 format, with conversion taking place if necessary.

Parameters

obj	- string object

Returns: UTF-16 format string which should be released using HBBTV_JSString_releaseString

U8BIT* HBBTV_JSString_getString8 ( void * obj )

Returns a string in HbbTV UTF-8 format, with conversion taking place if necessary.

Parameters

obj	string object

Returns: UTF-8 format string which should be released using HBBTV_JSString_releaseString

Returns a string in HbbTV UTF-8 format, with conversion taking place if necessary.

Parameters

obj	- string object

Returns: UTF-8 format string which should be released using HBBTV_JSString_releaseString

S_HBBTV_STRING HBBTV_JSString_getValue ( void * obj )

Return string's value. The value is only valid while the string object is valid.

Parameters

string The string object

Returns: The string's value

Return string's value. The value is only valid while the string object is valid.

Parameters

string - the string object

Returns: The string's value

Note: The value is only valid while the string object is valid

void HBBTV_JSString_releaseString ( U8BIT * utf_string )

Releases a UTF-8 or UTF-16 string obtained using HBBTV_JSString_getStringX.

Parameters

string UTF string

Releases a UTF-8 or UTF-16 string obtained using HBBTV_JSString_getStringX.

Parameters

string - string

U32BIT HBBTV_JSString_strlen ( void * obj )

Returns the number of characters in the string.

Parameters

obj	String object

Returns: Number of characters in the string

U32BIT HBBTV_JSString_utf8ByteLen ( void * obj )

Returns byte length of UTF-8 string (conversion may be needed). This would be used prior to calling HBBTV_JSString_utf8CopyData().

Parameters

obj	string object

Returns: UTF-8 format string length

Returns byte length of UTF-8 string (conversion may be needed). This would be used prior to calling HBBTV_JSString_utf8CopyData().

Parameters

obj	- string object

Returns: UTF-8 format string length

void HBBTV_JSString_utf8CopyData	(	void *	obj,
		U8BIT *	output
	)

Fills output of UTF-8 string, (conversion may be needed). This would be used after calling HBBTV_JSString_utf8ByteLen().

Parameters

obj	string object
output	Output buffer to copy UTF-8 data

Fills output of UTF-8 string, (conversion may be needed). This would be used after calling HBBTV_JSString_utf8ByteLen().

Parameters

obj	- string object
output	- output buffer to copy UTF-8 data

BOOLEAN HBBTV_JSVideoBroadcast_addStreamEventListener	(	void *	obj,
		S_HBBTV_STRING	url,
		S_HBBTV_STRING	name,
		U32BIT	listener_id
	)

void addStreamEventListener, TS 102796, Section 8.2.1.1

Note: void addStreamEventListener; TS 102796, section 8.2.1.1

void HBBTV_JSVideoBroadcast_bindToCurrentChannel ( void * obj )

void bindToCurrentChannel(), Section 7.13.1.3

Note: void bindToCurrentChannel(); Section 7.13.1.3

void* HBBTV_JSVideoBroadcast_createChannelObject	(	void *	obj,
		S32BIT	id_type,
		S_HBBTV_STRING *	dsd,
		S32BIT	sid
	)

Channel createChannelObject(Integer idType, String dsd, Integer sid), Section 7.13.1.3. Although dsd property of the channel object is defined as ISO Latin1, the HbbTV engine expects dsd to be UTF-8 encoded as Latin1 is not supported.

Note: Channel createChannelObject(Integer idType, String dsd, Integer sid); Section 7.13.1.3

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

Channel createChannelObject(Integer idType, Integer onid, Integer tsid, Integer sid, Integer sourceID, String ipBroadcastID), Section 7.13.1.3.

Note: Channel createChannelObject(Integer idType, Integer onid, Integer tsid, Integer sid, Integer sourceID, String ipBroadcastID); Section 7.13.1.3

void* HBBTV_JSVideoBroadcast_getChannelConfig ( void * obj )

ChannelConfig getChannelConfig(), Section 7.13.1.3.

Note: ChannelConfig getChannelConfig(); Section 7.13.1.3

void* HBBTV_JSVideoBroadcast_getComponents	(	void *	obj,
		HBBTV_JSAVComponent_Type	type
	)

AVComponentCollection getComponents, Section 7.16.5.1.3. HBBTV_JSAVComponent_TYPE_UNKNOWN is used for parameter 'type' for values null or undefined in javascript.

Note: AVComponentCollection getComponents; Section 7.16.5.1.3

void* HBBTV_JSVideoBroadcast_getCurrentActiveComponents	(	void *	obj,
		HBBTV_JSAVComponent_Type	type
	)

AVComponentCollection getCurrentActiveComponents, Section 7.16.5.1.3.

Note: AVComponentCollection getCurrentActiveComponents; Section 7.16.5.1.3

void* HBBTV_JSVideoBroadcast_getCurrentChannel ( void * obj )

readonly Channel currentChannel, Section 7.13.7.1

Note: readonly Channel currentChannel; Section 7.13.7.1

void* HBBTV_JSVideoBroadcast_getData ( void * obj )

String data, Section 7.13.1.2.

Note: String data; Section 7.13.1.2

BOOLEAN HBBTV_JSVideoBroadcast_getFullScreen ( void * obj )

readonly Boolean fullScreen, Section 7.13.1.2

Note: readonly Boolean fullScreen; Section 7.13.1.2

S32BIT HBBTV_JSVideoBroadcast_getHeight ( void * obj )

Integer height, Section 7.13.1.2.

Note: Integer height; Section 7.13.1.2

U32BIT HBBTV_JSVideoBroadcast_getPlayPosition ( void * obj )

readonly Integer playPosition, Section 7.13.2.2

Note: readonly Integer playPosition; 7.13.2.2

float HBBTV_JSVideoBroadcast_getPlaySpeed ( void * obj )

readonly Number playSpeed, Section 7.13.2.2

Note: readonly Number playSpeed; 7.13.2.2

E_HBBTV_BROADCAST_STATE HBBTV_JSVideoBroadcast_getPlayState ( void * obj )

Integer playState, Section 7.13.1.2.

Note: Integer playState; Section 7.13.1.2

void* HBBTV_JSVideoBroadcast_getProgrammes ( void * obj )

readonly ProgrammeCollection programmes, Section 7.13.3

Note: readonly ProgrammeCollection programmes; Section 7.13.3

HBBTV_JSVideoBroadcast_RECORDING_STATE HBBTV_JSVideoBroadcast_getRecordingState ( void * obj )

readonly Integer recordingState, Section 7.13.2.2

Note: readonly Integer recordingState; 7.13.2.2

S32BIT HBBTV_JSVideoBroadcast_getWidth ( void * obj )

Integer width, Section 7.13.1.2.

Note: Integer width; Section 7.13.1.2

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

Note: void addStreamEventListener; TS 102796, section 8.2.1.1

void HBBTV_JSVideoBroadcast_nextChannel ( void * obj )

void nextChannel(), Section 7.13.1.3

Note: void nextChannel(); Section 7.13.1.3

void HBBTV_JSVideoBroadcast_prevChannel ( void * obj )

void prevChannel(), Section 7.13.1.3

Note: void prevChannel(); Section 7.13.1.3

void* HBBTV_JSVideoBroadcast_recordNow	(	void *	obj,
		S32BIT	duration
	)

void recordNow, section 7.13.2.3

Parameters

obj	Pointer to the video broadcast object
duration	Duration of the recording in seconds
obj	Video broadcast object
duration	Duration of the recording in seconds

void HBBTV_JSVideoBroadcast_release ( void * obj )

void release(), Section 7.13.1.3

Note: void release(); Section 7.13.1.3

BOOLEAN HBBTV_JSVideoBroadcast_removeStreamEventListener	(	void *	obj,
		S_HBBTV_STRING	name,
		U32BIT	listener_id
	)

void removeStreamEventListener, TS 102796, Section 8.2.1.1

Note: void removeStreamEventListener; TS 102796, section 8.2.1.1

void HBBTV_JSVideoBroadcast_setChannel	(	void *	obj,
		void *	channel,
		BOOLEAN	trickplay,
		S_HBBTV_STRING *	content_access_desc_url
	)

void setChannel(Channel channel, Boolean trickplay, String contentAccessDescriptorURL), Section 7.13.1.3

Note: void setChannel(Channel channel, Boolean trickplay, String contentAccessDescriptorURL); Section 7.13.1.3

void HBBTV_JSVideoBroadcast_setData	(	void *	obj,
		S_HBBTV_STRING *	data
	)

String data, Section 7.13.1.2.

Note: String data; Section 7.13.1.2

void HBBTV_JSVideoBroadcast_setFullScreen	(	void *	obj,
		BOOLEAN	full_screen
	)

void setFullScreen(Boolean fullscreen), Section 7.13.1.3

Note: void setFullScreen(Boolean fullscreen); Section 7.13.1.3

void HBBTV_JSVideoBroadcast_setHeight	(	void *	obj,
		S32BIT	height
	)

Integer height, Section 7.13.1.2.

Note: Integer height; Section 7.13.1.2

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

Changes the video position and dimensions at once.

Parameters

obj	Video/broadcast object
x	New horizontal position of the top left corner
y	New vertical position of the top left corner
width	New width
height	New height

void HBBTV_JSVideoBroadcast_setWidth	(	void *	obj,
		S32BIT	width
	)

Integer width, Section 7.13.1.2.

Note: Integer width; Section 7.13.1.2

void HBBTV_JSVideoBroadcast_stop ( void * obj )

void stop(), Section 7.13.1.3

Note: void stop(); Section 7.13.1.3

void HBBTV_JSVideoBroadcast_stopRecording ( void * obj )

void stopRecording(), sectuion 7.13.2.3

Parameters

obj	Video broadcast object

void stopRecording(), sectuion 7.13.2.3

Parameters

obj	Video broadcast object

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation