HDMI Encoder
A Node object whose type is HDMI_ENCODER. This object is only found on receiver devices.
Configuration
HdmiEncoderNodeConfig{
"hdcp_output_mode" : String,
"hdmi_tx_5v" : String
}
| Member name | Type | Description |
|---|---|---|
| hdcp_output_mode | String | HDCP output level: UNSUPPORTED The feature is unsupported on this device FOLLOW_SINK_1 The highest HDCP capability of the sink FOLLOW_SINK_2 HDCP 1.4 when possible FOLLOW_SOURCE The same level as the source |
| hdmi_tx_5v | String | HDMI TX 5V output control. AUTO follows the operating mode's normal rules; LOW holds the output low regardless of operating mode. |
Status
HdmiEncoderNodeStatus{
"hdcp_protected" : Boolean,
"hdcp_version" : String,
"hdmi_2_0_support" : Boolean,
"source_stable" : Boolean,
"video" : VideoFormat,
"has_video_details" : Boolean,
"video_details" : VideoFormatDetails,
"has_audio_details" : Boolean,
"audio_details" : AudioFormatDetails,
"has_audio_details_extended" : Boolean,
"audio_details_extended" : AudioFormatExtended
}
| Member name | Type | Description |
|---|---|---|
| hdcp_protected | Boolean | Whether HDCP protection is enabled (automatically enabled if the source is HDCP protected) |
| hdcp_version | String | Version of HDCP content protection: NONE, HDCP_1_4, or HDCP_2_2 |
| hdmi_2_0_support | Boolean | Whether this HDMI encoder supports HDMI 2.0 resolutions (e.g. 4K60) |
| source_stable | Boolean | Whether the encoder is receiving video from its source |
| video | VideoFormat | Format of the video being output by the HDMI encoder. Undefined if source_stable is false. |
| has_video_details | Boolean | Whether detailed video format and timing information is available. |
| video_details | VideoFormatDetails | Detailed video format and timing information. Undefined if source_stable or has_video_details is false. |
| has_audio_details | Boolean | Whether audio format information is available. |
| audio_details | AudioFormatDetails | The audio format. Undefined if source_stable or has_audio_details is false. |
| has_audio_details_extended | Boolean | Whether extended audio format information is available. |
| audio_details_extended | AudioFormatExtended | Extended audio format data. Undefined if source_stable or has_audio_details_extended is false. |
Inputs
| Input name | Configurable | Description |
|---|---|---|
| main | No | Main video input. A device may support one or both of the following values: 0 Video from a video subscription (genlock mode) 1 Video from a frame buffer (frame buffer mode) |
| audio | Yes | HDMI audio source. A device may support none, some or all the following choices: 2 HDMI audio (original audio from video subscription in genlock mode) 3 Analog audio 6 HDMI audio (stereo downmix) 7 HDMI audio (all available channels) |
Example
As returned by get device:
{
"type" : "HDMI_ENCODER",
"index" : 0,
"configuration" : {
"hdcp_output_mode" : "FOLLOW_SINK_1",
"hdmi_tx_5v" : "AUTO"
},
"status" : {
"video" : {
"width" : 1920,
"height" : 1080,
"frames_per_second" : 60,
"color_space" : "RGB",
"bits_per_pixel" : 8,
"scan_mode" : "PROGRESSIVE"
},
"has_video_details" : true,
"video_details" : {
"pixel_clock" : 148500000,
"total_width" : 2200,
"total_height" : 1125,
"hsync_width" : 44,
"hsync_front_porch" : 88,
"hsync_negative" : false,
"vsync_width" : 5,
"vsync_front_porch" : 4,
"vsync_negative" : false,
"vic" : 16,
"has_hdmi_vic" : false,
"hdmi_vic" : 0,
"picture_aspect" : "ASPECT_16_9",
"has_active_format" : false,
"active_format" : 0,
"it_content_type" : "GRAPHICS",
"scan_information" : "NO_DATA",
"colorimetry" : "BT709",
"rgb_range" : "DEFAULT",
"ycc_range" : "LIMITED"
},
"hdcp_protected" : false,
"hdcp_version" : "NONE",
"hdmi_2_0_support" : true,
"source_stable" : false
},
"inputs" : [
{
"name" : "main",
"index" : 0,
"configuration" : {
"source" : {
"value" : 0,
"choices" : [
{
"value" : 0,
"description" : "Genlock Mode",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI",
"ref_index" : 0
}
},
{
"value" : 1,
"description" : "Frame Buffer Mode",
"details" : {
"ref_class" : "NODE",
"ref_type" : "FRAME_BUFFER",
"ref_index" : 0
}
}
]
}
},
"status" : {
"source" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI",
"ref_index" : 0
}
}
},
{
"name" : "audio",
"index" : 0,
"configuration" : {
"source" : {
"value" : 2,
"choices" : [
{
"value" : 2,
"description" : "HDMI Audio (from HDMI in Genlock Mode)",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI_AUDIO",
"ref_index" : 0
}
},
{
"value" : 3,
"description" : "Analog Audio",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "AUDIO",
"ref_index" : 0
}
},
{
"value" : 6,
"description" : "HDMI Audio (Stereo Downmix)",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI_AUDIO",
"ref_index" : 0
}
},
{
"value" : 7,
"description" : "HDMI Audio (All Available Channels)",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI_AUDIO",
"ref_index" : 0
}
},
{
"value" : 8,
"description" : "I2S Audio",
"details" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "I2S_AUDIO",
"ref_index" : 0
}
}
]
}
},
"status" : {
"source" : {
"ref_class" : "SUBSCRIPTION",
"ref_type" : "HDMI_AUDIO",
"ref_index" : 0
}
}
}
]
}