RDK

RDK Resources

RDK Preferred

Code Management Facility

Code Releases

RDK Forums

[RDK Conferences]

RDK Support

Archives

Papers & Presentations Archive

In the News!

Skip to end of metadata
Go to start of metadata

Versions

org.rdk.DisplaySettings.1 - The DisplaySetting plugin is used to get the display information like currentVideoResolution, SupportedVideoDisplays, ZoomSetting, SoundMode, ConnectedVideoDisplays, etc.

Methods

enableSurroundDecoder (v1)

Description: Enables/Disables Surround Decoder capability

The Surround Decoder is an upmixer that takes stereo music content, or surround-encoded two-channel
movie content, and creates a high-quality multichannel upmix. If the Surround Decoder is enabled, two-channel signals and 5.1-channel signals are upmixed to 5.1.2.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • surroundDecoderEnable: bool - enable/disable Surround Decoder

Returns:

  • success: bool - result of enabling/disabling surround decoder


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.enableSurroundDecoder", "params":{"audioPort":"SPEAKER0","surroundDecoderEnable":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

getActiveInput (v1)

Description: Returns true if the STB HDMI output is currently connected to the active input of the sink device (determined by RxSense). If the STB does not support RxSense, this API always returns true. Specificly,

true
  • STB is connected to the TV's active Input, or
  • Unable to determine if STB is connected to the TV's active input or not (because STB does not support RxSense)
false
  • STB is not connected to the TV's active Input, or
  • TV is OFF

Arguments:

  • videoDisplay: string - video display port name (HDMI0 if no argument specified)

Returns:

  • activeInput: bool - determines, whether selected input is active or not (see Description)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getActiveInput", "params":{"videoDisplay":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"activeInput":false,"success":true}}

getAudioDelay (v1)

Description: Returns the audio delay (in ms) on the selected audio port. If audioPort argument is not specified it will browse all ports (checking HDMI0 first). In case of no display connected it deafults to HDMI0.

Arguments:

  • audioPort: string - audio port name to be checked for the delay

Returns:

  • audioDelay: string - delay (in ms) on the selected audio port
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getAudioDelay", "params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"audioDelay":"0","success":true}}

getAudioDelayOffset (v1)

Description: Returns the audio delay offset (in ms) on the selected audio port. If audioPort argument is not specified it will browse all ports (checking HDMI0 first). In case of no display connected it deafults to HDMI0.

Arguments:

  • audioPort: string - audio port name to be checked for the delay offset

Returns:

  • audioDelayOffset: string - delay offset (in ms) on the selected audio port
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getAudioDelayOffset", "params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"audioDelayOffset":"0","success":true}}

getBassEnhancer (v1)

Description: Returns the current status of Bass Enhancer setting 

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • enable: bool -  true if bass enhancer is enabled (bass boost > 0 ), otherwise false
  • bassBoost: int -  value between 0 and 100, where 0 means no bass boost (bassEnhancer disabled) and 100 means max bass boost
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getBassEnhancer", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"bassBoost":100,"success":true}}

getConnectedAudioPorts (v1)

Description: Returns connected audio output ports (a subset of ports supported on the device).  SPDIF port is always considered connected. HDMI port may or may not be connected. 

Arguments: none

Returns:

  • connectedAudioPorts: array of strings - array of connected audio port names
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getConnectedAudioPorts"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"connectedAudioPorts":["HDMI0"],"success":true}}

getConnectedVideoDisplays (v1)

Description: Returns connected video displays.

Arguments: none

Returns:

  • connectedVideoDisplays: array of strings - array of connected video display port names
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getConnectedVideoDisplays"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"connectedVideoDisplays":["HDMI0"],"success":true}}

getCurrentOutputSettings (v1)

Description: Returns current output settings.

Arguments: none

