Code Releases
Papers & Presentations Archive
changes.mady.by.user Arun P Madhavan
Saved on Feb 22, 2024
...
applications/list
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getavailabletypes
Use the response to match the AppID as per DAB-2.0 spec. [Note: should have YouTube, Amazon & Netflix as types in the API response.]
applications/launch
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=launch (topmost:true, focused:true)
[Note: Implementation supports only YouTube common port. If previous state is suspended; then moveToFront & setFocus rdkshell APIs are called with AppID matching callsign.]
applications/launch-with-content
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=launchhttps://code.rdkcentral.com/r/plugins/gitiles/rdk/components/generic/cobalt/+/refs/heads/24.lts.dev/plugin/doc/CobaltPlugin.md#method.deeplink[Note: Implementation supports only YouTube common port. If previous state is suspended; then moveToFront & setFocus rdkshell APIs are called with AppID matching callsign.]
applications/get-state
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getstate
applications/get-stateexit
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=destroy
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=suspend
device/info
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getconnectedvideodisplays
https://rdkcentral.github.io/rdkservices/#/api/SystemPlugin?id=getdeviceinfo
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getscreenresolution
https://rdkcentral.github.io/rdkservices/#/api/NetworkPlugin?id=getinterfaces
https://rdkcentral.github.io/rdkservices/#/api/DeviceInfoPlugin?id=systeminfo [estb_mac is used as DAB Device ID]
https://rdkcentral.github.io/rdkservices/#/api/DeviceIdentificationPlugin?id=deviceidentification
https://rdkcentral.github.io/rdkservices/#/api/NetworkPlugin?id=getipsettings
system/restart
https://rdkcentral.github.io/rdkservices/#/api/SystemPlugin?id=reboot
system/settings/restartlist
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedresolutions
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedaudioports
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedaudiomodes
https://rdkcentral.github.io/rdkservices/#/api/FrameRatePlugin?id=getdisplayframerate
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsettophdrsupport
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=gettvhdrsupport
MEMC: false
LowLatencyMode: true as its being enabled by the pipeline property. No plugin exposed APIs available.
VideoInputSource : Home (STB's playback source is its app itself.)
PictureMode: None (not an STB feature)
system/settings/listget
https://rdkcentral.github.io/rdkservices/#/api/HdmiCec_2Plugin?id=getenabled
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsoundmode
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getmuted
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsettophdrsupport & https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=gettvhdrsupport
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getconnectedaudioports
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getvolumelevel
https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPlugin?id=isttsenabled
system/settings/
set
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setcurrentresolution
https://rdkcentral.github.io/rdkservices/#/api/FrameRatePlugin?id=setdisplayframerate
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setvolumelevel
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setmuted
https://rdkcentral.github.io/rdkservices/#/api/HdmiCec_2Plugin?id=setenabled
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setenableaudioport
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setforcehdrmode
https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setsoundmode
https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPlugin?id=enabletts
PictureMode: not implemented (not an STB feature)
VideoInputSource : not implemented due to lack of device capability.
input/key/list
Platform configurable key map /opt/dab_platform_keymap.json with following format: key value pair of "DAB_KEY": PLATFORM_KEYCODE
{ "KEY_GREEN": 406, "KEY_YELLOW": 403, "KEY_BLUE": 404, "KEY_HOME": 173 }
input/key-press
https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=injectkey
[Note: injectKey will not be overridden by the rdkshell_keymapping.json so put the final KEYCODE in /opt/dab_platform_keymap.json]
input/long-key-press
output/image
https://rdkcentral.github.io/rdkservices/#/api/ScreenCapturePlugin?id=uploadscreencapture
device-telemetry/start
device-telemetry/stop
TBD: Funtionality not tested.
device-telemetry/metrics
app-telemetry/start
app-telemetry/stop
app-telemetry/metrics
health-check/get
messages
voice/list
voice/set
https://rdkcentral.github.io/rdkservices/#/api/VoiceControlPlugin?id=configurevoice with following parameter in the current implementation.
{"enable":false, "ptt":{"enable":false}}
voice/
send-audio
https://rdkcentral.github.io/rdkservices/#/api/VoiceControlPlugin?id=voicesessionrequest
voice/send-audiotext
voice/send-text