ToiHdmiService

Method Summary

getCecDevices ( ) → Array.<ToiHdmiService.ToiCecInfo>	Discovers other devices which are connected to the CEC bus.
getCecFeatures ( ) → Array.<ToiHdmiService.ToiCecFeatureInfo>	All CEC features that can be enabled (by the current HW/configuration) are returned.
getSinkInfo ( ) → sinkInfo	Returns the HDMI sink information.
sendCecUserControlPressed ( destination , uiCommand )	Used for CEC remote control pass through when the remote control buttons are pressed.
sendCecUserControlReleased ( destination )	This method is used for the CEC remote control pass through. The application shall call this method when the remote control button is released. It sends "User control released" to the HDMI sink.
sendCecWakeup ( destination )	This method shall be used to take advantage of the One Touch Play feature. It will wake up the attached HDMI sink and tell it to use the STB as the active source.
setCecFeatures ( features )	The method is used to enable or disable CEC features. It shall only change the provided features.

Inherited Methods

addEventListener ( type , listener )	This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.
removeEventListener ( type , listener )	This method removes an event listener for a specific event.

Type Definitions

ToiCecFeature (Type: enum)
CEC feature definition.
CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH_FOLLOWER CEC_FEATURE_SYSTEM_STANDBY CEC_FEATURE_SYSTEM_STANDBY_FOLLOWER

ToiCecLogicalAddress (Type: enum)
Defines the CEC logical address as specified in CEC Table 5 in HDMI specification version 1.4a.
CEC_LOGICAL_ADDRESS_AUDIOSYS CEC_LOGICAL_ADDRESS_BROADCAST CEC_LOGICAL_ADDRESS_PLAYBACK1 CEC_LOGICAL_ADDRESS_PLAYBACK2 CEC_LOGICAL_ADDRESS_PLAYBACK3 CEC_LOGICAL_ADDRESS_RECORDER1 CEC_LOGICAL_ADDRESS_RECORDER2 CEC_LOGICAL_ADDRESS_RECORDER3 CEC_LOGICAL_ADDRESS_SPECIALUSE CEC_LOGICAL_ADDRESS_TUNER1 CEC_LOGICAL_ADDRESS_TUNER2 CEC_LOGICAL_ADDRESS_TUNER3 CEC_LOGICAL_ADDRESS_TUNER4 CEC_LOGICAL_ADDRESS_TV

ToiCecUiCommand (Type: enum)
Remote control pass through user interface command.
CEC_UICOMMAND_MUTE CEC_UICOMMAND_VOLUME_DOWN CEC_UICOMMAND_VOLUME_UP

ToiConnectionStatus (Type: enum)
HDMI connection status information.
CONNECTION_STATUS_CONNECTED CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN CONNECTION_STATUS_DISCONNECTED CONNECTION_STATUS_UNKNOWN

ToiHdcpStatus (Type: enum)
The HDCP status information.
HDCP_STATUS_DISABLED HDCP_STATUS_ERROR HDCP_STATUS_INITIALIZING HDCP_STATUS_NON_COMPLIANT_DEVICE HDCP_STATUS_NON_COMPLIANT_REPEATER HDCP_STATUS_OK HDCP_STATUS_ON_REVOCATION_LIST HDCP_STATUS_REPEATER_ERROR HDCP_STATUS_REPEATER_OK HDCP_STATUS_REPEATER_TOPOLOGY_ERROR

Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Inherited From:

ToiEventTarget#addEventListener

Parameters:

Name	Type	Description
`type`	number	The event type of the event to subscribe to.
`listener`	ToiEventListener	The JavaScript function that will receive events.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.

getCecDevices ( ) → Array.<ToiHdmiService.ToiCecInfo>

This method is used for the application to know what other devices that are connected to the CEC bus.

Throws:

ToiOperationNotSupportedException

Raised if the STB does not support CEC.

Returns:

