diff --git a/docs/apis/DisplaySettingsPlugin.md b/docs/apis/DisplaySettingsPlugin.md index 52f3b21b..4c6aa467 100644 --- a/docs/apis/DisplaySettingsPlugin.md +++ b/docs/apis/DisplaySettingsPlugin.md @@ -49,25 +49,25 @@ DisplaySettings interface methods: | [getActiveInput](#getActiveInput) | Returns `true` if the STB HDMI output is currently connected to the active input of the sink device (determined by `RxSense`) | | [getAudioDelay](#getAudioDelay) | Returns the audio delay (in ms) on the selected audio port | | [getAudioDelayOffset](#getAudioDelayOffset) | Returns the audio delay offset (in ms) on the selected audio port | -| [getAudioFormat](#getAudioFormat) | Returns the currently set audio format | -| [getBassEnhancer](#getBassEnhancer) | Returns the current status of the Bass Enhancer settings | +| [getAudioFormat](#getAudioFormat) | Returns the currently set audio format as well as all the supported audio formats | +| [getBassEnhancer](#getBassEnhancer) | Returns the current status of the Bass Enhancer settings of the specified `audioPort` | | [getConnectedAudioPorts](#getConnectedAudioPorts) | Returns connected audio output ports (a subset of the ports supported on the device) | | [getConnectedVideoDisplays](#getConnectedVideoDisplays) | Returns connected video displays | -| [getCurrentOutputSettings](#getCurrentOutputSettings) | Returns current output settings | +| [getCurrentOutputSettings](#getCurrentOutputSettings) | Returns current output settings of `HDMI0` or `INTERNAL0` or the first available port | | [getCurrentResolution](#getCurrentResolution) | Returns the current resolution on the selected video display port | -| [getDefaultResolution](#getDefaultResolution) | Gets the default resolution supported by the HDMI0 video output port | +| [getDefaultResolution](#getDefaultResolution) | Gets the default resolution supported by the current video output port | | [getDialogEnhancement](#getDialogEnhancement) | Returns the current Dialog Enhancer level (port HDMI0) | | [getDolbyVolumeMode](#getDolbyVolumeMode) | Returns whether Dolby Volume mode is enabled or disabled (audio output port HDMI0) | -| [getDRCMode](#getDRCMode) | Returns the current Dynamic Range Control mode | -| [getEnableAudioPort](#getEnableAudioPort) | Returns the current status of the specified input audio port | -| [setAssociatedAudioMixing](#setAssociatedAudioMixing) | Sets the Associated Audio Mixing Enable/Disable | -| [getAssociatedAudioMixing](#getAssociatedAudioMixing) | Returns the Associated Audio Mixing status | -| [setFaderControl](#setFaderControl) | Sets the set the mixerbalance betweeen main and associated audio | -| [getFaderControl](#getFaderControl) | Returns the mixerbalance betweeen main and associated audio | -| [setPrimaryLanguage](#setPrimaryLanguage) | Sets the Primary language | -| [getPrimaryLanguage](#getPrimaryLanguage) | Returns the Primary language | -| [setSecondaryLanguage](#setSecondaryLanguage) | Sets the secondary language | -| [getSecondaryLanguage](#getSecondaryLanguage) | Returns the Secondary language | +| [getDRCMode](#getDRCMode) | Returns the current Dynamic Range Control mode of the specified `audioPort` | +| [getEnableAudioPort](#getEnableAudioPort) | Returns the current status of the specified audio port | +| [setAssociatedAudioMixing](#setAssociatedAudioMixing) | Sets the Associated Audio Mixing `Enable/Disable` on the specified `audioPort` | +| [getAssociatedAudioMixing](#getAssociatedAudioMixing) | Returns the Associated Audio Mixing status of the specified `audioPort` | +| [setFaderControl](#setFaderControl) | Sets the configured `mixerBalance` betweeen main and associated audio on the specified `audioPort` | +| [getFaderControl](#getFaderControl) | Returns the mixerbalance betweeen main and associated audio on the specified `audioPort` | +| [setPrimaryLanguage](#setPrimaryLanguage) | Sets the Primary language for the specified `audioPort` | +| [getPrimaryLanguage](#getPrimaryLanguage) | Returns the Primary language for the specified `audioPort` | +| [setSecondaryLanguage](#setSecondaryLanguage) | Sets the secondary language for the specified `audioPort` | +| [getSecondaryLanguage](#getSecondaryLanguage) | Returns the Secondary language for the specified `audioPort` | | [getGain](#getGain) | Returns the current gain value | | [getGraphicEqualizerMode](#getGraphicEqualizerMode) | Returns the current Graphic Equalizer Mode setting (port HDMI0) | | [getIntelligentEqualizerMode](#getIntelligentEqualizerMode) | Returns the current Intelligent Equalizer Mode setting (port HDMI0) | @@ -75,11 +75,11 @@ DisplaySettings interface methods: | [getMS12AudioCompression](#getMS12AudioCompression) | Returns the current audio compression settings | | [getMS12AudioProfile](#getMS12AudioProfile) | Returns the current MS12 audio profile settings | | [getMuted](#getMuted) | Returns whether audio is muted on a given port | -| [getPreferredColorDepth](#getPreferredColorDepth) | Returns the current color depth on the selected video display port | -| [getSettopAudioCapabilities](#getSettopAudioCapabilities) | Returns the set-top audio capabilities for the specified audio port | +| [getPreferredColorDepth](#getPreferredColorDepth) | Returns the current color depth on the specified `videoDisplay` port | +| [getSettopAudioCapabilities](#getSettopAudioCapabilities) | Returns the set-top audio capabilities for the specified output `audioPort` | | [getSettopHDRSupport](#getSettopHDRSupport) | Returns an HDR support object (list of standards that the STB supports) | -| [getSettopMS12Capabilities](#getSettopMS12Capabilities) | Returns the set-top MS12 audio capabilities for the specified audio port | -| [getSinkAtmosCapability](#getSinkAtmosCapability) | Returns the ATMOS capability of the sink (HDMI0) | +| [getSettopMS12Capabilities](#getSettopMS12Capabilities) | Returns the set-top MS12 audio capabilities for the specified output `audioPort` | +| [getSinkAtmosCapability](#getSinkAtmosCapability) | Returns the ATMOS capability of the specified `audioPort` sink | | [getSoundMode](#getSoundMode) | Returns the sound mode for the incoming video display | | [getSupportedAudioModes](#getSupportedAudioModes) | Returns a list of strings containing the supported audio modes | | [getSupportedAudioPorts](#getSupportedAudioPorts) | Returns all audio ports supported on the device (all ports that are physically present) | @@ -88,15 +88,15 @@ DisplaySettings interface methods: | [getSupportedSettopResolutions](#getSupportedSettopResolutions) | Returns supported STB resolutions | | [getSupportedTvResolutions](#getSupportedTvResolutions) | Returns supported TV resolutions on the selected video display port | | [getSupportedVideoDisplays](#getSupportedVideoDisplays) | Returns all video ports supported on the device (all ports that are physically present) | -| [getSurroundVirtualizer](#getSurroundVirtualizer) | (Version 2) Returns the current surround virtualizer boost settings | +| [getSurroundVirtualizer](#getSurroundVirtualizer) | (Version 2) Returns the current surround virtualizer boost settings of the specified `audioPort` | | [getTVHDRCapabilities](#getTVHDRCapabilities) | Gets HDR capabilities supported by the TV | | [getTvHDRSupport](#getTvHDRSupport) | Returns an HDR support object (list of standards that the TV supports) | | [getVideoFormat](#getVideoFormat) | Returns the current and supported video formats | -| [getVideoPortStatusInStandby](#getVideoPortStatusInStandby) | Returns video port status in standby mode (failure if the port name is missing) | +| [getVideoPortStatusInStandby](#getVideoPortStatusInStandby) | Returns video port status in standby mode | | [getVolumeLevel](#getVolumeLevel) | Returns the current volume level | -| [getVolumeLeveller](#getVolumeLeveller) | (Version 2) Returns the current Volume Leveller setting | +| [getVolumeLeveller](#getVolumeLeveller) | (Version 2) Returns the current Volume Leveller setting of specified `audioPort` | | [getZoomSetting](#getZoomSetting) | Returns the zoom setting value | -| [isConnectedDeviceRepeater](#isConnectedDeviceRepeater) | Indicates whether the device connected to the HDMI0 video output port is an HDCP repeater | +| [isConnectedDeviceRepeater](#isConnectedDeviceRepeater) | Indicates whether the device connected to the current video output port is an HDCP repeater | | [isSurroundDecoderEnabled](#isSurroundDecoderEnabled) | Returns the current status of Surround Decoder | | [readEDID](#readEDID) | Reads the EDID from the connected HDMI (output) device | | [readHostEDID](#readHostEDID) | Reads the EDID of the host | @@ -104,15 +104,15 @@ DisplaySettings interface methods: | [resetDialogEnhancement](#resetDialogEnhancement) | Resets the dialog enhancer level to its default enhancer level | | [resetSurroundVirtualizer](#resetSurroundVirtualizer) | Resets the surround virtualizer to its default boost value | | [resetVolumeLeveller](#resetVolumeLeveller) | Resets the Volume Leveller level to default volume value | -| [setAudioAtmosOutputMode](#setAudioAtmosOutputMode) | Sets ATMOS audio output mode (on HDMI0) | +| [setAudioAtmosOutputMode](#setAudioAtmosOutputMode) | Sets ATMOS audio output mode for the specified `audioPort` | | [setAudioDelay](#setAudioDelay) | Sets the audio delay (in ms) on the selected audio port | | [setAudioDelayOffset](#setAudioDelayOffset) | Sets the audio delay offset (in ms) on the selected audio port | | [setBassEnhancer](#setBassEnhancer) | Sets the Bass Enhancer | -| [setCurrentResolution](#setCurrentResolution) | Sets the current resolution | +| [setCurrentResolution](#setCurrentResolution) | Sets the current resolution to specified value | | [setDialogEnhancement](#setDialogEnhancement) | Sets the Dialog Enhancer level | | [setDolbyVolumeMode](#setDolbyVolumeMode) | Enables or disables Dolby Volume mode on audio track (audio output port HDMI0) | | [setDRCMode](#setDRCMode) | Sets the Dynamic Range Control (DRC) setting | -| [setEnableAudioPort](#setEnableAudioPort) | Enable or disable the specified audio port based on the input audio port name | +| [setEnableAudioPort](#setEnableAudioPort) | This method provides option to enable or disable the specified audio port | | [setForceHDRMode](#setForceHDRMode) | Enables or disables the force HDR mode | | [setGain](#setGain) | Adjusts the gain on a specific port | | [setGraphicEqualizerMode](#setGraphicEqualizerMode) | Sets the Graphic Equalizer Mode | @@ -120,18 +120,18 @@ DisplaySettings interface methods: | [setMISteering](#setMISteering) | Enables or Disables Media Intelligent Steering | | [setMS12AudioCompression](#setMS12AudioCompression) | Sets the audio dynamic range compression level (port HDMI0) | | [setMS12AudioProfile](#setMS12AudioProfile) | Sets the selected MS12 audio profile | -| [setMS12ProfileSettingsOverride](#setMS12ProfileSettingsOverride) | Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode) | +| [setMS12ProfileSettingsOverride](#setMS12ProfileSettingsOverride) | Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode) on the specified or current audio out | | [setMuted](#setMuted) | Mutes or unmutes audio on a specific port | -| [setPreferredColorDepth](#setPreferredColorDepth) | Sets the current color depth for the videoDisplay | -| [setScartParameter](#setScartParameter) | Sets SCART parameters | +| [setPreferredColorDepth](#setPreferredColorDepth) | Sets the current color depth for the output `videoDisplay` | +| [setScartParameter](#setScartParameter) | This method allows to configure SCART(Syndicat des Constructeurs d'Appareils Radiorécepteurs et Téléviseurs) specific settings | | [setSoundMode](#setSoundMode) | Sets the current sound mode for the corresponding video display | | [setSurroundVirtualizer](#setSurroundVirtualizer) | (Version 2) Sets the Surround Virtualizer boost | -| [setVideoPortStatusInStandby](#setVideoPortStatusInStandby) | Sets the specified video port status to be used in standby mode (failure if the port name is missing) | +| [setVideoPortStatusInStandby](#setVideoPortStatusInStandby) | Sets the specified video port status to be used in standby mode | | [setVolumeLevel](#setVolumeLevel) | Adjusts the Volume Level on a specific port | -| [setVolumeLeveller](#setVolumeLeveller) | (Version 2) Sets the Volume Leveller level | +| [setVolumeLeveller](#setVolumeLeveller) | (Version 2) Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources | | [setZoomSetting](#setZoomSetting) | Sets the current zoom value | -| [getColorDepthCapabilities](#getColorDepthCapabilities) | Returns supported color depth capabilities | -| [getSupportedMS12Config](#getSupportedMS12Config) | Returns supported ms12 config by the platform, possible values couldbe CONFG_Z, CONFIG_X, CONFIG_Y, CONFIG_NONE | +| [getColorDepthCapabilities](#getColorDepthCapabilities) | Returns supported color depth capabilities of the current video output port(`HDMI0` if available, otherwise `INTERNAL0`, or first available port) | +| [getSupportedMS12Config](#getSupportedMS12Config) | Returns supported ms12 config by the platform, possible values: `CONFIG_Z`, `CONFIG_X`, `CONFIG_Y`, `CONFIG_NONE` | @@ -148,7 +148,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.surroundDecoderEnable | boolean | Whether Surround Decoder is is enabled (`true`) or disabled (`false`) | ### Result @@ -200,7 +200,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.videoDisplay | string | *(optional)* Video display port name. The default port is `HDMI0` if no port is specified | +| params?.videoDisplay | string | *(optional)* Video display port name. See `getConnectedVideoDisplays` for acquiring available list | ### Result @@ -252,7 +252,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params.audioPort | string | Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | ### Result @@ -304,7 +304,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params.audioPort | string | Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | ### Result @@ -345,7 +345,7 @@ No Events ## *getAudioFormat* -Returns the currently set audio format. +Returns the currently set audio format as well as all the supported audio formats. ### Events @@ -396,7 +396,7 @@ This method takes no parameters. ## *getBassEnhancer* -Returns the current status of the Bass Enhancer settings. +Returns the current status of the Bass Enhancer settings of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -407,7 +407,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -450,7 +450,7 @@ No Events ## *getConnectedAudioPorts* -Returns connected audio output ports (a subset of the ports supported on the device). For SPDIF supported platforms, SPDIF port is always considered connected. HDMI port may or may not be connected. +Returns connected audio output ports (a subset of the ports supported on the device). SPDIF port is always considered `connected` on a supported platform. HDMI port may or may not be connected. ### Events @@ -548,7 +548,7 @@ This method takes no parameters. ## *getCurrentOutputSettings* -Returns current output settings. +Returns current output settings of `HDMI0` or `INTERNAL0` or the first available port. ### Events @@ -563,11 +563,11 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.colorSpace | integer | The color space. Possible values: `0` (dsDISPLAY_COLORSPACE_UNKNOWN), `1` (sDISPLAY_COLORSPACE_RGB, `2` (dsDISPLAY_COLORSPACE_YCbCr422), `3` (dsDISPLAY_COLORSPACE_YCbCr444), `4` (dsDISPLAY_COLORSPACE_YCbCr420), `5` (dsDISPLAY_COLORSPACE_AUTO) | -| result.colorDepth | integer | The color depth. The value that is returned from `dsGetCurrentOutputSettings` | -| result.matrixCoefficients | integer | matrix coefficients. Possible values: `0` (dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN), `1` (dsDISPLAY_MATRIXCOEFFICIENT_BT_709), `2` (dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG), `3` (dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M), `4` (dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709), `5` (dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601), `6` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL), `7` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL) | -| result.videoEOTF | integer | HDR standard. Possible values: `0x0` (dsHDRSTANDARD_NONE), `0x01` (dsHDRSTANDARD_HDR10), `0x02` (dsHDRSTANDARD_HLG), `0x04` (dsHDRSTANDARD_DolbyVision), `0x08` (dsHDRSTANDARD_TechnicolorPrime), `0x10` (dsHDRSTANDARD_HDR10PLUS), `0x20` (dsHDRSTANDARD_SDR), `0x80` (dsHDRSTANDARD_Invalid) | -| result?.quantizationRange | integer | *(optional)* The supported quantization range | +| result.colorSpace | integer | Defines how color information is represented, encoded and displayed. Possible values: `0` (dsDISPLAY_COLORSPACE_UNKNOWN), `1` (sDISPLAY_COLORSPACE_RGB, `2` (dsDISPLAY_COLORSPACE_YCbCr422), `3` (dsDISPLAY_COLORSPACE_YCbCr444), `4` (dsDISPLAY_COLORSPACE_YCbCr420), `5` (dsDISPLAY_COLORSPACE_AUTO) | +| result.colorDepth | integer | The number of bits used for each color channel (e.g., 8-bit, 10-bit, 12-bit). Higher color depth allows more precise color representation. Here the value that is returned from `dsGetCurrentOutputSettings` | +| result.matrixCoefficients | integer | Specifies the mathematical conversion between color spaces (e.g., BT.709, BT.2020). This affects how colors are mapped from one standard to another. Possible values: `0` (dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN), `1` (dsDISPLAY_MATRIXCOEFFICIENT_BT_709), `2` (dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG), `3` (dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M), `4` (dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709), `5` (dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601), `6` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL), `7` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL) | +| result.videoEOTF | integer | Current EOTF (Electro-Optical Transfer Function) also known as HDR standard. Possible values: `0x0` (dsHDRSTANDARD_NONE), `0x01` (dsHDRSTANDARD_HDR10), `0x02` (dsHDRSTANDARD_HLG), `0x04` (dsHDRSTANDARD_DolbyVision), `0x08` (dsHDRSTANDARD_TechnicolorPrime), `0x10` (dsHDRSTANDARD_HDR10PLUS), `0x20` (dsHDRSTANDARD_SDR), `0x80` (dsHDRSTANDARD_Invalid) | +| result?.quantizationRange | integer | *(optional)* The range of values used to represent color (e.g., limited range `16 to 235`, full range `0 to 255`). It affects contrast and black/white levels. Current supported quantization range | | result.success | boolean | Whether the request succeeded | ### Example @@ -602,7 +602,7 @@ This method takes no parameters. ## *getCurrentResolution* -Returns the current resolution on the selected video display port. +Returns the current resolution on the selected video display port. Defaults to `HDMI0` if available, otherwise `INTERNAL0`, or first available port if not specified. ### Events @@ -613,7 +613,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.videoDisplay | string | *(optional)* Video display port name. The default port is `HDMI0` if no port is specified | +| params?.videoDisplay | string | *(optional)* Video display port name. See `getConnectedVideoDisplays` for acquiring available list | ### Result @@ -660,7 +660,7 @@ No Events ## *getDefaultResolution* -Gets the default resolution supported by the HDMI0 video output port. +Gets the default resolution supported by the current video output port. ### Events @@ -675,7 +675,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.defaultResolution | string | Default resolution supported by the HDMI0 video output port | +| result.defaultResolution | string | Default resolution supported by the current video output port | | result.success | boolean | Whether the request succeeded | ### Example @@ -717,7 +717,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -806,7 +806,7 @@ This method takes no parameters. ## *getDRCMode* -Returns the current Dynamic Range Control mode. +Returns the current Dynamic Range Control mode of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -817,7 +817,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -858,7 +858,7 @@ No Events ## *getEnableAudioPort* - Returns the current status of the specified input audio port. +Returns the current status of the specified audio port. If not specified, defaults `audioPort` to `HDMI0`. ### Events @@ -869,7 +869,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name | +| params?.audioPort | string | *(optional)* Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | ### Result @@ -910,7 +910,7 @@ No Events ## *setAssociatedAudioMixing* -Sets the Associated Audio Mixing Enable/Disable. +Sets the Associated Audio Mixing `Enable/Disable` on the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -921,7 +921,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.mixing | boolean | `true` enables the Associated Audio Mixing for specified audio port. `false` to disables | ### Result @@ -962,7 +962,7 @@ No Events ## *getAssociatedAudioMixing* -Returns the Associated Audio Mixing status. +Returns the Associated Audio Mixing status of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -973,7 +973,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1014,7 +1014,7 @@ No Events ## *setFaderControl* -Sets the set the mixerbalance betweeen main and associated audio. +Sets the configured `mixerBalance` betweeen main and associated audio on the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else applies globally using `Host::setFaderControl()`. ### Events @@ -1025,7 +1025,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.mixerBalance | integer | Value between -32 to +32, where -32 means mute associated and +32 means mute main | ### Result @@ -1066,7 +1066,7 @@ No Events ## *getFaderControl* -Returns the mixerbalance betweeen main and associated audio. +Returns the mixerbalance betweeen main and associated audio on the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global mixer balance from `Host::getFaderControl()`. ### Events @@ -1077,7 +1077,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1118,7 +1118,7 @@ No Events ## *setPrimaryLanguage* -Sets the Primary language. +Sets the Primary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` output if not specified when available. Else applies globally with `Host::setPrimaryLanguage()`. ### Events @@ -1129,7 +1129,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.lang | string | 3 letter lang code should be used as per ISO 639 | ### Result @@ -1170,7 +1170,7 @@ No Events ## *getPrimaryLanguage* -Returns the Primary language. +Returns the Primary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global primary language from `Host::getPrimaryLanguage()`. ### Events @@ -1181,7 +1181,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1222,7 +1222,7 @@ No Events ## *setSecondaryLanguage* -Sets the secondary language. +Sets the secondary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` output if not specified when available. Else applies globally with `Host::setSecondaryLanguage()`. ### Events @@ -1233,7 +1233,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.lang | string | 3 letter lang code should be used as per ISO 639 | ### Result @@ -1274,7 +1274,7 @@ No Events ## *getSecondaryLanguage* -Returns the Secondary language. +Returns the Secondary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global secondary language from `Host::getSecondaryLanguage()`. ### Events @@ -1285,7 +1285,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1337,7 +1337,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1389,7 +1389,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1443,7 +1443,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1497,7 +1497,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1549,7 +1549,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1603,7 +1603,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1655,7 +1655,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1696,7 +1696,7 @@ No Events ## *getPreferredColorDepth* -Returns the current color depth on the selected video display port. +Returns the current color depth on the specified `videoDisplay` port. Defaults to `HDMI0` if available, otherwise `INTERNAL0`, or first available port if not specified. ### Events @@ -1707,7 +1707,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.videoDisplay | string | *(optional)* Video display port name. The default port is `HDMI0` if no port is specified | +| params?.videoDisplay | string | *(optional)* Video display port name. See `getConnectedVideoDisplays` for acquiring available list | | params?.persist | boolean | *(optional)* Persists the color depth | ### Result @@ -1750,7 +1750,7 @@ No Events ## *getSettopAudioCapabilities* -Returns the set-top audio capabilities for the specified audio port. +Returns the set-top audio capabilities for the specified output `audioPort`. If not specified, defaults to `HDMI0`. ### Events @@ -1761,7 +1761,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1856,7 +1856,7 @@ This method takes no parameters. ## *getSettopMS12Capabilities* -Returns the set-top MS12 audio capabilities for the specified audio port. +Returns the set-top MS12 audio capabilities for the specified output `audioPort`. If not specified, defaults to `HDMI0`. ### Events @@ -1867,7 +1867,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1911,7 +1911,7 @@ No Events ## *getSinkAtmosCapability* -Returns the ATMOS capability of the sink (HDMI0). +Returns the ATMOS capability of the specified `audioPort` sink. Defaults to `HDMI0` if not specified on `STB` and on `TV` it returns the ATMOS capability of the current output port, e.g: `ARC`. See `getConnectedAudioPorts` and `getSupportedAudioPorts` for possible values. ### Events @@ -1922,7 +1922,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -1974,7 +1974,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2031,7 +2031,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2135,7 +2135,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2190,7 +2190,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.videoDisplay | string | *(optional)* Video display port name. The default port is `HDMI0` if no port is specified | +| params?.videoDisplay | string | *(optional)* Video display port name. See `getConnectedVideoDisplays` for acquiring available list | ### Result @@ -2294,7 +2294,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.videoDisplay | string | *(optional)* Video display port name. The default port is `HDMI0` if no port is specified | +| params?.videoDisplay | string | *(optional)* Video display port name. See `getConnectedVideoDisplays` for acquiring available list | ### Result @@ -2387,7 +2387,7 @@ This method takes no parameters. ## *getSurroundVirtualizer* -(Version 2) Returns the current surround virtualizer boost settings. +(Version 2) Returns the current surround virtualizer boost settings of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -2398,7 +2398,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2596,7 +2596,7 @@ This method takes no parameters. ## *getVideoPortStatusInStandby* -Returns video port status in standby mode (failure if the port name is missing). +Returns video port status in standby mode. ### Events @@ -2661,7 +2661,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2702,7 +2702,7 @@ No Events ## *getVolumeLeveller* -(Version 2) Returns the current Volume Leveller setting. +(Version 2) Returns the current Volume Leveller setting of specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -2713,7 +2713,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -2802,7 +2802,7 @@ This method takes no parameters. ## *isConnectedDeviceRepeater* -Indicates whether the device connected to the HDMI0 video output port is an HDCP repeater. +Indicates whether the device connected to the current video output port is an HDCP repeater. ### Events @@ -2859,7 +2859,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -3003,7 +3003,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -3053,7 +3053,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -3103,7 +3103,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -3153,7 +3153,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | ### Result @@ -3192,7 +3192,7 @@ No Events ## *setAudioAtmosOutputMode* -Sets ATMOS audio output mode (on HDMI0). +Sets ATMOS audio output mode for the specified `audioPort`. Defaults to `HDMI0` output if not specified. On devices which does not have `HDMI0` output, it will apply the setting globally. ### Events @@ -3253,7 +3253,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params?.audioPort | string | *(optional)* Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | | params.audioDelay | string | Delay (in ms) on the selected audio port | ### Result @@ -3305,7 +3305,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params.audioPort | string | Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | | params.audioDelayOffset | string | Delay offset (in ms) on the selected audio port | ### Result @@ -3357,7 +3357,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.bassBoost | integer | Value between 0 and 100, where 0 means no bass boost (disabled) and 100 means max bass boost | ### Result @@ -3398,7 +3398,7 @@ No Events ## *setCurrentResolution* -Sets the current resolution. +Sets the current resolution to specified value. See `getSupportedVideoDisplays` for supported `videoDisplay`. And see `getSupportedResolutions` for supported `resolution`. ### Events @@ -3411,9 +3411,9 @@ Sets the current resolution. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.videoDisplay | string | Video display port name. The default port is `HDMI0` if no port is specified | +| params.videoDisplay | string | Video display port name. See `getConnectedVideoDisplays` for acquiring available list | | params.resolution | string | Video display resolution | -| params?.persist | boolean | *(optional)* Persists the resolution | +| params?.persist | boolean | *(optional)* Persists the resolution across reboots | | params?.ignoreEdid | boolean | *(optional)* Ignore the supported resolutions as transmitted by the connected TV EDID | ### Result @@ -3467,7 +3467,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.enhancerlevel | integer | Value between 0 and 16, where 0 means no enhancement and 16 means maximum enhancement | ### Result @@ -3508,7 +3508,7 @@ No Events ## *setDolbyVolumeMode* -Enables or disables Dolby Volume mode on audio track (audio output port HDMI0). +Enables or disables Dolby Volume mode on audio track (audio output port HDMI0). Only applicable on `STB` profile with `HDMI0`. See `getConnectedAudioPorts` for related status. ### Events @@ -3569,7 +3569,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.DRCMode | integer | Value of 0 or 1, where 0 is Line mode and 1 is RF mode | ### Result @@ -3610,7 +3610,7 @@ No Events ## *setEnableAudioPort* -Enable or disable the specified audio port based on the input audio port name. This feature provides the consumer with a single user control to enable or disable the specified audio port. +This method provides option to enable or disable the specified audio port. ### Events @@ -3621,7 +3621,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params.audioPort | string | Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | | params.enable | boolean | `true` enables the specified audio port. `false` disables the specified audio port | ### Result @@ -3673,7 +3673,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.hdr_mode | boolean | *(optional)* `true` to force the HDR format or `false` to reset the mode to the default | +| params?.hdr_mode | boolean | *(optional)* `true` to force the HDR format or `false` to reset the mode to the default. See response of `getSettopHDRSupport` `result.supportsHDR` and response of `getTvHDRSupport` `result.capabilities` to decide `hdr_mode` on `STB`s. On `TV` devices use the later only | ### Result @@ -3723,7 +3723,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.gain | number | Value between -2080 and 480, where -2080 means negative gain and 480 means maximum gain | ### Result @@ -3775,7 +3775,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.graphicEqualizerMode | integer | Graphic Equalizer mode (`0` = off, `1` = open, `2` = rich, `3` = focused) | ### Result @@ -3827,7 +3827,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.intelligentEqualizerMode | integer | Intelligent Equalizer mode (`0` = unset, `1` = open, `2` = rich, `3` = focused) | ### Result @@ -3879,7 +3879,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.MISteeringEnable | boolean | Whether Media Intelligence Steering is enabled (`true`) or disabled (`false`) | ### Result @@ -3931,7 +3931,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.compresionLevel | integer | Value between 0 and 10, where 0 means no compression and 10 means maximum compression | ### Result @@ -3983,7 +3983,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.ms12AudioProfile | string | An MS12 audio profile name from `getSupportedMS12AudioProfile` | ### Result @@ -4024,7 +4024,7 @@ No Events ## *setMS12ProfileSettingsOverride* -Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode). +Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode) on the specified or current audio out. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -4035,7 +4035,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params.audioPort | string | Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.operation | string | The audio profile state | | params.profileName | string | An MS12 audio profile name from `getSupportedMS12AudioProfile` | | params.ms12SettingsName | string | An ms12 setting name | @@ -4094,7 +4094,7 @@ Mutes or unmutes audio on a specific port. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.muted | boolean | mute or unmute audio | ### Result @@ -4135,7 +4135,7 @@ Mutes or unmutes audio on a specific port. ## *setPreferredColorDepth* -Sets the current color depth for the videoDisplay. +Sets the current color depth for the output `videoDisplay`. . ### Events @@ -4147,7 +4147,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.videoDisplay | string | Video display port name. The default port is `HDMI0` if no port is specified | +| params.videoDisplay | string | Video display port name. See `getConnectedVideoDisplays` for acquiring available list | | params.colorDepth | string | Video display color depth. (must be one of the following: *8 Bit*, *10 Bit*, *12 Bit*, *Auto*) | | params?.persist | boolean | *(optional)* Persists the color depth | @@ -4190,7 +4190,7 @@ No Events ## *setScartParameter* -Sets SCART parameters. +This method allows to configure SCART(Syndicat des Constructeurs d'Appareils Radiorécepteurs et Téléviseurs) specific settings. Possible values: | **Parameter** | **ParameterData** | @@ -4263,7 +4263,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.audioPort | string | Audio port name | +| params?.audioPort | string | *(optional)* Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s | | params.soundMode | string | Sound mode. Possible values: `AUTO (Dolby Digital Plus)`, `AUTO (Dolby Digital 5.1)`, `AUTO (Stereo)`, `MONO`, `STEREO`, `SURROUND`, PASSTHRU | | params?.persist | boolean | *(optional)* persists the sound mode | @@ -4317,7 +4317,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.mode | integer | Enables or disables volume leveling (`0` = off, `1` = on, `2` = auto) | | params.boost | integer | Value between 0 and 96, where 0 means no boost and 96 means maximum boost | @@ -4360,7 +4360,7 @@ No Events ## *setVideoPortStatusInStandby* -Sets the specified video port status to be used in standby mode (failure if the port name is missing). +Sets the specified video port status to be used in standby mode. ### Events @@ -4426,7 +4426,7 @@ Adjusts the Volume Level on a specific port. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.volumeLevel | number | Value between 0 and 100, where 0 means no level and 100 means maximum level | ### Result @@ -4467,7 +4467,7 @@ Adjusts the Volume Level on a specific port. ## *setVolumeLeveller* -(Version 2) Sets the Volume Leveller level. Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources. +(Version 2) Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources. Sets the Volume Leveller mode and level for the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified. ### Events @@ -4478,7 +4478,7 @@ No Events | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified | +| params?.audioPort | string | *(optional)* Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port` | | params.mode | integer | Enables or disables volume leveling (`0` = off, `1` = on, `2` = auto) | | params.level | integer | Value between 0 and 10, where 0 means no level and 10 means maximum level | @@ -4572,7 +4572,7 @@ Sets the current zoom value. ## *getColorDepthCapabilities* -Returns supported color depth capabilities. +Returns supported color depth capabilities of the current video output port(`HDMI0` if available, otherwise `INTERNAL0`, or first available port). ### Events @@ -4587,7 +4587,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result?.getColorDepthCapabilities | array | *(optional)* A string array of supported STB color depth capabilities | +| result?.getColorDepthCapabilities | array | *(optional)* A string array of supported color depth capabilities. `8 bit`, `10 bit`, `12 bit` or `Auto` | | result?.getColorDepthCapabilities[#] | string | *(optional)* | | result.success | boolean | Whether the request succeeded | @@ -4621,7 +4621,7 @@ This method takes no parameters. ## *getSupportedMS12Config* -Returns supported ms12 config by the platform, possible values couldbe CONFG_Z, CONFIG_X, CONFIG_Y, CONFIG_NONE. +Returns supported ms12 config by the platform, possible values: `CONFIG_Z`, `CONFIG_X`, `CONFIG_Y`, `CONFIG_NONE`. ### Events @@ -4636,7 +4636,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.ms12config | string | Supported ms12 config by platforms, possible values, CONFIG_Z, CONFIG_X, CONFIG_Y, CONFIG_NONE | +| result.ms12config | string | Supported ms12 config by platforms, possible values: `CONFIG_Z`, `CONFIG_X`, `CONFIG_Y`, `CONFIG_NONE` | | result.success | boolean | Whether the request succeeded | ### Example diff --git a/tools/json_generator/output/DisplaySettings/DisplaySettings.json b/tools/json_generator/output/DisplaySettings/DisplaySettings.json index e7d1dd90..b89a6043 100644 --- a/tools/json_generator/output/DisplaySettings/DisplaySettings.json +++ b/tools/json_generator/output/DisplaySettings/DisplaySettings.json @@ -2,8 +2,8 @@ "$schema": "https://raw.githubusercontent.com/rdkcentral/entservices-apis/refs/heads/main/tools/md_generator/json2md/schemas/interface.schema.json", "jsonrpc": "2.0", "info": { - "title": "DisplaySettings API", - "class": "DisplaySettings", + "title": "DisplaySettings API", + "class": "DisplaySettings", "description": "The `DisplaySetting` plugin provides an interface for display information such as current video resolution, supported video displays, zoom setting, sound mode, and much more." }, "common": { @@ -47,12 +47,12 @@ "example":"SDR" }, "audioPort0": { - "summary": "Audio port name.", + "summary": "Audio port name. See `getSupportedAudioPorts` for list of `audioPort`s", "type": "string", "example": "HDMI0" }, "audioPort1": { - "summary": "Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). The default port is `HDMI0` if no port is specified.", + "summary": "Audio port name (`HDMI0`, `SPEAKER0`, `SPDIF0`, and so on). See `getSupportedAudioPorts` and `getConnectedAudioPorts` when selecting `port`.", "default": "HDMI0", "type": "string", "example": "SPEAKER0" @@ -126,7 +126,7 @@ "example": true }, "portName": { - "summary": "Video port name", + "summary": "Video port name.", "type":"string", "example": "HDMI0" }, @@ -135,7 +135,7 @@ "type": "string", "example": "1080p" }, - "w":{ + "w":{ "summary":"The width", "type": "number", "example": 1920 @@ -145,7 +145,7 @@ "type": "number", "example": 1080 }, - "progressive":{ + "progressive":{ "summary":"The type of scan signal", "type": "boolean", "example": true @@ -174,7 +174,7 @@ "example": true }, "videoDisplay": { - "summary": "Video display port name. The default port is `HDMI0` if no port is specified", + "summary": "Video display port name. See `getConnectedVideoDisplays` for acquiring available list.", "default": "HDMI0", "type": "string", "example": "HDMI0" @@ -210,12 +210,11 @@ ], "example": "12 Bit" }, - "ms12config": { - "summary": "Supported ms12 config by platforms, possible values, CONFIG_Z, CONFIG_X, CONFIG_Y, CONFIG_NONE", + "ms12config": { + "summary": "Supported ms12 config by platforms, possible values: `CONFIG_Z`, `CONFIG_X`, `CONFIG_Y`, `CONFIG_NONE`", "type": "string", "example": "CONFIG_X" } - }, "methods": { "enableSurroundDecoder":{ @@ -277,10 +276,7 @@ "audioPort": { "$ref": "#/definitions/audioPort0" } - }, - "required": [ - "audioPort" - ] + } }, "result": { "type":"object", @@ -328,7 +324,7 @@ } }, "getAudioFormat": { - "summary": "Returns the currently set audio format.", + "summary": "Returns the currently set audio format as well as all the supported audio formats.", "result": { "type":"object", "properties": { @@ -350,7 +346,7 @@ } }, "getBassEnhancer":{ - "summary": "Returns the current status of the Bass Enhancer settings.", + "summary": "Returns the current status of the Bass Enhancer settings of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -383,7 +379,7 @@ } }, "getConnectedAudioPorts":{ - "summary": "Returns connected audio output ports (a subset of the ports supported on the device). For SPDIF supported platforms, SPDIF port is always considered connected. HDMI port may or may not be connected.", + "summary": "Returns connected audio output ports (a subset of the ports supported on the device). SPDIF port is always considered `connected` on a supported platform. HDMI port may or may not be connected.", "result": { "type":"object", "properties": { @@ -424,32 +420,32 @@ } }, "getCurrentOutputSettings":{ - "summary": "Returns current output settings.", + "summary": "Returns current output settings of `HDMI0` or `INTERNAL0` or the first available port.", "result": { "type":"object", "properties": { "colorSpace": { - "summary": "The color space. Possible values: `0` (dsDISPLAY_COLORSPACE_UNKNOWN), `1` (sDISPLAY_COLORSPACE_RGB, `2` (dsDISPLAY_COLORSPACE_YCbCr422), `3` (dsDISPLAY_COLORSPACE_YCbCr444), `4` (dsDISPLAY_COLORSPACE_YCbCr420), `5` (dsDISPLAY_COLORSPACE_AUTO).", + "summary": "Defines how color information is represented, encoded and displayed. Possible values: `0` (dsDISPLAY_COLORSPACE_UNKNOWN), `1` (sDISPLAY_COLORSPACE_RGB, `2` (dsDISPLAY_COLORSPACE_YCbCr422), `3` (dsDISPLAY_COLORSPACE_YCbCr444), `4` (dsDISPLAY_COLORSPACE_YCbCr420), `5` (dsDISPLAY_COLORSPACE_AUTO).", "type": "integer", "example": 5 }, "colorDepth": { - "summary": "The color depth. The value that is returned from `dsGetCurrentOutputSettings`", + "summary": "The number of bits used for each color channel (e.g., 8-bit, 10-bit, 12-bit). Higher color depth allows more precise color representation. Here the value that is returned from `dsGetCurrentOutputSettings`", "type": "integer", - "example": 0 + "example": 0 }, "matrixCoefficients": { - "summary": "matrix coefficients. Possible values: `0` (dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN), `1` (dsDISPLAY_MATRIXCOEFFICIENT_BT_709), `2` (dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG), `3` (dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M), `4` (dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709), `5` (dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601), `6` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL), `7` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL)", + "summary": "Specifies the mathematical conversion between color spaces (e.g., BT.709, BT.2020). This affects how colors are mapped from one standard to another. Possible values: `0` (dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN), `1` (dsDISPLAY_MATRIXCOEFFICIENT_BT_709), `2` (dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG), `3` (dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M), `4` (dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709), `5` (dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601), `6` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL), `7` (dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL)", "type": "integer", "example": 0 }, "videoEOTF": { - "summary": "HDR standard. Possible values: `0x0` (dsHDRSTANDARD_NONE), `0x01` (dsHDRSTANDARD_HDR10), `0x02` (dsHDRSTANDARD_HLG), `0x04` (dsHDRSTANDARD_DolbyVision), `0x08` (dsHDRSTANDARD_TechnicolorPrime), `0x10` (dsHDRSTANDARD_HDR10PLUS), `0x20` (dsHDRSTANDARD_SDR), `0x80` (dsHDRSTANDARD_Invalid)", + "summary": "Current EOTF (Electro-Optical Transfer Function) also known as HDR standard. Possible values: `0x0` (dsHDRSTANDARD_NONE), `0x01` (dsHDRSTANDARD_HDR10), `0x02` (dsHDRSTANDARD_HLG), `0x04` (dsHDRSTANDARD_DolbyVision), `0x08` (dsHDRSTANDARD_TechnicolorPrime), `0x10` (dsHDRSTANDARD_HDR10PLUS), `0x20` (dsHDRSTANDARD_SDR), `0x80` (dsHDRSTANDARD_Invalid)", "type": "integer", "example": 0 }, "quantizationRange": { - "summary": "The supported quantization range", + "summary": "The range of values used to represent color (e.g., limited range `16 to 235`, full range `0 to 255`). It affects contrast and black/white levels. Current supported quantization range.", "type": "integer", "example": 235 }, @@ -467,7 +463,7 @@ } }, "getCurrentResolution":{ - "summary": "Returns the current resolution on the selected video display port.", + "summary": "Returns the current resolution on the selected video display port. Defaults to `HDMI0` if available, otherwise `INTERNAL0`, or first available port if not specified.", "params": { "type":"object", "properties": { @@ -485,13 +481,13 @@ "resolution": { "$ref": "#/definitions/resolution" }, - "w":{ + "w":{ "$ref": "#/definitions/w" }, "h":{ "$ref": "#/definitions/h" }, - "progressive":{ + "progressive":{ "$ref": "#/definitions/progressive" }, "success": { @@ -499,20 +495,20 @@ } }, "required": [ - "resolution", - "w", - "h", + "resolution", + "w", + "h", "success" ] } }, "getDefaultResolution":{ - "summary": "Gets the default resolution supported by the HDMI0 video output port.", + "summary": "Gets the default resolution supported by the current video output port.", "result": { "type":"object", "properties": { "defaultResolution": { - "summary": "Default resolution supported by the HDMI0 video output port", + "summary": "Default resolution supported by the current video output port", "type":"string", "example":"720p" }, @@ -579,7 +575,7 @@ } }, "getDRCMode":{ - "summary": "Returns the current Dynamic Range Control mode.", + "summary": "Returns the current Dynamic Range Control mode of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -609,7 +605,7 @@ } }, "getEnableAudioPort": { - "summary": " Returns the current status of the specified input audio port.", + "summary": "Returns the current status of the specified audio port. If not specified, defaults `audioPort` to `HDMI0`.", "params": { "type":"object", "properties": { @@ -640,7 +636,7 @@ } }, "setAssociatedAudioMixing":{ - "summary": "Sets the Associated Audio Mixing Enable/Disable.", + "summary": "Sets the Associated Audio Mixing `Enable/Disable` on the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -662,7 +658,7 @@ } }, "getAssociatedAudioMixing":{ - "summary": "Returns the Associated Audio Mixing status.", + "summary": "Returns the Associated Audio Mixing status of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -693,7 +689,7 @@ } }, "setFaderControl":{ - "summary": "Sets the set the mixerbalance betweeen main and associated audio.", + "summary": "Sets the configured `mixerBalance` betweeen main and associated audio on the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else applies globally using `Host::setFaderControl()`.", "params": { "type":"object", "properties": { @@ -715,7 +711,7 @@ } }, "getFaderControl":{ - "summary": "Returns the mixerbalance betweeen main and associated audio", + "summary": "Returns the mixerbalance betweeen main and associated audio on the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global mixer balance from `Host::getFaderControl()`.", "params": { "type":"object", "properties": { @@ -745,8 +741,8 @@ ] } }, - "setPrimaryLanguage":{ - "summary": "Sets the Primary language", + "setPrimaryLanguage":{ + "summary": "Sets the Primary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` output if not specified when available. Else applies globally with `Host::setPrimaryLanguage()`.", "params": { "type":"object", "properties": { @@ -767,8 +763,8 @@ "$ref": "#/common/result" } }, - "getPrimaryLanguage":{ - "summary": "Returns the Primary language", + "getPrimaryLanguage":{ + "summary": "Returns the Primary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global primary language from `Host::getPrimaryLanguage()`.", "params": { "type":"object", "properties": { @@ -798,8 +794,8 @@ ] } }, - "setSecondaryLanguage":{ - "summary": "Sets the secondary language", + "setSecondaryLanguage":{ + "summary": "Sets the secondary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` output if not specified when available. Else applies globally with `Host::setSecondaryLanguage()`.", "params": { "type":"object", "properties": { @@ -820,8 +816,8 @@ "$ref": "#/common/result" } }, - "getSecondaryLanguage":{ - "summary": "Returns the Secondary language", + "getSecondaryLanguage":{ + "summary": "Returns the Secondary language for the specified `audioPort`. Defaults `audioPort` to `HDMI0` when device has HDMI out port present and not specified. Else returns the global secondary language from `Host::getSecondaryLanguage()`.", "params": { "type":"object", "properties": { @@ -1077,7 +1073,7 @@ } }, "getPreferredColorDepth":{ - "summary": "Returns the current color depth on the selected video display port.", + "summary": "Returns the current color depth on the specified `videoDisplay` port. Defaults to `HDMI0` if available, otherwise `INTERNAL0`, or first available port if not specified.", "params": { "type":"object", "properties": { @@ -1109,7 +1105,7 @@ } }, "getSettopAudioCapabilities":{ - "summary": "Returns the set-top audio capabilities for the specified audio port.", + "summary": "Returns the set-top audio capabilities for the specified output `audioPort`. If not specified, defaults to `HDMI0`.", "params": { "type":"object", "properties": { @@ -1166,7 +1162,7 @@ } }, "getSettopMS12Capabilities":{ - "summary": "Returns the set-top MS12 audio capabilities for the specified audio port.", + "summary": "Returns the set-top MS12 audio capabilities for the specified output `audioPort`. If not specified, defaults to `HDMI0`.", "params": { "type":"object", "properties": { @@ -1200,7 +1196,7 @@ } }, "getSinkAtmosCapability":{ - "summary": "Returns the ATMOS capability of the sink (HDMI0).", + "summary": "Returns the ATMOS capability of the specified `audioPort` sink. Defaults to `HDMI0` if not specified on `STB` and on `TV` it returns the ATMOS capability of the current output port, e.g: `ARC`. See `getConnectedAudioPorts` and `getSupportedAudioPorts` for possible values.", "params": { "type":"object", "properties": { @@ -1429,7 +1425,7 @@ "items" : { "type": "string", "example": "1080p" - } + } }, "success": { "$ref": "#/common/success" @@ -1465,7 +1461,7 @@ } }, "getSurroundVirtualizer":{ - "summary": "(Version 1) Returns the current surround virtualizer boost settings.", + "summary": "(Version 1) Returns the current surround virtualizer boost settings of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -1500,7 +1496,7 @@ } }, "getSurroundVirtualizer":{ - "summary": "(Version 2) Returns the current surround virtualizer boost settings.", + "summary": "(Version 2) Returns the current surround virtualizer boost settings of the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -1597,7 +1593,7 @@ } }, "getVideoPortStatusInStandby":{ - "summary": "Returns video port status in standby mode (failure if the port name is missing).", + "summary": "Returns video port status in standby mode.", "params": { "type": "object", "properties": { @@ -1661,7 +1657,7 @@ } }, "getVolumeLeveller": { - "summary": "(Version 1)Returns the current Volume Leveller setting.", + "summary": "(Version 1)Returns the current Volume Leveller setting of specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -1696,7 +1692,7 @@ } }, "getVolumeLeveller": { - "summary": "(Version 2) Returns the current Volume Leveller setting.", + "summary": "(Version 2) Returns the current Volume Leveller setting of specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -1747,7 +1743,7 @@ } }, "isConnectedDeviceRepeater":{ - "summary": "Indicates whether the device connected to the HDMI0 video output port is an HDCP repeater.", + "summary": "Indicates whether the device connected to the current video output port is an HDCP repeater.", "result": { "type":"object", "properties": { @@ -1851,7 +1847,7 @@ "required": [ "success" ] - } + } }, "resetDialogEnhancement":{ "summary":"Resets the dialog enhancer level to its default enhancer level.", @@ -1876,7 +1872,7 @@ "required": [ "success" ] - } + } }, "resetSurroundVirtualizer":{ "summary":"Resets the surround virtualizer to its default boost value.", @@ -1926,10 +1922,10 @@ "required": [ "success" ] - } + } }, "setAudioAtmosOutputMode":{ - "summary": "Sets ATMOS audio output mode (on HDMI0).", + "summary": "Sets ATMOS audio output mode for the specified `audioPort`. Defaults to `HDMI0` output if not specified. On devices which does not have `HDMI0` output, it will apply the setting globally.", "params": { "type":"object", "properties": { @@ -1946,7 +1942,7 @@ "result": { "$ref": "#/common/result" } - }, + }, "setAudioDelay":{ "summary": "Sets the audio delay (in ms) on the selected audio port. If the `audioPort` argument is not specified, it will browse all ports (checking HDMI0 first). If there is no display connected, then it defaults to `HDMI0`.", "params": { @@ -1960,7 +1956,6 @@ } }, "required": [ - "audioPort", "audioDelay" ] }, @@ -2010,7 +2005,7 @@ } }, "setCurrentResolution":{ - "summary": "Sets the current resolution.", + "summary": "Sets the current resolution to specified value. See `getSupportedVideoDisplays` for supported `videoDisplay`. And see `getSupportedResolutions` for supported `resolution`.", "events":{ "resolutionPreChange" : "Triggered when the resolution of the video display is about to change.", "resolutionChanged" : "Triggered when the resolution is changed by the user and returns the current resolution." @@ -2025,7 +2020,7 @@ "$ref": "#/definitions/resolution" }, "persist": { - "summary":"Persists the resolution", + "summary":"Persists the resolution across reboots", "type": "boolean", "example": true }, @@ -2066,7 +2061,7 @@ } }, "setDolbyVolumeMode":{ - "summary": "Enables or disables Dolby Volume mode on audio track (audio output port HDMI0).", + "summary": "Enables or disables Dolby Volume mode on audio track (audio output port HDMI0). Only applicable on `STB` profile with `HDMI0`. See `getConnectedAudioPorts` for related status.", "params": { "type":"object", "properties": { @@ -2105,7 +2100,7 @@ } }, "setEnableAudioPort": { - "summary": "Enable or disable the specified audio port based on the input audio port name. This feature provides the consumer with a single user control to enable or disable the specified audio port.", + "summary": "This method provides option to enable or disable the specified audio port.", "params": { "type":"object", "properties": { @@ -2133,7 +2128,7 @@ "type": "object", "properties": { "hdr_mode": { - "summary": "`true` to force the HDR format or `false` to reset the mode to the default.", + "summary": "`true` to force the HDR format or `false` to reset the mode to the default. See response of `getSettopHDRSupport` `result.supportsHDR` and response of `getTvHDRSupport` `result.capabilities` to decide `hdr_mode` on `STB`s. On `TV` devices use the later only.", "type": "boolean", "example": true } @@ -2269,7 +2264,7 @@ } }, "setMS12ProfileSettingsOverride":{ - "summary": "Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode)", + "summary": "Overrides individual MS12 audio settings in order to optimize the customer experience (for example, enabling dialog enhancement in sports mode) on the specified or current audio out. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -2333,7 +2328,7 @@ } }, "setPreferredColorDepth":{ - "summary": "Sets the current color depth for the videoDisplay.\n", + "summary": "Sets the current color depth for the output `videoDisplay`.\n", "params": { "type": "object", "properties": { @@ -2359,7 +2354,7 @@ } }, "setScartParameter":{ - "summary": "Sets SCART parameters. \n \nPossible values: \n| **Parameter** | **ParameterData** | \n| `aspect_ratio` | `4x3` or `16x9` | \n| `tv_startup` | `on` or `off` | \n| `rgb` | `on` (disables cvbs) | \n| `cvbs` | `on` (disables rgb) | \n| `macrovision` | not implemented | \n| `cgms` | `disabled`, `copyNever`, `copyOnce`, `copyFreely`, or `copyNoMore` | \n| `port` | `on` or `off` |", + "summary": "This method allows to configure SCART(Syndicat des Constructeurs d'Appareils Radiorécepteurs et Téléviseurs) specific settings.\n \nPossible values: \n| **Parameter** | **ParameterData** | \n| `aspect_ratio` | `4x3` or `16x9` | \n| `tv_startup` | `on` or `off` | \n| `rgb` | `on` (disables cvbs) | \n| `cvbs` | `on` (disables rgb) | \n| `macrovision` | not implemented | \n| `cgms` | `disabled`, `copyNever`, `copyOnce`, `copyFreely`, or `copyNoMore` | \n| `port` | `on` or `off` |", "params": { "type":"object", "properties": { @@ -2401,7 +2396,6 @@ } }, "required": [ - "audioPort", "soundMode" ] }, @@ -2454,7 +2448,7 @@ } }, "setVideoPortStatusInStandby":{ - "summary": "Sets the specified video port status to be used in standby mode (failure if the port name is missing).", + "summary": "Sets the specified video port status to be used in standby mode.", "params": { "type": "object", "properties": { @@ -2513,7 +2507,7 @@ } }, "setVolumeLeveller":{ - "summary": "(Version 1)Sets the Volume Leveller level. Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources.", + "summary": "(Version 1)Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources. Sets the Volume Leveller level for the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -2533,7 +2527,7 @@ } }, "setVolumeLeveller":{ - "summary": "(Version 2) Sets the Volume Leveller level. Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources.", + "summary": "(Version 2) Volume Leveller is an advanced volume-control solution that maintains consistent playback levels for content from different sources. Sets the Volume Leveller mode and level for the specified `audioPort`. Defaults `audioPort` to `HDMI0` if not specified.", "params": { "type":"object", "properties": { @@ -2577,12 +2571,12 @@ } }, "getColorDepthCapabilities": { - "summary": "Returns supported color depth capabilities.", + "summary": "Returns supported color depth capabilities of the current video output port(`HDMI0` if available, otherwise `INTERNAL0`, or first available port).", "result": { "type":"object", "properties": { "getColorDepthCapabilities": { - "summary": "A string array of supported STB color depth capabilities", + "summary": "A string array of supported color depth capabilities. `8 bit`, `10 bit`, `12 bit` or `Auto`.", "type": "array", "items": { "type": "string", @@ -2599,7 +2593,7 @@ } }, "getSupportedMS12Config":{ - "summary": "Returns supported ms12 config by the platform, possible values couldbe CONFG_Z, CONFIG_X, CONFIG_Y, CONFIG_NONE", + "summary": "Returns supported ms12 config by the platform, possible values: `CONFIG_Z`, `CONFIG_X`, `CONFIG_Y`, `CONFIG_NONE`", "result": { "type":"object", "properties": {