Device Settings HAL 0.2.0
 
Loading...
Searching...
No Matches
dsHdmiIn.h File Reference

Device Settings HAL HDMI input Public API. This API defines the HAL for the Device Settings HDMI input interface. More...

#include <sys/types.h>
#include "dsError.h"
#include "dsTypes.h"
Include dependency graph for dsHdmiIn.h:

Go to the source code of this file.

Typedefs

typedef void(* dsHdmiInConnectCB_t) (dsHdmiInPort_t Port, bool isPortConnected)
 Notifies applications when the HDMI input port connection status changes.
 
typedef void(* dsHdmiInSignalChangeCB_t) (dsHdmiInPort_t port, dsHdmiInSignalStatus_t sigStatus)
 Notifies applications when the HDMI input port signal status changes.
 
typedef void(* dsHdmiInStatusChangeCB_t) (dsHdmiInStatus_t inputStatus)
 Notifies applications when the HDMI input status changes on any port.
 
typedef void(* dsHdmiInVideoModeUpdateCB_t) (dsHdmiInPort_t port, dsVideoPortResolution_t videoResolution)
 Notifies applications when the HDMI input port video mode changes.
 
typedef void(* dsHdmiInAllmChangeCB_t) (dsHdmiInPort_t port, bool allm_mode)
 Notifies applications when the HDMI input ALLM mode changes.
 
typedef void(* dsAVLatencyChangeCB_t) (int audio_latency, int video_latency)
 Notifies applications of HDMI Input AV Latency.
 
typedef void(* dsHdmiInAviContentTypeChangeCB_t) (dsHdmiInPort_t port, dsAviContentType_t avi_content_type)
 Notifies applications of HDMI Input Content Type change.
 

Functions

dsError_t dsHdmiInInit (void)
 Initializes the underlying HDMI input sub-system.
 
dsError_t dsHdmiInTerm (void)
 Terminates the underlying HDMI input sub-system.
 
dsError_t dsHdmiInGetNumberOfInputs (uint8_t *pNumberOfInputs)
 Gets the number of HDMI input ports on the device.
 
dsError_t dsHdmiInGetStatus (dsHdmiInStatus_t *pStatus)
 Gets the HDMI input port status of all ports.
 
dsError_t dsHdmiInSelectPort (dsHdmiInPort_t Port)
 Selects the HDMI input port as active and available for presentation.
 
dsError_t dsHdmiInScaleVideo (int32_t x, int32_t y, int32_t width, int32_t height)
 Scales the HDMI input video.
 
dsError_t dsHdmiInSelectZoomMode (dsVideoZoom_t requestedZoomMode)
 Updates the video zoom on the active HDMI input using the provided zoom mode.
 
dsError_t dsHdmiInPauseAudio (void)
 Stop the output of HDMI Input audio.
 
dsError_t dsHdmiInResumeAudio (void)
 Start the output of HDMI Input audio.
 
dsError_t dsHdmiInGetCurrentVideoMode (dsVideoPortResolution_t *resolution)
 Gets the current HDMI input video mode of the active port.
 
dsError_t dsHdmiInRegisterConnectCB (dsHdmiInConnectCB_t CBFunc)
 Registers a callback for the HDMI input hot plug event notification.
 
dsError_t dsHdmiInRegisterSignalChangeCB (dsHdmiInSignalChangeCB_t CBFunc)
 Registers a callback for the HDMI input Signal Change event.
 
dsError_t dsHdmiInRegisterAVLatencyChangeCB (dsAVLatencyChangeCB_t CBFunc)
 Registers the HDMI In Latency Change event.
 
dsError_t dsHdmiInRegisterStatusChangeCB (dsHdmiInStatusChangeCB_t CBFunc)
 Registers a callback for the HDMI input Status Change event.
 
dsError_t dsHdmiInRegisterVideoModeUpdateCB (dsHdmiInVideoModeUpdateCB_t CBFunc)
 Registers a callback for the HDMI input video mode Change event.
 
dsError_t dsHdmiInRegisterAllmChangeCB (dsHdmiInAllmChangeCB_t CBFunc)
 Registers a callback for the HDMI input ALLM Mode Change event.
 
dsError_t dsHdmiInRegisterAviContentTypeChangeCB (dsHdmiInAviContentTypeChangeCB_t CBFunc)
 Registers the HDMI Input Content type Change event.
 
bool dsIsHdmiARCPort (int iPort)
 Checks if the given port is an HDMI ARC port or not.
 
dsError_t dsGetEDIDBytesInfo (int iHdmiPort, unsigned char **edid, int *length)
 Gets the EDID bytes info corresponds to the given input port.
 
dsError_t dsGetHDMISPDInfo (int iHdmiPort, unsigned char **data)
 Gets the HDMI SPD info.
 
dsError_t dsSetEdidVersion (int iHdmiPort, int iEdidVersion)
 Sets the EDID version to be used for a given port id.
 
dsError_t dsGetEdidVersion (int iHdmiPort, int *iEdidVersion)
 Gets the EDID version currently being used for the given port id.
 
dsError_t dsGetAllmStatus (int iHdmiPort, bool *allmStatus)
 Checks whether ALLM status is enabled or disabled for the specific HDMI input port.
 
dsError_t dsGetSupportedGameFeaturesList (dsSupportedGameFeatureList_t *features)
 Gets all the supported game features list information.
 
dsError_t dsGetAVLatency (int *audio_latency, int *video_latency)
 Gets the current AV latency.
 

Detailed Description

Device Settings HAL HDMI input Public API. This API defines the HAL for the Device Settings HDMI input interface.

Document
Document reference.
Open Issues (in no particular order)
  1. None
Assumptions
  1. None
Abbreviations
  • cb: Callback function (suffix).
  • DS: Device Settings.
  • HAL: Hardware Abstraction Layer.
  • EDID: Extended Display Identification Data.
  • SPD: Source Product Description.
  • ARC: Audio Return Channel.
  • ALLM: Auto Low Latency Mode
  • HDMI: High-Definition Multimedia Interface
  • AV: Audio-Visual
  • HdmiIn: HDMI Input
Implementation Notes
  1. None