Returns:

  • colorSpace: int - color space. Possible values: dsDISPLAY_COLORSPACE_UNKNOWN = 0, dsDISPLAY_COLORSPACE_RGB = 1, dsDISPLAY_COLORSPACE_YCbCr422 = 2, dsDISPLAY_COLORSPACE_YCbCr444 = 3, dsDISPLAY_COLORSPACE_YCbCr420 = 4, dsDISPLAY_COLORSPACE_AUTO = 5.
  • colorDepth: int - the color depth. Value returned from dsGetCurrentOutputSettings call.
  • matrixCoefficients: int - matrix coefficients. Possible values: dsDISPLAY_MATRIXCOEFFICIENT_UNKNOWN = 0, dsDISPLAY_MATRIXCOEFFICIENT_BT_709 = 1, dsDISPLAY_MATRIXCOEFFICIENT_BT_470_2_BG = 2, dsDISPLAY_MATRIXCOEFFICIENT_SMPTE_170M = 3, dsDISPLAY_MATRIXCOEFFICIENT_XvYCC_709 = 4, dsDISPLAY_MATRIXCOEFFICIENT_eXvYCC_601 = 5, dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_NCL = 6, dsDISPLAY_MATRIXCOEFFICIENT_BT_2020_CL = 7
  • videoEOTF: int - HDR standard. Possible values: dsHDRSTANDARD_NONE = 0x0, dsHDRSTANDARD_HDR10 = 0x01, dsHDRSTANDARD_HLG = 0x02, dsHDRSTANDARD_DolbyVision = 0x04, dsHDRSTANDARD_TechnicolorPrime = 0x08, dsHDRSTANDARD_Invalid = 0x80
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getCurrentOutputSettings"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"colorSpace":5,"colorDepth":0,"matrixCoefficients":0,"videoEOTF":0,"success":true}}

getCurrentResolution (v1)

Description: Returns the current resolution on the selected video display port.

Arguments:

  • videoDisplay: string - video display port name (HDMI0 if no argument specified)

Returns:

  • resolution: string - current resolution
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getCurrentResolution", "params":{"videoDisplay":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"resolution":"720p","success":true}}

getDefaultResolution (v1)

Description: Gets default resolution supported by the HDMI0 video output port

Arguments: none

Returns:

  • defaultResolution: string - default resolution supported by the HDMI0 video output port
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getDefaultResolution"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"defaultResolution":"720p","success":true}}

getDialogEnhancement (v1)

Description: Returns the JSON object for current Dialog Enhancer Level setting (port HDMI0).

Arguments: none

Returns:

  • enable: bool - true if Dialog Enhancer Mode is enabled, otherwise false
  • enhancerlevel: int - value between 0 and 16, where 0 means no enhancement and 16 means maximum enhancement
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getDialogEnhancement"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":false,"enhancerlevel":0,"success":true}}

getDolbyVolumeMode (v1)

Description: Returns the current status of Dolby Volume (audio output port HDMI0).

Arguments: none

Returns:

  • dolbyVolumeMode: bool -  indicates, whether Dolby Volume mode is enabled or not
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getDolbyVolumeMode"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"dolbyVolumeMode":true,"success":true}}

getDRCMode (v1)

Description: Returns the JSON object for current Dynamic Range Control Mode 

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • DRCMode: string - value "line" or "RF"
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getDRCMode", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"DRCMode":"line","success":true}}

getEnableAudioPort (v1)

Description: Returns the current port enable status of specified input audioPort

Arguments: 

  • audioPort: string - audio port ID. Possible values are ("HDMI_ARC0", "SPDIF0", "SPEAKER0",  "HEADPHONE0", etc). If no port is specified, it returns an error.

Returns:

  • enable: bool -  true means, specified audioPort is enabled. false means, specified audioPort is disabled.
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getEnableAudioPort","params":{"audioPort":"HDMI_ARC0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"success":true}}

getGain (v1)

Description: Returns the JSON object for current gain

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • gain: float - value between 0 and 100, where 0 means no level and 100 means maximum
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getGain", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"gain":"10.000000","success":true}}

getGraphicEqualizerMode (v1)

Description: Returns the JSON object for current Graphic Equalizer Mode setting (port HDMI0).

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • enable: bool - true if Graphic Equalizer Mode is enabled, otherwise false
  • mode: int - Graphic Equalizer mode (1 = open, 2 = rich, 3 = focused, 0 = Off)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getGraphicEqualizerMode"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"mode":2,"success":true}}

getIntelligentEqualizerMode (v1)

Description: Returns the JSON object for current Intelligent Equalizer Mode setting (port HDMI0).

Arguments: none

Returns:

  • enable: bool - true if Intelligent Equalizer Mode is enabled, otherwise false
  • mode: int - Intelligent Equalizer mode (1 = open, 2 = rich, 3 = focused, 0 in case of error)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getIntelligentEqualizerMode"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"mode":2,"success":true}}

getMISteering (v1)

Description: Returns the current status of Media Intelligence setting 

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • MISteeringEnable: bool -  indicates, whether Media Intelligence is enabled or not
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getMISteering", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"MISteeringEnable":true,"success":true}}

