A set of events sourced from display device (e.g. TV) Described herein are DeviceSettings HAL types and functions that are part of the Display subsystem. The Display subsystem manages operations relating to connected Vendors please add appropriate events needed for your implementation. display devices, e.g. TVs.
|
typedef void(* | dsDisplayEventCallback_t) (intptr_t handle, dsDisplayEvent_t event, void *eventData) |
| Callback function used to notify applications of display events. More...
|
|
◆ dsDisplayEventCallback_t
typedef void(* dsDisplayEventCallback_t) (intptr_t handle, dsDisplayEvent_t event, void *eventData) |
Callback function used to notify applications of display events.
HAL Implementation should call this method to delivery display events to the application (e.g. connected, disconnected).
- Parameters
-
handle | Handle of the display device. |
event | Display event. |
eventData | Data associated with the event. This is currently a place holder. |
- Note
- HAL implementation is responsible for allocation of memory needed for event data. The memory can be free'd after callback returns.
- Returns
- None.
Definition at line 88 of file dsDisplay.h.
◆ dsDisplayInit()
Initialize the Display sub-system.
This function must initialize all underlying Display sub-system modules and associated data structures.
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsDisplayInit api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 47 of file dsDisplay.c.
◆ dsGetDisplay()
Get the handle of a display device.
This function will get the handle for the display device connected to the specified video port.
- Parameters
-
[in] | vType | Type of video port (e.g. HDMI, COMPONENT, etc.). |
[in] | index | The index of the video port (0, 1, ...). |
[out] | *handle | The address of a location to hold the handle for the specified display device on return. |
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsGetDisplay api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 65 of file dsDisplay.c.
◆ dsGetEDID()
Get the EDID information from the specified display device.
This function gets the EDID information from the HDMI/DVI display corresponding to the specified display device handle.
- Parameters
-
[in] | handle | Handle of the display device. |
[out] | *edid | The address of a location to hold the EDID for the specified display device on return. |
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsGetEDID api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 119 of file dsDisplay.c.
◆ dsGetEDIDBytes()
dsError_t dsGetEDIDBytes |
( |
intptr_t |
handle, |
|
|
unsigned char ** |
edid, |
|
|
int * |
length |
|
) |
| |
This function is used to get the EDID buffer and length of the connected display.
- Parameters
-
[in] | handle | Handle for the video display. This must be HDMI output handle. |
[out] | edid | The EDID raw buffer of the display. The HAL implementation should malloc() the buffer and return it to the application. The application is required to free() the buffer after using it; If HDMI is not connected no data should be returned, and the API returns dsERR_INVALID_STATE. |
[out] | length | The length of EDID buffer data |
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsGetEDIDBytes api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 149 of file dsDisplay.c.
◆ dsGetDisplayAspectRatio()
This function gets the aspect ratio for the dsiaply device. This function returns the aspect ratio of the display corresponding to the specified display device handle.
- Parameters
-
[in] | handle | Handle of the display device. |
[out] | aspectRatio | The address of a location to hold the current aspect ratio for the specified display device on return. |
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsGetDisplayAspectRatio api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 93 of file dsDisplay.c.
◆ dsDisplayTerm()
This function deinitialize the display sub-system. This function deallocates the data structures used within the display module and releases any display specific handles.
- Returns
- Device Settings error code
- Return values
-
dsERR_NONE | If sucessfully dsDisplayTerm api has been called using IARM support. |
dsERR_GENERAL | General failure. |
Definition at line 194 of file dsDisplay.c.
◆ dsRegisterDisplayEventCallback()
Register a callback function to listen for display events.
This function registers a callback function for display events corresponding to the specified display device handle.
- Note
- Application should install at most one callback function per handle. Multiple listeners are supported at application layer and thus not required in HAL implementation.
- Parameters
-
handle | Handle of the display device. |
cb | The callback function. |
- Returns
- Error code.
- Return values
-