Skip to main content

Video Compressor

A Node object whose type is VIDEO_COMPRESSOR.

Configuration

VideoCompressorNodeConfig
{
"always_compress" : Boolean,
"version" : Integer
}
Member nameTypeDescription
always_compressBooleanWhen true, HDMI stream 0 is always compressed regardless of the video format.

Otherwise, it is compressed only when this is necessary to keep the video bandwidth under 9Gbit/s.

Note: HDMI stream 1 is never compressed.
versionIntegerVideo compression version to apply.
Two options available:
2 For improved video compression.
1 For backward compatibility with devices that only
support this version.

Refer to the version_support member for the maximum version supported by a device.

Note: All devices receiving compressed video, that is HDMI stream 0 with compression enabled, from a device must be configured to decompress with same compression version.

Status

{
"version_support" : Integer
}
Member nameTypeDescription
version_supportIntegerMaximum compression version supported by this device. Can be either 1 or 2.

Inputs

None

Example

As returned by get device:

{
"type": "VIDEO_COMPRESSOR",
"index": 0,
"configuration": {
"always_compress": false,
"version": 2
},
"status": {
"version_support": 2
},
"inputs": []
}