You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Overview

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. 

HDMI

HDMI Connection Status

Provides an API to search for device HDMI connection summary based on Mac address     

Authentication

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 

Request Parameters/Headers

All parameters should be passed as in HTTP POST request body 

Request Parameters

Parameter Name

Type

Description

Value Example

requestId
String

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.

984305439853453
requester
String

The name of the request, or command, it will vary for the operations.

tester123
version
StringNot required.  A future feature to let request to specific implementation or data original path.
queryStringEmbedded Cable Modem/Embedded Set top box MAC Address70:B1:4E:5D:2B:A8


Note:

Include only one of the above parameters in a request. Otherwise, a Bad Request error occurs.

Supported Request Headers

Header Name

Required

Description

Valid Expected Values

Content-TypeYesTells the the service: The format of the request documentapplication/json, application/xml
AcceptYesTells the the service: The format of the media type of the response content it is expectingapplication/json, application/xml
Sample JSON Request Documents


JSON

{
    "requestId": "984305439853453" ,
    "requester": "tester",
    "version": "" ,
    "query": "14:D4:FE:7C:54:AD"
}

Request XML schema


XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" targetNamespace="https://x1mgr.cable.comcast.com/x1PlatformMgr" xmlns:tns="https://x1mgr.cable.comcast.com/x1PlatformMgr" xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
 <xs:complexType name="deviceHDMIRequest">
    <xs:complexContent>
      <xs:extension base="tns:baseRequest">
        <xs:sequence>
          <xs:element name="query" type="xs:string"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
 </xs:complexType>
  
 <xs:complexType name="baseRequest">
    <xs:sequence>
      <xs:element name="requestId" type="xs:string"/>
      <xs:element name="requester" type="xs:string"/>
      <xs:element name="version" type="xs:string" minOccurs="0"/>
    </xs:sequence>
 </xs:complexType>
</xs:schema>

Sample XML Request Documents


XML

<deviceHDMIRequest>
    <query>14:D4:FE:A4:F6:99</query>
    <requestId>984305439853453</requestId>
    <requester>tester</requester>
    <version></version>
</deviceHDMIRequest>

Response Objects Structure


JSON object with HTTP 200 response but no device found response:

{
    "requester": "tester",
    "requestId": "984305439853453",
    "version": "",
    "statuses":
    [
            {
                "code": 5004,
                "name": "NO_DEVICE_FOUND",
                "description": "No Devices Found"
            }
    ],
    "message": "Cannot find device based on query input: 14:D4:FE:A4:F6:00",
    "rawMessage": null,
    "moreInfoUrl": null,
    "result": null
}


JSON object with HTTP 200 response with HDMI data:

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

JSON object with HTTP 200 response but missing required parameters:

{
    "requester": " ",
    "requestId": " ",
    "version": "",
    "statuses":
    [
        {
            "code": 4002,
            "name": "NO_REQUEST_USER_IDENTITY",
            "description": "Request User Identity (requester) is Empty"
        },
        {
            "code": 4003,
            "name": "NO_REQUEST_TRACKING_ID",
            "description": "Request Tracking ID (requestId) is Empty"
        }
    ],
    "message": null,
    "rawMessage": null,
    "moreInfoUrl": null,
    "result": null
}

 

Response Messages

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

HTTP Code

Phrase

Message

200OKDevice/Account Search successful
1000SUCCESSSuccess
1004UNKNOWN_STATAUSSystem runtime unknown error, please check with system administrator
2002INTERNAL_SERVICE_UNREACHABLE_NOTFOUNDInternal Service Unreachable or Not Found
2004METHOD_NOT_IMPLEMENTATEDMethod Not Implemented
3000EXTERNAL_SERVICE_ERRORExternal Service Error
4002NO_REQUEST_USER_IDENTITYRequest User Identity (requester) is Empty
4003NO_REQUEST_TRACKING_IDRequest Tracking ID (requestId) is Empty
4011INVALID_SEARCH_PARAMETERInvalid Search Or Query Parameters
4012INVALID_MAC_ADDRESSMac Address is invalid
5000NO_DATA_FOUNDNo Data Found
5004NO_DEVICES_FOUND
No Devices Found

 

 

Response Parameters

 

Parameter

Type

Possible Values

hdmiConnectionStatus
Booleantrue/false/null
repeaterPresent
Booleantrue/false/null
hdcpEnabledStatus
Booleantrue/false/null
connectionDeviceHdcpStatus
String

nonHDCPdevice

compliantHDCPdevice

revokedHDCPdevice

videoTransmissionStatus
Booleantrue/false/null
videoMuteStatus
Booleantrue/false/null
videoResolution
String

288p/288*/480i/480p/480*/576p/576i/576*/720p/720*/1080p/1080i/1080*

"*" means could be i or p

videoAspectRatio
Stringother/4x3/16x9
audioMuteStatus
Booleantrue/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

Composite


  • No labels

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.