getMS12AudioCompression (v1)

Description: Returns the current audio compression settings.

Arguments: none

Returns:

  • enable: bool - true if audio compression is enabled, otherwise false.
  • compressionlevel: int - level of the compression (0 - no compression, 10 - maximum compression)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getMS12AudioCompression"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"compressionlevel":5,"enable":true,"success":true}}

getMS12AudioProfile(v1)

Description: Returns currently set MS12 Audio profile

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • ms12AudioProfile: string - currently set MS12 Audio profile name.  (From the list returned by getSupportedMS12AudioProfile)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0","id":"3","method": "org.rdk.DisplaySettings.1.getMS12AudioProfile", "params":{"audioPort":"SPEAKER0"}}


Response: {"jsonrpc":"2.0","id":3,"result":{"ms12AudioProfile":"Game","success":true}}


getMuted (v1)

Description: Returns if audio is muted or not on a given port 

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • muted: bool -  indicates, whether audio is muted on a specific port
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getMuted", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"muted":true,"success":true}}

getSettopAudioCapabilities (v1)

Description: Returns the set-top audio capabilities for the specified audio port

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • audioCapabilities: string [] of audio capabilities
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSettopAudioCapabilities","params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"audioCapabilities":["ATMOS","DOLBY DIGITAL","DOLBYDIGITAL PLUS","MS12"],"success":true}}

getSettopHDRSupport (v1)

Description: Returns an HDR Support object (list of standards that the STB supports).

Arguments: none

Returns:

  • standards: array of strings - HDR capabilities. Possible values: "none", "HDR10", "Dolby Vision", "Technicolor Prime".
  • supportsHDR: bool - indicates support for HDR
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSettopHDRSupport"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportsHDR":true,"standards":["HDR10","Dolby Vision","Technicolor Prime"],"success":true}}

getSettopMS12Capabilities (v1)

Description: Returns the set-top MS12 audio capabilities for the specified audio port

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • ms12Capabilities: string [] of audio capabilities
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSettopMS12Capabilities","params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"ms12Capabilities":["Dolby Volume","Inteligent Equalizer","Dialogue Enhancer"],"success":true}}

getSinkAtmosCapability (v1)

Description: Gets the Atmos capability of the sink (HDMI0).

Arguments: none

Returns:

  • atmos_capability: int - Atmos capability. Values are the same as in getIntelligentEqualizerMode (1 = open, 2 = rich, 3 = focused, 0 in case of error)
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSinkAtmosCapability"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"atmos_capability":2,"success":true}}

getSoundMode (v1)

Description: Returns the sound mode for the incoming video display. If argument is Null or empty (although not recommended), this returns the output mode of all connected ports, whichever is connected, while giving priority to HDMI port. In case of video display not connected it returns "Stereo" as safe default.

Arguments:

  • audioPort: string - audio port name (missing or empty value will browse all ports)

Returns:

  • soundMode: string - current sound mode. Possible values: "AUTO (Dolby Digital Plus)", "AUTO (Dolby Digital 5.1)", "AUTO (Stereo)", "SURROUND", "STEREO".
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSoundMode", "params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"soundMode":"STEREO","success":true}}

getSupportedAudioModes

Description: Returns a list of strings containing the supported audio modes. If Null or empty, this returns the supported audio modes of the audio processor (regardless of the the output port). 
If a port name is specified, this returns the audio output modes supported by the connected sink device (EDID based)
If the port is not connected, the return value is same as if Null is specified as parameter

For Auto mode in DS5, this API has the following extra specification:

  1. for HDMI port, if connected, this API returns "Stereo" mode and "Auto" Mode;
  2. for HDMI port, if not connected, this API returns "Stereo" mode and "Dolby Digital 5.1" Mode;
  3. for SPDIF port this API always returns "Stereo" mode and "Dolby Digital 5.1" Mode;
  4. when Auto Mode is returned, it includes in parenthesis the best soundMode that the STB can output and the connected sink device can support, in the format of "AUTO (<Best Format>")
    For example, if the connected device supports Surround, the auto mode string should be "AUTO (Dolby Digital 5.1)"

Arguments:

  • audioPort: string - name of the audio port

Returns:

  • supportedAudioModes: array of strings - list of supported audio modes
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedAudioModes", "params":{"audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedAudioModes":["STEREO","PASSTHRU","AUTO (Stereo)"],"success":true}}

getSupportedAudioPorts (v1)

Description: Returns all audio ports supported on the device (all ports that are physically present).

