Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 

...

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

Request XML schema

...

<?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

...

<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:

...

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

PIP

...