Namespace: output

Namespaces

color_space

deep_color_format

event

Methods

staticENABLE.output.getHdmiSettings(){Object}

output.js, line 155

Get the HDMI settings

Since:

• 1.4.0

Returns:

Name	Type	Description
object	Object	Name Type Description status_code String ENABLE.status.SUCCESS or ENABLE.status.NOT_READY color_space String Current HDMI color space, possible values: ENABLE.output.color_space.RGB ENABLE.output.color_space.YCBCR_420 ENABLE.output.color_space.YCBCR_422 ENABLE.output.color_space.YCBCR_444 deep_color_format String Deep color format, possible values: ENABLE.output.deep_color_format.DC_OFF ENABLE.output.deep_color_format.DC_30 ENABLE.output.deep_color_format.DC_36 ENABLE.output.deep_color_format.DC_48 hdmi_audio_mute Boolean Is HDMI audio mute, deprecated

staticENABLE.output.getHdmiStatus(){Object}

output.js, line 123

Get the HDMI status

Since:

• 1.0.0

Returns:

Name	Type	Description
object	Object	Name Type Description status_code String ENABLE.status.SUCCESS or ENABLE.status.NOT_READY connected Boolean HDMI connection status monitor_name String Model name of the connected screen highest_match_resolution String HDMI highest match resolution preferred_resolution String HDMI preferred resolution supported_resolution Array.<String> HDMI supported resolution, only included resolution supported by both STB and TV tv_supported_resolution Array.<String> TV HDMI supported resolution, may included resolution that the STB cannot support supported_audio_codec Array.<String> HDMI supported audio type eotf_format String EOTF/HDR format (SDR, HLG, HDR10, HDR10+, DolbyVision) supported_deep_color_formats Array.<String> Deep color formats supported by connected HDMI device supported_eotf_formats Array.<String> HDR formats supported by connected HDMI device width Number Resolution width in pixels height Number Resolution height in pixels supported_color_space Array.<String> Color space supported by the connected display supported_3D_resolution Array.<String> Supported 3D resolution

staticENABLE.output.setEventCallback(callback){Object}

output.js, line 238

Register HDMI event callback function.
Pass null as callback to unregister.
If callback is not a function, this function will return ENABLE.status.INVALID_ARGUMENT.
Only one callback function can be registered. Pass null as callback to unregister.
Example:

var callback = function(obj) {
    if (obj.event === ENABLE.output.event.HDMI_CONNECTED){
        console.log("Receive HDMI hotplug event!");
    }
};
ENABLE.output.setEventCallback(callback);

Name	Type	Description
callback	ENABLE.output~Callback	Callback function.

Since:

• 1.0.0

Returns:

Name	Type	Description
object	Object	Name Type Description status_code String ENABLE.status.SUCCESS or ENABLE.status.INVALID_ARGUMENT

staticENABLE.output.setHdmiSettings(settings){Object}

output.js, line 183

Set the HDMI settings (persistent across boot)

Name	Type	Description
settings	Object	Name Type Description color_space String Current HDMI color space, possible values: ENABLE.output.color_space.RGB ENABLE.output.color_space.YCBCR_420 ENABLE.output.color_space.YCBCR_422 ENABLE.output.color_space.YCBCR_444 deep_color_format String Deep color format, possible values: ENABLE.output.deep_color_format.DC_OFF ENABLE.output.deep_color_format.DC_30 ENABLE.output.deep_color_format.DC_36 ENABLE.output.deep_color_format.DC_48 hdmi_audio_mute Boolean Is HDMI audio mute, deprecated

Since:

• 1.4.0

Returns:

Name	Type	Description
object	Object	Name Type Description status_code String ENABLE.status.SUCCESS or ENABLE.status.NOT_READY

Type Definitions

Callback(object)

output.js, line 209

Callback function for ENABLE.output.setEventCallback

Name	Type	Description
object	Object	Name Type Description event Object Possible values of event: ENABLE.output.event.HDMI_DISCONNECTED ENABLE.output.event.HDMI_CONNECTED

Since:

• 1.0.0