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 }

 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  

 stopHdmiInput (v1)

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

Returns:

• success : bool - result of deactivating Hdmi Input 

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

readEDID (v1)

Description: returns a current EDID value

Arguments: none

Returns:

• name : string - EDID value, currently stubbed
  
  

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

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 }

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

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