Skip to end of metadata
Go to start of metadata

Versions

org.rdk.HdmiInput.1 - initial version of Hdmi Input API.

Methods

getHDMIInputDevices (v1)

Description: returns an array of hdmi input devices.

Arguments: none

Returns:

  • devices : array - an array of hdmiInputDevice object (based on number of HDMI Input ports on the device), where hdmiInputDevice is:

    {
        id: number,
        location: string,
        connected: boolean
    }


Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.HdmiInput.1.getHDMIInputDevices"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"devices":[{"id":0,"locator":"hdmiin://localhost/deviceid/0","connected":"true"},{"id":1,"locator":"hdmiin://localhost/deviceid/1","connected":"false"},{"id":2,"locator":"hdmiin://localhost/deviceid/2","connected":"false"}],"success":true}}

 startHdmiInput (v1)

Description: Activates selected Hdmi In Port as primary video source.  

Arguments

  • portId : number - an id of Hdmi In source.   (getHdmiInputDevices (v1) will list available Hdmi Input devices and portIds)

Returns: 

  • success : bool - result of activating Hdmi Input  

Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.HdmiInput.1.startHdmiInput", "params": {"portId":"1"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

 stopHdmiInput (v1)

Description: Deactivates current Hdmi In Port selected as primary video source. 

Returns:

  • success : bool - result of deactivating Hdmi Input 

Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.HdmiInput.1.stopHdmiInput"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

writeEDID (v1)

Description: changes a current EDID value.

Arguments

  • deviceId : number - an id of device, which EDID should be changed.  
  • message : string - a new EDID value

Returns: none

Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.HdmiInput.1.writeEDID", "params": {"deviceId": 0, "message": "EDID"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}


 

readEDID (v1)

Description: returns a current EDID value

Arguments: none

Returns:

  • name : string - EDID value, currently stubbed

Request : {"jsonrpc":"2.0", "id":3, "method":"org.rdk.HdmiInput.1.readEDID"}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"name":"HdmiInputEDIDStub","success":true}}


setVideoRectangle (v1)

Description: Sets Hdmi Input video window

Arguments

  • x: int - The x-coordinate of the video rectangle.
  • y: int - The y-coordinate of the video rectangle.
  • w: int - The width of the video rectangle.
  • h: int - The height of the video rectangle.

Returns: 

  • success : bool - result of setting Hdmi Input  video window

Request : {"jsonrpc":"2.0","id":"3","method": "org.rdk.HdmiInput.1.setVideoRectangle", "params":{"x":"0","y":"0","w":"1920","h":"1080"}}
 
Response: {"jsonrpc":"2.0","id":3,"result":{"success":true}}

Events

onDevicesChanged

Description: event fired whenever new HDMI device is connected to HDMI input.

Payload:

  • devices : array - an array of hdmiInputDevice object (based on number of HDMI Input ports on the device), where hdmiInputDevice is:

    {
        id: number,
        location: string,
        connected: boolean
    }


{
  "jsonrpc":"2.0",
  "method":"org.rdk.HdmiInput.1.onDevicesChanged",
  "params": {{"devices":[{"id":0,"locator":"hdmiin://localhost/deviceid/0","connected":"true"},{"id":1,"locator":"hdmiin://localhost/deviceid/1","connected":"false"},{"id":2,"locator":"hdmiin://localhost/deviceid/2","connected":"false"}]}
}

onInputStatusChanged

Description: event fired whenever new HDMI Input status is changed (started/stopped) for the selected port

Payload:

  • id :  int - PortID of HDMI Input port 

  • locator:  string - Locator string corresponding to HDMI Input port
  • status: string -  Status of the HDMI Input : started/stopped


{
  "jsonrpc":"2.0",
  "method":"org.rdk.HdmiInput.1.onInputStatusChanged",
  "params": {"id":0,"locator":"hdmiin://localhost/deviceid/0","status":"started"}

}


onSignalChanged

Description: event fired whenever HDMI Input signal status changes for the selected port

Payload:

  • id :  int - PortID of HDMI Input port 

  • locator:  string - Locator string corresponding to HDMI Input port
  • signalStatus: string -  Signal Status of the HDMI Input : noSignal, unstableSignal, notSupportedSignal, stableSignal


{
  "jsonrpc":"2.0",
  "method":"org.rdk.HdmiInput.1.onSignalChanged",
  "params": {"id":0,"locator":"hdmiin://localhost/deviceid/0","signalStatus":"stableSignal"}

}

  • No labels