Arguments: none

Returns:

  • supportedAudioPorts: array of strings - array of supported audio ports
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedAudioPorts"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedAudioPorts":["HDMI0"],"success":true}}

getSupportedMS12AudioProfiles (v1)

Description: Returns list of platform supported MS12 Audio profiles

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • supportedMS12AudioProfiles: array of strings - array of supported MS12 Audio profiles

  • success: bool - result of the request


Request: {"jsonrpc":"2.0","id":"3","method": "org.rdk.DisplaySettings.1.getSupportedMS12AudioProfiles", "params":{"audioPort":"SPEAKER0"}}


Response: {"jsonrpc":"2.0","id":3,"result":{"supportedMS12AudioProfiles":["Off","Music","Movie","Game","Voice","Night","User"],"success":true}}

getSupportedResolutions (v1)

Description: Returns supported resolutions on selected video display port (both TV and STB) by its name.

Arguments:

  • videoDisplay: string - video display port name (HDMI0 if no argument specified)

Returns:

  • supportedResolutions: array of strings - array of supported resolutions on selected video display port
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedResolutions", "params":{"videoDisplay":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedResolutions":["720p","1080i","1080p60"],"success":true}}

getSupportedSettopResolutions (v1)

Description: Returns supported STB resolutions.

Arguments: none

Returns:

  • supportedSettopResolutions: array of strings - array of supported STB resolutions
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedSettopResolutions"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedSettopResolutions":["720p","1080i","1080p60","2160p30","2160p60"],"success":true}}

getSupportedTvResolutions (v1)

Description: Returns supported TV resolutions on the selected video display port.

Arguments:

  • videoDisplay: string - video display port name (HDMI0 if no argument specified)

Returns:

  • supportedTvResolutions: array of strings - array of supported TV resolutions
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedTvResolutions", "params":{"videoDisplay":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedTvResolutions":["480i","480p","576i","576p","720p","1080i","1080p"],"success":true}}

getSupportedVideoDisplays (v1)

Description: Returns all video ports supported on the device (all ports that are physically present).

Arguments: none

Returns:

  • supportedVideoDisplays: array of strings - array of supported video display ports
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedVideoDisplays"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedVideoDisplays":["HDMI0"],"success":true}}

getSurroundVirtualizer (v1)

Description: Returns the JSON object for current surround virtualizer boost

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • enable: bool - true if Volume Leveller is enabled, otherwise false
  • boost: int - value between 0 and 96, where 0 means no boost and 96 means maximum boost
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSurroundVirtualizer", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"boost":90,"success":true}}

getTVHDRCapabilities (v1)

Description: Gets HDR capabilities supported by the TV. The following values (OR-ed value) are possible:


0HDRSTANDARD_NONE
1HDRSTANDARD_HDR10
2HDRSTANDARD_HLG
4HDRSTANDARD_DolbyVision
8HDRSTANDARD_TechnicolorPrime


Arguments: none

Returns:

  • capabilities: int - OR-ed value of supported HDR standards by the TV
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getTVHDRCapabilities"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"capabilities":3,"success":true}}

getTvHDRSupport (v1)

Description: Returns an HDR Support object (list of standards that the TV supports).

Arguments: none

Returns:

  • standards: array of strings - HDR capabilities. Possible values: "none", "HDR10", "Dolby Vision", "Technicolor Prime".
  • supportsHDR: bool - indicates support for HDR
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getTvHDRSupport"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportsHDR":false,"standards":["none"],"success":true}}

getVideoPortStatusInStandby (v1)

Description: Returns video port status in standby mode.

Arguments:

  • portName: string - video port name (failure in case of missing)

Returns:

  • videoPortStatusInStandby: bool - video port status (enabled/disabled) in standby mode
  • success: bool - result of the request
  • error_message: string - error message in case of failure


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getVideoPortStatusInStandby", "params":{"portName":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"videoPortStatusInStandby":false,"success":true}}

getVolumeLevel (v1)

Description: Returns the JSON object for current volume level

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • volumeLevel: float - value between 0 and 100, where 0 means no level and 100 means maximum
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getVolumeLevel", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"volumeLevel":50,"success":true}}

getVolumeLeveller (v1)

Description: Returns the JSON object for current Volume Leveller amount 

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • enable: bool - true if Volume Leveller is enabled, otherwise false
  • level: int - value between 0 and 10, where 0 means no level and 10 means maximum amount
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getVolumeLeveller", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"enable":true,"level":9,"success":true}}