The information list of the CEC devices which are connected to the CEC bus.

Type: Array.<ToiHdmiService.ToiCecInfo>

getCecFeatures ( ) → Array.<ToiHdmiService.ToiCecFeatureInfo>

The method is used to check the status of the CEC features. All CEC features that can be enabled (by current HW/configuration) are returned.

Returns:: The status of all the features that the STB supports.

Type: Array.<ToiHdmiService.ToiCecFeatureInfo>

getSinkInfo ( ) → sinkInfo

Returns the HDMI sink information.

Returns:: The HDMI sink information.

Type: ToiHdmiService.ToiSinkInfo

removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Inherited From:

ToiEventTarget#removeEventListener

Parameters:

Name	Type	Description
`type`	number	The event type of the event to remove the listener from.
`listener`	ToiEventListener	The JavaScript function that was previously added as an event listener.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener has not previously been added.

sendCecUserControlPressed ( destination , uiCommand )

This method is used for the CEC remote control pass through when the remote control button is pressed. It sends "User control pressed" and remote control UI command to the HDMI sink. When the user presses and holds the same remote control button for a long time, the application shall call ToiHdmiService#sendCecUserControlPressed with the same UI command repeatedly. In this case, the application need not call ToiHdmiService#sendCecUserControlReleased, but it shall call ToiHdmiService#sendCecUserControlReleased immediately when the user releases the key.

Parameters:

Name	Type	Description
`destination`	ToiHdmiService.ToiCecLogicalAddress	The CEC logical address of destination.
`uiCommand`	ToiHdmiService.ToiCecUiCommand	The user interface command.

Throws:

ToiInvalidArgumentException	Raised if the uicommand is invalid.
ToiInvalidPreconditionException	Raised if HDMI is disconnected.
ToiOperationNotSupportedException	Raised if the STB does not support CEC or the feature is not supported.

sendCecUserControlReleased ( destination )

This method is used for the CEC remote control pass through. The application shall call this method when the remote control button is released. It sends "User control released" to the HDMI sink.

Parameters:

Name	Type	Description
`destination`	ToiHdmiService.ToiCecLogicalAddress	The CEC logical address of destination.

Throws:

ToiInvalidPreconditionException	Raised if HDMI is disconnected.
ToiOperationNotSupportedException	Raised if the STB does not support CEC or the feature is not supported.

sendCecWakeup ( destination )

This method shall be used to take advantage of the One Touch Play feature. It will wake up the attached HDMI sink and tell it to use the STB as the active source.

Parameters:

Name	Type	Description
`destination`	ToiHdmiService.ToiCecLogicalAddress	The CEC logical address of destination.

Throws:

ToiInvalidPreconditionException	Raised if HDMI is disconnected.
ToiOperationNotSupportedException	Raised if the STB does not support CEC.

setCecFeatures ( features )

The method is used to enable or disable CEC features. It shall only change the provided features.

Parameters:

Name	Type	Description
`features`	Array.<ToiHdmiService.ToiCecFeatureInfo> (Or a single ToiHdmiService.ToiCecFeatureInfo.)	The features to be enabled or disabled. A single element can be passed directly and does not need to be passed in an array.

Throws:

ToiInvalidArgumentException	Raised if any of the features is invalid.
ToiOperationNotSupportedException	Raised if the STB does not support one or more of the provided CEC features.

Members

ON_CEC_ACTIVE_REQUESTED (Type: ToiHdmiCecActiveRequestedEvent) (value = 4608) (static, constant)

This is an Event identifier for ToiHdmiCecActiveRequestedEvent.

Called when CEC active from standby is received and the application is in control of standby. The application should call ToiPowerControl#requestPowerProfile to initiate a power profile change request if the STB is in standby. If standby control has been delegated to the platform, this notification will not be sent. Instead a power profile change will automatically be requested.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_ACTIVE_REQUESTED.

