Skip to end of metadata
Go to start of metadata

Versions

com.comcastHdcpProfile.1 - Provides interface for HDCP related data and events

Methods

getHDCPStatus (v1)

Description: Returns HDCP related data

Arguments: none

Returns:

  • isConnected : bool - indicates whether display is connected
  • isHDCPCompliant : bool - indicates whether display is HDCP compliant
  • isHDCPEnabled : bool - indicates whether content is protected
  • supportedHDCPVersion : string - supported HDCP protocol version by the host device
  • receiverHDCPVersion : string - support HDCP protocol version by the receiver (display)
  • currentHDCPVersion : string - currently used HDCP protocol version
  • success : boolean - indicates if call was successful


Request : {"jsonrpc":"2.0", "id":3, "method":"com.comcast.HdcpProfile.1.getHDCPStatus"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"HDCPStatus":{"isConnected":false,"isHDCPCompliant":false,"isHDCPEnabled":false,"supportedHDCPVersion":"2.2","receiverHDCPVersion":"1.4","currentHDCPVersion":"1.4"},"success":true}}

getHDCPStatus (v2)

Description: Returns HDCP related data

Arguments: none

Returns:

  • isConnected : bool - indicates whether display is connected
  • isHDCPCompliant : bool - indicates whether display is HDCP compliant
  • isHDCPEnabled : bool - indicates whether content is protected
  • reason : string - returns HDCP status reason
  • supportedHDCPVersion : string - supported HDCP protocol version by the host device
  • receiverHDCPVersion : string - support HDCP protocol version by the receiver (display)
  • currentHDCPVersion : string - currently used HDCP protocol version
  • success : boolean - indicates if call was successful


Request : {"jsonrpc":"2.0", "id":3, "method":"com.comcast.HdcpProfile.1.getHDCPStatus"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"HDCPStatus":{"isConnected":false,"isHDCPCompliant":false,"isHDCPEnabled":false,"reason":"AUTHENTICATED","supportedHDCPVersion":"2.2","receiverHDCPVersion":"1.4","currentHDCPVersion":"1.4"},"success":true}}

getSettopHDCPSupport (v1)

Description: Returns which version of HDCP is supported by the STB

Arguments: none

Returns:

  • supportedHDCPVersion : string - supported HDCP protocol version by the host device
  • isHDCPSupported : bool - indicates whether HDCP is supported by the STB
  • success : boolean - indicates if call was successful


Request : {"jsonrpc":"2.0", "id":3, "method":"com.comcast.HdcpProfile.1.getSettopHDCPSupport"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"supportedHDCPVersion":"2.2","isHDCPSupported":true,"success":true}}

Events

onDisplayConnectionChanged (v1)

Description: Emitted if HDMI was connected or disconnected (upon receiving onHdmiOutputHotPlug)

Payload

  • isConnected : bool - indicates whether display is connected
  • isHDCPCompliant : bool - indicates whether display is HDCP compliant
  • isHDCPEnabled : bool - indicates whether content is protected
  • supportedHDCPVersion : string - supported HDCP protocol version by the host device
  • receiverHDCPVersion : string - support HDCP protocol version by the receiver (display)
  • currentHDCPVersion : string - currently used HDCP protocol version


{
    "jsonrpc":"2.0",
    "method":"MyId.onDisplayConnectionChanged",
    "params":{"HDCPStatus":{"isConnected":false,"isHDCPCompliant":false,"isHDCPEnabled":false,"supportedHDCPVersion":"2.2","receiverHDCPVersion":"1.4","currentHDCPVersion":"1.4"}}
}



onDisplayConnectionChanged (v2)

Description: Emitted if HDMI was connected or disconnected (upon receiving onHdmiOutputHotPlug)

Payload

  • isConnected : bool - indicates whether display is connected
  • isHDCPCompliant : bool - indicates whether display is HDCP compliant
  • isHDCPEnabled : bool - indicates whether content is protected
  • reason : string - returns HDCP status reason
  • supportedHDCPVersion : string - supported HDCP protocol version by the host device
  • receiverHDCPVersion : string - support HDCP protocol version by the receiver (display)
  • currentHDCPVersion : string - currently used HDCP protocol version


{
    "jsonrpc":"2.0",
    "method":"MyId.onDisplayConnectionChanged",
    "params":{"HDCPStatus":{"isConnected":false,"isHDCPCompliant":false,"isHDCPEnabled":false,"reason":"AUTHENTICATED","supportedHDCPVersion":"2.2","receiverHDCPVersion":"1.4","currentHDCPVersion":"1.4"}}
}

  • No labels