getZoomSetting (v1)

Description: Returns the current zoom setting value.

Arguments: none

Returns:

  • zoomSetting: string - current zoom setting. Possible values: "FULL",  "NONE,"  "Letterbox 16x9", "Letterbox 14x9", "CCO", "PanScan", "Letterbox 2.21 on 4x3", "Letterbox 2.21 on 16x9", "Platform", "Zoom 16x9", "Pillarbox 4x3", "Widescreen 4x3" .
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getZoomSetting"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"zoomSetting":"FULL","success":true}}

isConnectedDeviceRepeater (v1)

Description: Indicates whether the device connected to the HDMI0 video output port is an HDCP repeater

Arguments: none

Returns:

  • HdcpRepeater: bool - true if the device is an HDCP repeater otherwise false 
  • success: bool - result of the request


Request: {"jsonrpc":"2.0","id":"3","method": "org.rdk.DisplaySettings.1.isConnectedDeviceRepeater"}


Response: {"jsonrpc":"2.0","id":3,"result":{"HdcpRepeater":false,"success":true}}

isSurroundDecoderEnabled (v1)

Description: Returns the current status of Surround Decoer

Arguments: 

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.

Returns:

  • surroundDecoderEnable: bool -  indicates, whether Surround Decoder is enabled or not
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.isSurroundDecoderEnabled", "params":{"audioPort":"SPEAKER0"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"surroundDecoderEnable":true,"success":true}}

readEDID (v1)

Description: Reads the EDID from the connected HDMI (output) device.  Returns a key of "EDID" with a value of the base64 encoded byte array string representing the EDID.

Arguments: none

Returns:

  • EDID: string - base64 encoded byte array string representing the EDID
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.readEDID"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"EDID":"AP///////wAQrMLQVEJTMQUdAQOANR546q11qVRNnSYPUFSlSwCBALMA0QBxT6lAgYDRwAEBVl4AoKCgKVAwIDUADighAAAaAAAA/wBNWTNORDkxVjFTQlQKAAAA/ABERUxMIFAyNDE4RAogAAAA/QAxVh1xHAAKICAgICAgARsCAxuxUJAFBAMCBxYBBhESFRMUHyBlAwwAEAACOoAYcTgtQFgsRQAOKCEAAB4BHYAYcRwWIFgsJQAOKCEAAJ6/FgCggDgTQDAgOgAOKCEAABp+OQCggDgfQDAgOgAOKCEAABoAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA2A","success":true}}

readHostEDID (v1)

Description: Reads the EDID of the host (STB). Returns a key of "EDID" with a value of the base64 encoded raw byte array string representing the EDID.

Arguments: none

Returns:

  • EDID: string - base64 encoded byte array string representing the EDID
  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.readHostEDID"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"EDID":"AP///////wAIbSV0Z0UjARgYAQOAgEh4Ctr/o1hKoikXSUsgAAAxQAEBAQEBAQEBAQEBAQEBBHQAMPJwWoCwWIoAuoghAAAeAjqAGHE4LUBYLEUAuoghAAAeAAAA/ABCcm9hZGNvbSAxLjAKAAAA/QAXPQ+IHgAKICAgICAgAR8CAzvwSxAFICIEAwIHBl1fIwkHAXcDDABAALg8IchqAQMEgUEAFgYIAFZYAGfYXcQBPAAA4gBL4w8AAAEdgBhxHBYgWCwlALqIIQAAnlZeAKCgoClQMCA1ALqIIQAAGmYhVqpRAB4wRo8zALqIIQAAHgAAAAAAAAAAAAAAAAAA4g","success":true}}

setAudioAtmosOutputMode (v1)

Description: Sets Atmos audio output mode (on HDMI0)

Arguments:

  • enable: bool - enable/disable Atmos audio output mode (failure in case of missing)

Returns:

  • success: bool - result of enabling/disabling Atmos audio output mode


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setAudioAtmosOutputMode", "params":{"enable":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setAudioDelay (v1)

Description: Sets the audio delay (in ms) on the selected audio port. If audioPort argument is not specified it will browse all ports (checking HDMI0 first). In case of no display connected it deafults to HDMI0. 

Arguments:

  • audioDelay: string - delay (in ms) on the audio port (failure in case of missing)
  • audioPort: string - audio port name

Returns:

  • success: bool - result of setting audio port delay


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setAudioDelay", "params":{"audioDelay":"50", "audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setAudioDelayOffset (v1)

