1.0.1 ENABLE.hdcp

Namespace: hdcp

Functions for get/set HDCP status.

Namespaces

event

Members

static,constant ENABLE.hdcp.HDCP_AUTO String

Parameter for ENABLE.hdcp.setHDCP .
Auto HDCP version (highest version supported by connected HDMI device)

Since:
  • 1.0.0

static,constant ENABLE.hdcp.HDCP_NONE String

Parameter for ENABLE.hdcp.setHDCP .
HDCP disabled

Since:
  • 1.0.0

static,constant ENABLE.hdcp.HDCP_V1 String

Parameter for ENABLE.hdcp.setHDCP .
HDCP v1 (1.4)

Since:
  • 1.0.0

static,constant ENABLE.hdcp.HDCP_V2 String

Parameter for ENABLE.hdcp.setHDCP .
HDCP v2 (2.2)

Since:
  • 1.0.0

Methods

static ENABLE.hdcp.getMaxSupportedScheme () {Object}

Get Highest HDCP version supported by connected HDMI device (none, v1, v2).

Since:
  • 1.0.0
Returns:
Name Type Description
object Object
Name Type Description
status_code String ENABLE.status.SUCCESS or
ENABLE.status.NOT_READY
result String Highest HDCP version

static ENABLE.hdcp.getScheme () {Object}

Get current HDCP version.

Since:
  • 1.0.0
Returns:
Name Type Description
object Object
Name Type Description
status_code String ENABLE.status.SUCCESS or
ENABLE.status.NOT_READY
result String Current HDCP version (none, v1, v2)

static ENABLE.hdcp.setEventCallback (callback) {Object}

Register HDCP event callback function.
Only one callback function can be registered. Pass null as callback to unregister.
Example:

var callback = function(obj) {
    if(obj.event === ENABLE.hdcp.event.HDCP_SUCCESS){
        console.log("HDCP authentication is success!");
    }
};
ENABLE.hdcp.setEventCallback(callback);
Name Type Description
callback ENABLE.hdcp~Callback

Callback function

Since:
  • 1.0.0
Returns:
Name Type Description
object Object
Name Type Description
status_code Object ENABLE.status.SUCCESS or
ENABLE.status.NOT_READY

static ENABLE.hdcp.setScheme (scheme) {Object}

Set HDCP version.
Pass ENABLE.hdcp.HDCP_NONE to disable HDCP.

Name Type Description
scheme String

ENABLE.hdcp.HDCP_NONE or
ENABLE.hdcp.HDCP_AUTO or
ENABLE.hdcp.HDCP_V1 or
ENABLE.hdcp.HDCP_V2

Since:
  • 1.0.0
Returns:
Name Type Description
object Object
Name Type Description
status_code String ENABLE.status.SUCCESS or
ENABLE.status.NOT_READY
result String Current HDCP version (none, v1, v2)

Type Definitions

Callback (object)

Callback function for ENABLE.hdcp.setEventCallback

Name Type Description
object Object
Name Type Description
event Object

Possible values of event:
ENABLE.hdcp.event.HDCP_DISABLED
ENABLE.hdcp.event.HDCP_ENABLED
ENABLE.hdcp.event.HDCP_FAILURE
ENABLE.hdcp.event.HDCP_SUCCESS

Since:
  • 1.0.0