1.2.0 ENABLE.output

Namespaces

color_space
deep_color_format
event

Methods

static ENABLE.output.getHdmiSettings () {Object}

Get the HDMI settings

Since:
  • 1.0.0
Returns:
Name Type Description
object Object
Name Type Description
status_code String ENABLE.status.SUCCESS or
ENABLE.status.NOT_READY
hdmi_audio_mute Boolean Is HDMI audio mute
color_space String Current HDMI color space
deep_color_format String Deep color format (off(8bit), 10bit, 12bit, 16bit)

static ENABLE.output.getHdmiStatus () {Object}

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 Monitor name
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 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

static ENABLE.output.setEventCallback (callback) {Object}

Register HDMI event callback function.
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.NOT_READY

static ENABLE.output.setHdmiSettings (settings) {Object}

Set the HDMI settings (persistent across boot)

Name Type Description
settings Object
Name Type Description
hdmi_audio_mute Boolean

Is HDMI audio mute

color_space String

Current HDMI color space

deep_color_format String

Deep color format (off(8bit), 10bit, 12bit, 16bit)

Since:
  • 1.0.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)

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