Description: Sets the audio delay offset (in ms) on the selected audio port. If audioPort argument is not specified it will browse all ports (checking HDMI0 first). In case of no display connected it defaults to HDMI0. 

Arguments:

  • audioDelayOffset: string - delay offset (in ms) on the audio port (failure in case of missing)
  • audioPort: string - audio port name

Returns:

  • success: bool - result of setting audio port delay offset


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setAudioDelayOffset", "params":{"audioDelayOffset":"50", "audioPort":"HDMI0"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setBassEnhancer (v1)

Description: Sets the Bass Enhancer

Bass Enhancer feature provides the consumer a single control to apply a fixed bass boost to correct for a lack of bass reproduction in the playback system.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • bassBoost: int - valid values are between 0 and 100, where 0 means no bass boost (bassEnhancer disabled) and 100 means max bass boost

Returns:

  • success: bool - result of setting Bass Enhancer


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setBassEnhancer", "params":{"audioPort":"SPEAKER0","bassBoost":50}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setCurrentResolution (v1)

Description: Sets the current resolution.

Arguments:

  • videoDisplay: string - video display port name
  • resolution: string - resolution to be set
  • persist: bool - persist the resolution

Returns:

  • success: bool - result of resolution setting operation (true in case of success, false if videoDisplay and/or resolution parameter not found or failure in resolution setting)


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setCurrentResolution", "params":{"videoDisplay":"HDMI0", "resolution":"720p", "persist":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setDialogEnhancement (v1)

Description: Sets the Dialog Enhancer Level

Arguments:

  • enhancerlevel: int - value between 0 and 16, where 0 means no enhancement and 16 means maximum enhancement (failure in case of missing)

Returns:

  • success: bool - result of setting Dialog Enhancer Level


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setDialogEnhancement", "params":{"enhancerlevel":0}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setDolbyVolumeMode (v1)

Description: Enables/Disables Dolby Volume mode on audio track.

Arguments:

  • dolbyVolumeMode: bool - enable/disable Dolby Volume mode on audio track (audio output port HDMI0)

Returns:

  • success: bool - result of setting Dolby Volume mode


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setDolbyVolumeMode", "params":{"dolbyVolumeMode":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setDRCMode (v1)

Description: Dynamic Range Control.  

Dynamic range control is a compression control applied to audio to limit the dynamic range to suit a specific
listening situation.For default settings, RF mode is preferred for two-channel outputs (television speaker or headphone) and
Line mode for multichannel outputs.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • DRCMode: int - value 0 or 1.  Where 0 is Line mode and 1 is RF mode

Returns:

  • success: bool - result of setting Dynamic Range Control mode


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setDRCMode", "params":{"audioPort":"SPEAKER0","DRCMode":"1"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setEnableAudioPort (v1)

Description: Enable or disable specified audioPort based on the input audio port ID

Set enable audio port feature provides the consumer with a single user control to enable or disable the specified audio port.

Arguments:

  • audioPort: string  - Audio port ID. Possible values are ("HDMI_ARC0", "SPDIF0", "SPEAKER0",  "HEADPHONE0", etc). If no port is specified, it returns an error.
  • enable: bool - value can be either true or false. If true means enable specified audioPort. If false means disable specified audioPort.

Returns:

  • success: bool - result of setting set enable audio port


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setEnableAudioPort","params":{"audioPort":"HDMI_ARC0","enable":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setGain (v1)

Description: Adjusts the gain on specific port

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • gain: float - value between 0 and 100, where 0 means no level and 100 means maximum amount

Returns:

  • success: bool - result of setting gain


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setGain", "params":{"audioPort":"SPEAKER0","gain":"10"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setGraphicEqualizerMode (v1)

Description: Sets the Graphical Equalizer mode 

The Graphic Equalizer is a multiband equalizer that an end user can use to customize the sonic qualities of the system

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • graphicEqualizerMode: int - Intelligent Equalizer mode (0 = off, 1 = open, 2 = rich, 3 = focused)

Returns:

  • success: bool - result of setting Intelligent Equalizer mode


Request: {"jsonrpc":"2.0","id":"3","method": "org.rdk.DisplaySettings.1.setGraphicEqualizerMode", "params":{"audioPort":"SPEAKER0","graphicEqualizerMode":"3"}}

 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setIntelligentEqualizerMode (v1)

Description: Sets the Intelligent Equalizer mode (port HDMI0).