ON_CEC_DEVICE_INFO_CHANGED (Type: ToiHdmiCecDeviceInfoChangedEvent) (value = 4600) (static, constant)

This is an Event identifier for ToiHdmiCecDeviceInfoChangedEvent.

Called when CEC information of the devices on the CEC bus is changed.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_DEVICE_INFO_CHANGED.

ON_CEC_FEATURE_STATUS_CHANGED (Type: ToiHdmiCecFeatureStatusChangedEvent) (value = 4601) (static, constant)

This is an Event identifier for ToiHdmiCecFeatureStatusChangedEvent.

Called when any CEC feature status is changed.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_FEATURE_STATUS_CHANGED.

ON_CEC_STANDBY_REQUESTED (Type: ToiHdmiCecStandbyRequestedEvent) (value = 4603) (static, constant)

This is an Event identifier for ToiHdmiCecStandbyRequestedEvent.

Called when CEC standby is received and the application is in control of standby. The application should call ToiPowerControl#requestPowerProfile to initiate a power profile change request if the STB is active. If standby control has been delegated to the platform, this notification will not be sent. Instead a power profile change will automatically be requested.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_STANDBY_REQUESTED.

ON_CEC_USER_CONTROL_PRESSED (Type: ToiHdmiCecUserControlPressedEvent) (value = 4606) (static, constant)

This is an Event identifier for ToiHdmiCecUserControlPressedEvent.

Called when CEC "User control pressed" message is received.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_USER_CONTROL_PRESSED.

ON_CEC_USER_CONTROL_RELEASED (Type: ToiHdmiCecUserControlReleasedEvent) (value = 4607) (static, constant)

This is an Event identifier for ToiHdmiCecUserControlReleasedEvent.

Called when CEC "User control released" message is received.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CEC_USER_CONTROL_RELEASED.

ON_CONNECTION_STATUS_CHANGED (Type: ToiHdmiConnectionStatusChangedEvent) (value = 4604) (static, constant)

This is an Event identifier for ToiHdmiConnectionStatusChangedEvent.

Called when HDMI output connection status has changed.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_CONNECTION_STATUS_CHANGED.

ON_HDCP_STATUS_CHANGED (Type: ToiHdmiHdcpStatusChangedEvent) (value = 4605) (static, constant)

This is an Event identifier for ToiHdmiHdcpStatusChangedEvent.

Called when HDCP status of HDMI output has changed.

This constant can also be accessed from toi.consts.ToiHdmiService.ON_HDCP_STATUS_CHANGED.

CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH (Type: ToiHdmiService.ToiCecFeature) (value = 1) (static, constant)

STB initiates remote control pass through.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH.

CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH_FOLLOWER (Type: ToiHdmiService.ToiCecFeature) (value = 3) (static, constant)

STB follows remote control pass through from other CEC devices.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_FEATURE_REMOTE_CONTROL_PASSTHROUGH_FOLLOWER.

Technical Preview:

This flag is a TECHNICAL PREVIEW, it may change.

CEC_FEATURE_SYSTEM_STANDBY (Type: ToiHdmiService.ToiCecFeature) (value = 0) (static, constant)

STB initiates system standby control.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_FEATURE_SYSTEM_STANDBY.

CEC_FEATURE_SYSTEM_STANDBY_FOLLOWER (Type: ToiHdmiService.ToiCecFeature) (value = 2) (static, constant)

STB follows system standby from other CEC devices.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_FEATURE_SYSTEM_STANDBY_FOLLOWER.

CEC_LOGICAL_ADDRESS_AUDIOSYS (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 11) (static, constant)

Logical address for audio system.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_AUDIOSYS.

CEC_LOGICAL_ADDRESS_BROADCAST (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 13) (static, constant)

Logical address for broadcast.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_BROADCAST.

CEC_LOGICAL_ADDRESS_PLAYBACK1 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 8) (static, constant)

Logical address for playback1.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_PLAYBACK1.

