RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
The Display subsystem manages operations relating to connected Vendors. Display subsystem is a part of Device Settings library to control the Aspect ratio, Resolution, EDID data etc.
Provides an API to search for device HDMI connection summary based on Mac address .
The service uses Code Big credential (key) to authenticate: The service has a stateless nature, so the Code Big credentials should be present in each request Authorization header
All parameters should be passed as in HTTP POST request body
Parameter Name | Type | Description | Value Example |
---|---|---|---|
requestId | String | A GUID used to match requests with responses. For every request, the client supplies a requestId | 984305439853453 |
requester | String | The name of the request, or command, it will vary for the operations. | tester123 |
version | String | Not required. A future feature to let request to specific implementation or data original path. | |
query | String | Embedded Cable Modem/Embedded Set top box MAC Address | 70:B1:4E:5D:2B:A8 |
Include only one of the above parameters in a request. Otherwise, a Bad Request error occurs.
Header Name | Required | Description | Valid Expected Values |
---|---|---|---|
Content-Type | Yes | Tells the the service: The format of the request document | application/json, application/xml |
Accept | Yes | Tells the the service: The format of the media type of the response content it is expecting | application/json, application/xml |
JSON
|
JSON object with HTTP 200 response but no device found response:
|
JSON object with HTTP 200 response with HDMI data:
|
JSON object with HTTP 200 response but missing required parameters:
|
The following list includes all possible response messages (In HTTP response message body OR result object of the action):
HTTP Code | Phrase | Message |
---|---|---|
200 | OK | Device/Account Search successful |
1000 | SUCCESS | Success |
1004 | UNKNOWN_STATAUS | System runtime unknown error, please check with system administrator |
2002 | INTERNAL_SERVICE_UNREACHABLE_NOTFOUND | Internal Service Unreachable or Not Found |
2004 | METHOD_NOT_IMPLEMENTATED | Method Not Implemented |
3000 | EXTERNAL_SERVICE_ERROR | External Service Error |
4002 | NO_REQUEST_USER_IDENTITY | Request User Identity (requester) is Empty |
4003 | NO_REQUEST_TRACKING_ID | Request Tracking ID (requestId) is Empty |
4011 | INVALID_SEARCH_PARAMETER | Invalid Search Or Query Parameters |
4012 | INVALID_MAC_ADDRESS | Mac Address is invalid |
5000 | NO_DATA_FOUND | No Data Found |
5004 | NO_DEVICES_FOUND | No Devices Found |
Parameter | Type | Possible Values |
---|---|---|
hdmiConnectionStatus | Boolean | true/false/null |
repeaterPresent | Boolean | true/false/null |
hdcpEnabledStatus | Boolean | true/false/null |
connectionDeviceHdcpStatus | String | nonHDCPdevice compliantHDCPdevice revokedHDCPdevice |
videoTransmissionStatus | Boolean | true/false/null |
videoMuteStatus | Boolean | true/false/null |
videoResolution | String | 288p/288*/480i/480p/480*/576p/576i/576*/720p/720*/1080p/1080i/1080* "*" means could be i or p |
videoAspectRatio | String | other/4x3/16x9 |
audioMuteStatus | Boolean | true/false/null |
audioFormat | String | other lpcm ----- Linear PCM ac3 ----- Dolby Digital eac3 ----- Dolby Digital Plus mpeg1L1L2 ----- MPEG-1 Layer 1/2 mpeg1L3 ----- MPEG-1 Layer 3 mpeg2 ----- Advanced Audio Coding-Low Complexity mpeg4 ----- High Efficiency Advanced Audio Coding dts ----- Digital Theater Sound atrac ----- Adaptive Transform Acoustic Coding mpeg2L1L2 ----- MPEG-2 Layer 1/2 mpeg2L3 ----- MPEG-2 Layer 3 mpeg2.5 ----- MPEG2.5 mp3Pro ----- MP3-PRO mp3Surround ----- MP3-Surround Advanced dtsHd ----- Digital Theater Sound - High Definition mpegSurround ----- MPEG-Surround |