Arguments:

  • intelligentEqualizerMode: int - Intelligent Equalizer mode (1 = open, 2 = rich, 3 = focused)

Returns:

  • success: bool - result of setting Intelligent Equalizer mode


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setIntelligentEqualizerMode", "params":{"intelligentEqualizerMode":2}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setMISteering (v1)

Description: Enables/Disables Media Intelligent Steering

Media Intelligence analyzes audio content and steers the Volume Leveler, the Dialogue Enhancer, the
Intelligent Equalizer, and the Speaker Virtualizer, based on the type of audio content.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • MISteeringEnable: bool - enable/disable Media Intelligence

Returns:

  • success: bool - result of setting Media Intelligence


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setMISteering", "params":{"audioPort":"SPEAKER0","MISteeringEnable":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setMS12AudioCompression (v1)

Description: Sets the audio dynamic range compression level (port HDMI0). It takes a value between 0 and 10, where 0 mean no compression and 10 mean maximum compression.

Arguments:

  • compresionLevel: int - level of the compression (0 - no compression, 10 - maximum compression)

Returns:

  • success: bool - result of compression setting operation


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setMS12AudioCompression", "params":{"compresionLevel":5}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setMS12AudioProfile (v1)

Description: Configures selected MS12 Audio Profile 

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • ms12Audioprofile: string -  Profile name to be configured.  (Has to be supplied from the list of supported profiles returned by getSupportedMS12AudioProfile) 

Returns:

  • success: bool - result of setting Intelligent Equalizer mode


Request: {"jsonrpc":"2.0","id":"3","method": "org.rdk.DisplaySettings.1.setMS12AudioProfile", "params":{"audioPort":"SPEAKER0","ms12AudioProfile":"Music"}}


 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setMuted (v1)

Description: Mutes/Unmutes audio on specific port

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • muted: bool - true to mute audio or false to unmute audio.

 Returns:

  • success: bool - result of setting mute


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setMuted", "params":{"audioPort":"SPEAKER0","muted":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setScartParameter (v1)

Description: Sets SCART parameters. Possible values:

scartParameterscartParameterData
aspect_ratio4x316x9
tv_startuponoff
rgbon (disables cvbs)
cvbson (disables rgb)
macrovision

*(not implemented)


cgmsdisabled
cgmscopyNever
cgmscopyOnce
cgmscopyFreely
cgmscopyNoMore
portonoff

Arguments:

  • scartParameter: string - SCART parameter name (failure in case of missing)
  • scartParameterData: string - SCART parameter data (failure in case of missing)

Returns:

  • success: bool - result of the request


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setScartParameter", "params":{"scartParameter":"aspect_ratio", "scartParameterData":"4x3"}}
 
Response:{"jsonrpc":"2.0","id":3,"result":{"success":false}}

setSoundMode (v1)

Description: Sets the current sound mode for the corresponding video display.

Arguments:

  • audioPort: string - audio port name (missing or empty value will set all ports)
  • soundMode: string - sound mode to be set (failure in case of missing). Possible values: "mono", "stereo", "surround", "passthru", "auto", "auto *", "AUTO *", "dolby digital 5.1".
  • persist: bool - persist the sound mode

Returns:

  • success: bool - result of sound mode setting operation (true in case of success, false if soundMode not specified or failure in sound mode setting)


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setSoundMode", "params":{"audioPort":"HDMI0", "soundMode":"stereo", "persist":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setSurroundVirtualizer (v1)

Description: Sets the Surround Virtualizer boost.  

The Speaker/Surround Virtualizer enables a surround sound signal (including one generated by the Surround
Decoder) to be rendered over a device with built-in speakers or headphones.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • boost: int - value between 0 and 96, where 0 means no boost and 96 means maximum. 

Returns:

  • success: bool - result of setting Surround Virtualizer boost


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setSurroundVirtualizer", "params":{"audioPort":"SPEAKER0","boost":"90"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setVideoPortStatusInStandby (v1)

Description: Sets the specified video port status to be used in standby mode.

Arguments:

  • portName: string - video port name (failure in case of missing)
  • enabled: bool - enable video port status to be used in standby mode

Returns:

  • success: bool - result of enabling/disabling operation
  • error_message: string - error message in case of failure


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setVideoPortStatusInStandby", "params":{"portName":"HDMI0", "enabled":true}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setVolumeLevel (v1)

Description: Adjusts the Volume Level on specific port

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • volumeLevel: float - value between 0 and 100, where 0 means no level and 100 means maximum amount