CEC_LOGICAL_ADDRESS_PLAYBACK2 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 9) (static, constant)

Logical address for playback2.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_PLAYBACK2.

CEC_LOGICAL_ADDRESS_PLAYBACK3 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 10) (static, constant)

Logical address for playback3.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_PLAYBACK3.

CEC_LOGICAL_ADDRESS_RECORDER1 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 1) (static, constant)

Logical address for recorder1.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_RECORDER1.

CEC_LOGICAL_ADDRESS_RECORDER2 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 2) (static, constant)

Logical address for recorder2.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_RECORDER2.

CEC_LOGICAL_ADDRESS_RECORDER3 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 3) (static, constant)

Logical address for recorder3.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_RECORDER3.

CEC_LOGICAL_ADDRESS_SPECIALUSE (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 12) (static, constant)

Logical address for special usage.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_SPECIALUSE.

CEC_LOGICAL_ADDRESS_TUNER1 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 4) (static, constant)

Logical address for tuner1.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_TUNER1.

CEC_LOGICAL_ADDRESS_TUNER2 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 5) (static, constant)

Logical address for tuner2.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_TUNER2.

CEC_LOGICAL_ADDRESS_TUNER3 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 6) (static, constant)

Logical address for tuner3.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_TUNER3.

CEC_LOGICAL_ADDRESS_TUNER4 (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 7) (static, constant)

Logical address for tuner4.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_TUNER4.

CEC_LOGICAL_ADDRESS_TV (Type: ToiHdmiService.ToiCecLogicalAddress) (value = 0) (static, constant)

Logical address for TV.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_LOGICAL_ADDRESS_TV.

CEC_UICOMMAND_MUTE (Type: ToiHdmiService.ToiCecUiCommand) (value = 67) (static, constant)

UI command to mute/unmute.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_UICOMMAND_MUTE.

CEC_UICOMMAND_VOLUME_DOWN (Type: ToiHdmiService.ToiCecUiCommand) (value = 66) (static, constant)

UI command to decrease the volume.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_UICOMMAND_VOLUME_DOWN.

CEC_UICOMMAND_VOLUME_UP (Type: ToiHdmiService.ToiCecUiCommand) (value = 65) (static, constant)

UI command to increase the volume.

This constant can also be accessed from toi.consts.ToiHdmiService.CEC_UICOMMAND_VOLUME_UP.

CONNECTION_STATUS_CONNECTED (Type: ToiHdmiService.ToiConnectionStatus) (value = 1) (static, constant)

HDMI sink is connected and capabilities are known.

This constant can also be accessed from toi.consts.ToiHdmiService.CONNECTION_STATUS_CONNECTED.

CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN (Type: ToiHdmiService.ToiConnectionStatus) (value = 2) (static, constant)

HDMI sink is connected and capabilities are unknown/invalid.

This constant can also be accessed from toi.consts.ToiHdmiService.CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN.

CONNECTION_STATUS_DISCONNECTED (Type: ToiHdmiService.ToiConnectionStatus) (value = 3) (static, constant)

HDMI sink is not connected.

This constant can also be accessed from toi.consts.ToiHdmiService.CONNECTION_STATUS_DISCONNECTED.

CONNECTION_STATUS_UNKNOWN (Type: ToiHdmiService.ToiConnectionStatus) (value = 0) (static, constant)

HDMI connection status is unknown.

This constant can also be accessed from toi.consts.ToiHdmiService.CONNECTION_STATUS_UNKNOWN.

HDCP_STATUS_DISABLED (Type: ToiHdmiService.ToiHdcpStatus) (value = 9) (static, constant)

HDCP is disabled.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_DISABLED.

HDCP_STATUS_ERROR (Type: ToiHdmiService.ToiHdcpStatus) (value = 3) (static, constant)

The HDMI display has general HDCP error other than the specific ones defined later.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_ERROR.

