{"id":10166,"date":"2022-06-21T09:11:21","date_gmt":"2022-06-21T09:11:21","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsystem\/"},"modified":"2024-12-04T14:10:50","modified_gmt":"2024-12-04T14:10:50","slug":"display_subsstem","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/","title":{"rendered":"Display"},"content":{"rendered":"\n
<\/div>

Overview<\/h2>

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. <\/p>

HDMI<\/h2>

HDMI Connection Status<\/span><\/strong><\/h3>

Provides an API to search for device HDMI connection summary based on Mac address<\/span> . <\/span><\/p>

Authentication<\/h3>

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 <\/p>

Request Parameters\/Headers<\/h3>

All parameters should be passed as in HTTP POST<\/strong> request body <\/p>

Request Parameters<\/h5>
<\/colgroup>

Parameter Name<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Value Example<\/p><\/th><\/tr><\/thead>

requestId<\/h6><\/td>
String<\/td>

A GUID used to match requests with responses. For every request, the client supplies a requestId
that it can be used to track internal and external processes from request to response.<\/p><\/td>

984305439853453<\/td><\/tr>
requester<\/h6><\/td>
String<\/td>

The name of the request, or command, it will vary for the operations.<\/p><\/td>

tester123<\/td><\/tr>
version<\/h6><\/td>
String<\/td>Not required.  A future feature to let request to specific implementation or data original path.<\/span><\/td>
<\/td><\/tr>
query<\/td>String<\/td>Embedded Cable Modem\/Embedded Set top box MAC Address<\/td>70:B1:4E:5D:2B:A8<\/td><\/tr><\/tbody><\/table> <\/div>


<\/p>

Note:<\/strong><\/h5>

Include only one of the above parameters in a request. Otherwise, a Bad Request error occurs.<\/p>

Supported Request Headers<\/h5>
<\/colgroup>

Header Name<\/p><\/th>

Required<\/p><\/th>

Description<\/p><\/th>

Valid Expected Values<\/p><\/th><\/tr><\/thead>

Content-Type<\/td>Yes<\/td>Tells the the service: The format of the request document<\/td>application\/json, application\/xml<\/td><\/tr>
Accept<\/td>Yes<\/td>Tells the the service: The format of the media type of the response content it is expecting<\/td>application\/json, application\/xml<\/td><\/tr><\/tbody><\/table> <\/div>
Sample JSON Request Documents<\/h5>


JSON<\/strong><\/p>

<\/colgroup>

{<\/code>
    <\/code>\"requestId\"<\/code>: <\/code>\"984305439853453\"<\/code> ,<\/code>
    <\/code>\"requester\"<\/code>: <\/code>\"tester\"<\/code>,<\/code>
    <\/code>\"version\"<\/code>: <\/code>\"\"<\/code> ,<\/code>
    <\/code>\"query\"<\/code>: <\/code>\"14:D4:FE:7C:54:AD\"<\/code>
}<\/code><\/p><\/td><\/tr><\/tbody><\/table> <\/div>


Response Objects Structure<\/h5>


<\/p>

JSON object with HTTP 200 response but no device found response:<\/p>

<\/colgroup>

{<\/code>
    <\/code>\"requester\"<\/code>: <\/code>\"tester\"<\/code>,<\/code>
    <\/code>\"requestId\"<\/code>: <\/code>\"984305439853453\"<\/code>,<\/code>
    <\/code>\"version\"<\/code>: <\/code>\"\"<\/code>,<\/code>
    <\/code>\"statuses\"<\/code>:<\/code>
    <\/code>[<\/code>
            <\/code>{<\/code>
                <\/code>\"code\"<\/code>: <\/code>5004<\/code>,<\/code>
                <\/code>\"name\"<\/code>: <\/code>\"NO_DEVICE_FOUND\"<\/code>,<\/code>
                <\/code>\"description\"<\/code>: <\/code>\"No Devices Found\"<\/code>
            <\/code>}<\/code>
    <\/code>],<\/code>
    <\/code>\"message\"<\/code>: <\/code>\"Cannot find device based on query input: 14:D4:FE:A4:F6:00\"<\/code>,<\/code>
    <\/code>\"rawMessage\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"moreInfoUrl\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"result\"<\/code>: <\/code>null<\/code>
}<\/code><\/p><\/td><\/tr><\/tbody><\/table> <\/div>


<\/p>

JSON object with HTTP 200 response with HDMI data:<\/p>

<\/colgroup>

{<\/code>
    <\/code>\"requester\"<\/code>: <\/code>\"tester\"<\/code>,<\/code>
    <\/code>\"requestId\"<\/code>: <\/code>\"984305439853453\"<\/code>,<\/code>
    <\/code>\"version\"<\/code>: <\/code>\"\"<\/code>,<\/code>
    <\/code>\"statuses\"<\/code>: <\/code>
    <\/code>[<\/code>
            <\/code>{<\/code>
                <\/code>\"code\"<\/code>: <\/code>1000<\/code>,<\/code>
                <\/code>\"name\"<\/code>: <\/code>\"SUCCESS\"<\/code>,<\/code>
                <\/code>\"description\"<\/code>: <\/code>\"Success\"<\/code>
            <\/code>}<\/code>
    <\/code>],<\/code>
    <\/code>\"message\"<\/code>: <\/code>\"Device HDMI search process complete, for any possible minor issues, please check response statuses\"<\/code>,<\/code>
    <\/code>\"rawMessage\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"moreInfoUrl\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"result\"<\/code>:<\/code>
    <\/code>{<\/code>
        <\/code>\"hdmiConnectionStatus\"<\/code>: <\/code>true<\/code>,<\/code>
        <\/code>\"repeaterPresent\"<\/code>: <\/code>false<\/code>,<\/code>
        <\/code>\"hdcpEnabledStatus\"<\/code>: <\/code>true<\/code>,<\/code>
        <\/code>\"connectionDeviceHdcpStatus\"<\/code>: <\/code>\"compliantHDCPdevice\"<\/code>,<\/code>
        <\/code>\"videoTransmissionStatus\"<\/code>: <\/code>false<\/code>,<\/code>
        <\/code>\"videoMuteStatus\"<\/code>: <\/code>false<\/code>,<\/code>
        <\/code>\"videoResolution\"<\/code>: <\/code>\"720p\"<\/code>,<\/code>
        <\/code>\"videoAspectRatio\"<\/code>: <\/code>\"16x9\"<\/code>,<\/code>
        <\/code>\"audioMuteStatus\"<\/code>: <\/code>false<\/code>,<\/code>
        <\/code>\"audioFormat\"<\/code>: <\/code>\"lpcm\"<\/code>
 
   <\/code> 
    <\/code>}<\/code>
}<\/code><\/p><\/td><\/tr><\/tbody><\/table> <\/div>

JSON object with HTTP 200 response but missing required parameters:<\/p>

<\/colgroup>

{<\/code>
    <\/code>\"requester\"<\/code>: <\/code>\" \"<\/code>,<\/code>
    <\/code>\"requestId\"<\/code>: <\/code>\" \"<\/code>,<\/code>
    <\/code>\"version\"<\/code>: <\/code>\"\"<\/code>,<\/code>
    <\/code>\"statuses\"<\/code>:<\/code>
    <\/code>[<\/code>
        <\/code>{<\/code>
            <\/code>\"code\"<\/code>: <\/code>4002<\/code>,<\/code>
            <\/code>\"name\"<\/code>: <\/code>\"NO_REQUEST_USER_IDENTITY\"<\/code>,<\/code>
            <\/code>\"description\"<\/code>: <\/code>\"Request User Identity (requester) is Empty\"<\/code>
        <\/code>},<\/code>
        <\/code>{<\/code>
            <\/code>\"code\"<\/code>: <\/code>4003<\/code>,<\/code>
            <\/code>\"name\"<\/code>: <\/code>\"NO_REQUEST_TRACKING_ID\"<\/code>,<\/code>
            <\/code>\"description\"<\/code>: <\/code>\"Request Tracking ID (requestId) is Empty\"<\/code>
        <\/code>}<\/code>
    <\/code>],<\/code>
    <\/code>\"message\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"rawMessage\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"moreInfoUrl\"<\/code>: <\/code>null<\/code>,<\/code>
    <\/code>\"result\"<\/code>: <\/code>null<\/code>
}<\/code><\/p><\/td><\/tr><\/tbody><\/table> <\/div>

 <\/span><\/p>

Response Messages<\/h3>

The following list includes all possible response messages (In HTTP response message body OR result object of the action):<\/p>

<\/colgroup>

HTTP Code<\/p><\/th>

Phrase<\/p><\/th>

Message<\/p><\/th><\/tr><\/thead>

200<\/td>OK<\/td>Device\/Account Search successful<\/td><\/tr>
1000<\/td>SUCCESS<\/td>Success<\/td><\/tr>
1004<\/td>UNKNOWN_STATAUS<\/td>System runtime unknown error, please check with system administrator<\/td><\/tr>
2002<\/td>INTERNAL_SERVICE_UNREACHABLE_NOTFOUND<\/td>Internal Service Unreachable or Not Found<\/td><\/tr>
2004<\/td>METHOD_NOT_IMPLEMENTATED<\/td>Method Not Implemented<\/td><\/tr>
3000<\/td>EXTERNAL_SERVICE_ERROR<\/td>External Service Error<\/td><\/tr>
4002<\/td>NO_REQUEST_USER_IDENTITY<\/td>Request User Identity (requester) is Empty<\/td><\/tr>
4003<\/td>NO_REQUEST_TRACKING_ID<\/td>Request Tracking ID (requestId) is Empty<\/td><\/tr>
4011<\/td>INVALID_SEARCH_PARAMETER<\/td>Invalid Search Or Query Parameters<\/td><\/tr>
4012<\/td>INVALID_MAC_ADDRESS<\/td>Mac Address is invalid<\/td><\/tr>
5000<\/td>NO_DATA_FOUND<\/td>No Data Found<\/td><\/tr>
5004<\/td>NO_DEVICES_FOUND<\/td>
No Devices Found<\/span><\/pre><\/td><\/tr><\/tbody><\/table> <\/div>
 <\/span><\/p>
 <\/span><\/p>
Response Parameters<\/h3>
 <\/span><\/p>
 <\/colgroup>
Parameter<\/p><\/th>
Type<\/p><\/th>
Possible Values<\/p><\/th><\/tr><\/thead>
hdmiConnectionStatus<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
repeaterPresent<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
hdcpEnabledStatus<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
connectionDeviceHdcpStatus<\/span><\/h6><\/td>
String<\/td>
nonHDCPdevice<\/p>
compliantHDCPdevice<\/p>
revokedHDCPdevice<\/p><\/td><\/tr>
videoTransmissionStatus<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
videoMuteStatus<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
videoResolution<\/span><\/h6><\/td>
String<\/td>
288p\/288*\/480i\/480p\/480*\/576p\/576i\/576*\/720p\/720*\/1080p\/1080i\/1080*<\/p>
“*” means could be i or p<\/p><\/td><\/tr>
videoAspectRatio<\/span><\/h6><\/td>
String<\/td>other\/4×3\/16×9<\/td><\/tr>
audioMuteStatus<\/span><\/h6><\/td>
Boolean<\/td>true\/false\/null<\/td><\/tr>
audioFormat<\/span><\/h6><\/td>
String<\/td>
other<\/p>
lpcm —– Linear PCM<\/p>
ac3 —– Dolby Digital<\/p>
eac3 —– Dolby Digital Plus<\/p>
mpeg1L1L2 —– MPEG-1 Layer 1\/2<\/p>
mpeg1L3 —– MPEG-1 Layer 3<\/p>
mpeg2 —– Advanced Audio Coding-Low Complexity<\/p>
mpeg4 —– High Efficiency Advanced Audio Coding<\/p>
dts —– Digital Theater Sound<\/p>
atrac —– Adaptive Transform Acoustic Coding<\/p>
mpeg2L1L2 —– MPEG-2 Layer 1\/2<\/p>
mpeg2L3 —– MPEG-2 Layer 3<\/p>
mpeg2.5 —– MPEG2.5<\/p>
mp3Pro —– MP3-PRO<\/p>
mp3Surround —– MP3-Surround Advanced<\/p>
dtsHd —– Digital Theater Sound – High Definition<\/p>
mpegSurround —– MPEG-Surround<\/p><\/td><\/tr><\/tbody><\/table> <\/div>

<\/p>\n","protected":false},"excerpt":{"rendered":"
Overview The Display subsystem manages operations relating to connected Vendors. Display subsystem is a part […]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10158,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10166","page","type-page","status-publish","hentry"],"yoast_head":"\nDisplay - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Display - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Overview The Display subsystem manages operations relating to connected Vendors. Display subsystem is a part […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2024-12-04T14:10:50+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/\",\"name\":\"Display - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:11:21+00:00\",\"dateModified\":\"2024-12-04T14:10:50+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Video\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Sub-Systems\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/?page_id=10158\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Display\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Display - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/","og_locale":"en_US","og_type":"article","og_title":"Display - RDK Documentation Portal | Documentation","og_description":"Overview The Display subsystem manages operations relating to connected Vendors. Display subsystem is a part […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2024-12-04T14:10:50+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/","name":"Display - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:11:21+00:00","dateModified":"2024-12-04T14:10:50+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/display_subsstem\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Video","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Sub-Systems","item":"https:\/\/developer.rdkcentral.com\/documentation\/?page_id=10158"},{"@type":"ListItem","position":5,"name":"Display"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10166","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=10166"}],"version-history":[{"count":3,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10166\/revisions"}],"predecessor-version":[{"id":11827,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10166\/revisions\/11827"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10158"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=10166"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}