Returns:

  • success: bool - result of setting Volume Leveller amount


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setVolumeLevel", "params":{"audioPort":"SPEAKER0","volumeLevel":"50"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setVolumeLeveller (v1)

Description: Sets the Volume Leveller amount.  

The Volume Leveler is an advanced volume-control solution that maintains consistent playback levels
for content from different sources.

Arguments:

  • audioPort: string (optional) - audio port ("HDMI0", "SPEAKER0", "SPDIF0", etc). The default port is HDMI0 if no port is specified.
  • level: int - value between 0 and 10, where 0 means no level and 10 means maximum amount

Returns:

  • success: bool - result of setting Volume Leveller amount


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setVolumeLeveller", "params":{"audioPort":"SPEAKER0","level":"9"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setZoomSetting (v1)

Description: Sets the current zoom value.

Arguments:

  • zoomSetting: string - name of the zoom settings. Possible values:
  • "FULL",  "NONE,"  "Letterbox 16x9", "Letterbox 14x9", "CCO", "PanScan", "Letterbox 2.21 on 4x3", "Letterbox 2.21 on 16x9", "Platform", "Zoom 16x9", "Pillarbox 4x3", "Widescreen 4x3" .

Returns:

  • success: bool - result of zoom setting operation (true in case of success, false if zoomSetting parameter not found or failure in zoom setting)


Request: {"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setZoomSetting", "params":{"zoomSetting":"FULL"}}
 
Response: {"jsonrpc":"2.0", "id":3, "result":{"success":true}}

Events

activeInputChanged

Description: Notifies of the active input change (RxSense)

Payload:

  • activeInput: bool - RXSENSE_ON = true, RXSENSE_OFF = false


{
  "jsonrpc": "2.0",
  "method": "MyId.activeInputChanged",
  "params": {
    "activeInput": true
  }
}

audioMuteStatusChanged

Description: Triggered when the mute setting changes for the current audio port.

Payload:

  • muteStatus: bool - true if muted, otherwise false


{
  "jsonrpc": "2.0",
  "method": "MyId.audioMusteStatusChanged",
  "params": {
    "muteStatus": false
  }
}

connectedAudioPortUpdated

Description: Returns the hotplugged audio port status.

Payload:

  • HotpluggedAudioPort: Audio port ID, in which connection status has changed. Possible audio port IDs are ("HDMI_ARC0", "HEADPHONE0",  etc).
  • isConnected: Current connection status of mentioned Audio port ID. Possible connection status are ("connected", "disconnected")


{
  "jsonrpc": "2.0",
  "method": "MyId.connectedAudioPortUpdated",
  "params":  {
    "HotpluggedAudioPort": "HDMI_ARC0",

    "isConnected": "connected"
  }
}

connectedVideoDisplaysUpdated

Description: Returns the connected video displays.

Payload:

  • connectedVideoDisplays: array of strings - list of connected displays


{
  "jsonrpc": "2.0",
  "method": "MyId.connectedVideoDisplaysUpdated",
  "params": {
    "connectedVideoDisplays": [
      "HDMI0"
    ]
  }
}

resolutionChanged

Description: Returns the current resolution changed by the user.

Payload:

  • width: int - width of the video display
  • height: int - height of the video display
  • videoDisplayType: string - type of the video display (port)
  • resolution: string - video display resolution


{
  "jsonrpc": "2.0",
  "method": "MyId.resolutionChanged",
  "params": {
    "width": 1920,
    "height": 1080,
    "videoDisplayType": "HDMI0",
    "resolution": "1080i"
  }
}

resolutionPreChange

Description: Sends notification (empty JSON object) on resolution pre-change.

Payload: none


{
  "jsonrpc":"2.0",
  "method":"org.rdk.DisplaySettings.1.resolutionPreChange"
}

Remarks

I was not able to trigger this event

zoomSettingUpdated

Description: Returns the zoom setting values for all video display types.

Payload:

  • zoomSetting: string - "FULL" or "NONE"
  • videoDisplayType: string - "all"


{
  "jsonrpc": "2.0",
  "method": "MyId.zoomSettingUpdated",
  "params": {
    "zoomSetting": "FULL",
    "videoDisplayType": "all"
  }
}

  • No labels

1 Comment

  1. Arun P Madhavan

    Hi Team,
    Can anyone share details on how these two differ: setAudioDelay and setAudioDelayOffset.
    Looking for details from user experience and HAL implementation perspective.

    Thanks in advance...

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.