HDCP_STATUS_INITIALIZING (Type: ToiHdmiService.ToiHdcpStatus) (value = 0) (static, constant)

HDMI display (including the HDCP) is being initialized.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_INITIALIZING.

HDCP_STATUS_NON_COMPLIANT_DEVICE (Type: ToiHdmiService.ToiHdcpStatus) (value = 5) (static, constant)

The HDMI display is a non-HDCP-compliant device.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_NON_COMPLIANT_DEVICE.

HDCP_STATUS_NON_COMPLIANT_REPEATER (Type: ToiHdmiService.ToiHdcpStatus) (value = 7) (static, constant)

The HDMI device is a non-HDCP-compliant repeater.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_NON_COMPLIANT_REPEATER.

HDCP_STATUS_OK (Type: ToiHdmiService.ToiHdcpStatus) (value = 1) (static, constant)

HDCP on the HDMI display is working as specified.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_OK.

HDCP_STATUS_ON_REVOCATION_LIST (Type: ToiHdmiService.ToiHdcpStatus) (value = 6) (static, constant)

The HDMI display is on the revocation list.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_ON_REVOCATION_LIST.

HDCP_STATUS_REPEATER_ERROR (Type: ToiHdmiService.ToiHdcpStatus) (value = 4) (static, constant)

The HDMI repeater has general HDCP error other than the specific ones defined later.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_REPEATER_ERROR.

HDCP_STATUS_REPEATER_OK (Type: ToiHdmiService.ToiHdcpStatus) (value = 2) (static, constant)

HDCP on the HDMI repeater is working as specified.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_REPEATER_OK.

HDCP_STATUS_REPEATER_TOPOLOGY_ERROR (Type: ToiHdmiService.ToiHdcpStatus) (value = 8) (static, constant)

The HDMI device is a repeater that has more than 127 sinks or 7 depth of sinks attached.

This constant can also be accessed from toi.consts.ToiHdmiService.HDCP_STATUS_REPEATER_TOPOLOGY_ERROR.

ToiCecFeatureInfo (Type: struct) (static)

The CEC feature information.

Struct fields

Name	Description
feature	The CEC feature. Type: ToiHdmiService.ToiCecFeature
isEnabled	True if the feature is enabled and false if the feature is disabled. Type: boolean

ToiCecInfo (Type: struct) (static)

The CEC information of the device on the CEC bus.

Struct fields

Name	Description
logicalAddress	The CEC logical address of the device on the CEC bus. Type: ToiHdmiService.ToiCecLogicalAddress
osdName	The CEC OSD name of the device on the CEC bus. Type: string

ToiManufacturerInfo (Type: struct) (static)

Manufacturer information from the EDID.

Struct fields

Name	Description
name	Three character long manufacturer name as assigned by Microsoft. Type: string
productId	Product identifier assigned by manufacturer. Type: number
serialNumber	Serial number by manufacturer. Type: number
weekOfManufacture	Week of manufacture. Valid range is 1-54. Type: number
yearOfManufacture	Year of manufacture. Type: number

ToiSinkInfo (Type: struct) (static)

Specifies the HDMI connection status and HDMI sink information.

Struct fields

Name	Description
hdcpStatus	HDMI display HDCP status information. Type: ToiHdmiService.ToiHdcpStatus
manufacturerInfo	Manufacturer information from the EDID. Type: ToiHdmiService.ToiManufacturerInfo
rawEdid	Raw EDID of 4 blocks. Type: Array.<raw>
status	HDMI connection status. Type: ToiHdmiService.ToiConnectionStatus
supportedAudioFormats	List of supported audio formats. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiAudioOutputConfiguration.ToiAudioFormat> (Or a single ToiAudioOutputConfiguration.ToiAudioFormat.)
supportedModes	List of supported video modes. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiVideoMode> (Or a single ToiVideoOutputConfiguration.ToiVideoMode.)