Description

Described herein are the DeviceSettings HAL types and functions that are part of the Video Port subsystem. The Video Port subsystem manages video output port hardware operations.

Typedefs
typedef void(*	dsHDCPStatusCallback_t) (intptr_t handle, dsHdcpStatus_t status)
	Callback function used to notify applications of HDCP status. More...

Functions
dsError_t	dsVideoPortInit ()
	Initialize underlying Video Port sub-system. More...

dsError_t	dsGetVideoPort (dsVideoPortType_t type, int index, intptr_t *handle)
	Get the video port handle. More...

dsError_t	dsIsVideoPortEnabled (intptr_t handle, bool *enabled)
	Indicate whether a video port is enabled. More...

dsError_t	dsIsDisplayConnected (intptr_t handle, bool *connected)
	Indicate whether a video port is connected to a display. More...

dsError_t	dsIsDisplaySurround (intptr_t handle, bool *surround)
	This function is used to indicate if the display connected supports surround audio. More...

dsError_t	dsGetSurroundMode (intptr_t handle, int *surround)
	This function is used to get supported surround mode. More...

dsError_t	dsIsVideoPortActive (intptr_t handle, bool *active)
	This function is used to indicate whether a video port is connected to a display. More...

dsError_t	dsEnableDTCP (intptr_t handle, bool contentProtect)
	Toggle DTCP protection of a video port. More...

dsError_t	dsEnableHDCP (intptr_t handle, bool contentProtect, char *hdcpKey, size_t keySize)
	Toggle HDCP protection of a video port. More...

dsError_t	dsIsDTCPEnabled (intptr_t handle, bool *pContentProtected)
	Indicate whether a video port is DTCP protected. More...

dsError_t	dsIsHDCPEnabled (intptr_t handle, bool *pContentProtected)
	Indicate whether a video port is HDCP protected. More...

dsError_t	dsEnableVideoPort (intptr_t handle, bool enabled)
	Enable/disable a video port. More...

dsError_t	dsSetResolution (intptr_t handle, dsVideoPortResolution_t *resolution, bool persist)
	Set video port's display resolution. More...

dsError_t	dsGetResolution (intptr_t handle, dsVideoPortResolution_t *resolution)
	Get the video display resolution. More...

dsError_t	dsSetActiveSource (intptr_t handle)
	Set the port to the the active source. More...

dsError_t	dsVideoPortTerm ()
	Terminate the Video Port sub-system. More...

dsError_t	dsInitResolution (dsVideoPortResolution_t *)
	Initialize the Video Resolution. More...

dsError_t	dsRegisterHdcpStatusCallback (intptr_t handle, dsHDCPStatusCallback_t cb)
	Register a callback function to listen for HDCP status. More...

dsError_t	dsGetHDCPStatus (intptr_t handle, dsHdcpStatus_t *status)
	Get current HDCP status. More...

dsError_t	dsGetHDCPProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
	Get STB HDCP protocol version. More...

dsError_t	dsGetHDCPReceiverProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
	Get Receiver/TV HDCP protocol version. More...

dsError_t	dsGetHDCPCurrentProtocol (intptr_t handle, dsHdcpProtocolVersion_t *protocolVersion)
	Get current used HDCP protocol version. More...

dsError_t	dsGetTVHDRCapabilities (intptr_t handle, int *capabilities)
	To find the HDR capabilities of TV. More...

dsError_t	dsSupportedTvResolutions (intptr_t handle, int *resolutions)
	To find the TV supported resolutions. More...

dsError_t	dsSetForceDisable4KSupport (intptr_t handle, bool disable)

dsError_t	dsGetForceDisable4KSupport (intptr_t handle, bool *disable)

dsError_t	dsSetScartParameter (intptr_t handle, const char parameter_str, const char value_str)
	Sets various SCART parameters. More...

dsError_t	dsGetVideoEOTF (intptr_t handle, dsHDRStandard_t *video_eotf)
	Get current video Electro-Optical Transfer Function (EOT) value;. More...

dsError_t	dsGetMatrixCoefficients (intptr_t handle, dsDisplayMatrixCoefficients_t *matrix_coefficients)
	Get current matrix coefficients value. More...

dsError_t	dsGetColorDepth (intptr_t handle, unsigned int *color_depth)
	Get current color depth value. More...

dsError_t	dsGetColorSpace (intptr_t handle, dsDisplayColorSpace_t *color_space)
	Get current color space setting. More...

dsError_t	dsGetQuantizationRange (intptr_t handle, dsDisplayQuantizationRange_t *quantization_range)
	Get quatization range. More...

dsError_t	dsGetCurrentOutputSettings (intptr_t handle, dsHDRStandard_t video_eotf, dsDisplayMatrixCoefficients_t matrix_coefficients, dsDisplayColorSpace_t color_space, unsigned int color_depth, dsDisplayQuantizationRange_t *quantization_range)
	Get current color space setting, color depth, matrix coefficients, video Electro-Optical Transfer Function (EOT) and quantization range in one call. More...

dsError_t	dsIsOutputHDR (intptr_t handle, bool *hdr)
	Check Video Output is HDR or not. More...

dsError_t	dsResetOutputToSDR ()
	Reset Video Output to SDR. More...

dsError_t	dsSetHdmiPreference (intptr_t handle, dsHdcpProtocolVersion_t *hdcpCurrentProtocol)
	This API is used to set the Preferred HDMI Protocol. More...

dsError_t	dsGetHdmiPreference (intptr_t handle, dsHdcpProtocolVersion_t *hdcpCurrentProtocol)
	This API is used to get the Preferred HDMI Protocol. More...

dsError_t	dsGetIgnoreEDIDStatus (intptr_t handle, bool *status)

dsError_t	dsSetBackgroundColor (intptr_t handle, dsVideoBackgroundColor_t color)
	This API is used to set the background color for video port. More...

dsError_t	dsSetForceHDRMode (intptr_t handle, dsHDRStandard_t mode)
	This API is used to set/reset force HDR mode. More...

dsError_t	dsColorDepthCapabilities (intptr_t handle, unsigned int *colorDepthCapability)
	To find the color depth capabilities. More...

dsError_t	dsGetPreferredColorDepth (intptr_t handle, dsDisplayColorDepth_t *colorDepth, bool persist)
	To get the preffered color depth mode. More...

dsError_t	dsSetPreferredColorDepth (intptr_t handle, dsDisplayColorDepth_t colorDepth, bool persist)
	To set the preffered color depth mode. More...

Typedef Documentation

◆ dsHDCPStatusCallback_t

typedef void(* dsHDCPStatusCallback_t) (intptr_t handle, dsHdcpStatus_t status)

Callback function used to notify applications of HDCP status.

HAL Implementation should call this method to delivery HDCP status to the application (e.g. Authentication , Failure etc.).

Parameters

handle	Handle of the display device.
event	Display HDCP status.

Returns: None.

Definition at line 312 of file dsVideoPort.h.

Function Documentation

◆ dsVideoPortInit()

dsError_t dsVideoPortInit ( )

Initialize underlying Video Port sub-system.

This function must initialize all the video specific output ports.

Returns: dsError_t

Return values

dsERR_NONE	If sucessfully dsVideoportinit api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 45 of file dsVideoPort.c.

◆ dsGetVideoPort()

dsError_t dsGetVideoPort	(	dsVideoPortType_t	type,
		int	index,
		intptr_t *	handle
	)

Get the video port handle.

This function gets the handle for the type of video port requested. It must return dsERR_OPERATION_NOT_SUPPORTED if the requested video port is unavailable.

Parameters

[in]	type	Type of video port (e.g. HDMI).
[in]	index	The index of the video device (0, 1, ...).
[out]	handle	The address of a location to hold the video device handle on return.

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsgetvideoport api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 64 of file dsVideoPort.c.

◆ dsIsVideoPortEnabled()

dsError_t dsIsVideoPortEnabled	(	intptr_t	handle,
		bool *	enabled
	)

Indicate whether a video port is enabled.

This function indicates whether the specified video port is enabled or not.

Parameters

[in]	handle	Handle of the video port.
[out]	enabled	The address of a location to hold the video port enable state on return (true when port is enabled, false otherwise).

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsIsVideoPortEnabled api has been called using IARM support.
dsERR_GENERAL	General failure .

Definition at line 125 of file dsVideoPort.c.

◆ dsIsDisplayConnected()

dsError_t dsIsDisplayConnected	(	intptr_t	handle,
		bool *	connected
	)

Indicate whether a video port is connected to a display.

This function is used to find out whether the video port is connected to a display or not.

Parameters

[in]	handle	Handle of the video port.
[out]	connected	The address of a location to hold the connection state on return (true when connected, false otherwise).

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsIsDisplayConnected api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 245 of file dsVideoPort.c.

◆ dsIsDisplaySurround()

dsError_t dsIsDisplaySurround	(	intptr_t	handle,
		bool *	surround
	)

This function is used to indicate if the display connected supports surround audio.

Parameters

[in]	handle	Handle of the video port.
[out]	surround	It is set to True if the display supports surround audio.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsIsDisplaySurround api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 273 of file dsVideoPort.c.

◆ dsGetSurroundMode()

dsError_t dsGetSurroundMode	(	intptr_t	handle,
		int *	surround
	)

This function is used to get supported surround mode.

Parameters

[in]	handle	Handle of the video port.
[out]	surround	mode.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetSurroundMode api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 301 of file dsVideoPort.c.

◆ dsIsVideoPortActive()

dsError_t dsIsVideoPortActive	(	intptr_t	handle,
		bool *	active
	)

This function is used to indicate whether a video port is connected to a display.

Parameters

[in]	handle	Handle of the video port.
[out]	connected	The address of a location to hold the connection state on return (true when connected, false otherwise).

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsIsDisplayConnected api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 577 of file dsVideoPort.c.

◆ dsEnableDTCP()

dsError_t dsEnableDTCP	(	intptr_t	handle,
		bool	contentProtect
	)

Toggle DTCP protection of a video port.

This function is used to turn on/off the DTCP content protection for the specified video port. Must return dsERR_OPERATION_NOT_SUPPORTED if DTCP content protection is not available.

Parameters

[in]	handle	Handle of the video port.
[in]	contentProtect	Flag to control DTCP content protection (true for enabled, false for disabled).

Returns: Device Settings error code

Return values

dsError_t

◆ dsEnableHDCP()

dsError_t dsEnableHDCP	(	intptr_t	handle,
		bool	contentProtect,
		char *	hdcpKey,
		size_t	keySize
	)

Toggle HDCP protection of a video port.

This function is used to turn on/off the HDCP content protection for the specified video port. Must return dsERR_OPERATION_NOT_SUPPORTED if HDCP content protection is not available.

Parameters

[in]	handle	Handle of the video port.
[in]	contentProtect	Flag to control HDCP content protection (true for enabled, false for disabled).
[in]	hdcpKey	HDCP key.
[in]	keySize	HDCP key size.

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsEnableHDCP api has been called using IARM support.
dsERR_GENERAL	General failure.
dsERR_INVALID_PARAM	If invalid HCDP key is used.

Definition at line 530 of file dsVideoPort.c.

◆ dsIsDTCPEnabled()

dsError_t dsIsDTCPEnabled	(	intptr_t	handle,
		bool *	pContentProtected
	)

Indicate whether a video port is DTCP protected.

This function indicates whether the specified video port is configured for DTCP content protection. It must return dsERR_OPERATION_NOT_SUPPORTED if content protection is not supported.

Parameters

[in]	handle	Handle of the video port.
[out]	*pContentProtected	The address of a location to hold the DTCP content protection state on return (true when enabled, false otherwise).

Returns: Device Settings error code

Return values

dsError_t

◆ dsIsHDCPEnabled()

dsError_t dsIsHDCPEnabled	(	intptr_t	handle,
		bool *	pContentProtected
	)

Indicate whether a video port is HDCP protected.

Parameters

[in]	handle	Handle of the video port.
[out]	enabled	The address of a location to hold the HDCP content protection state on return (true when enabled, false otherwise).

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsIsHDCPEnabled api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 96 of file dsVideoPort.c.

◆ dsEnableVideoPort()

dsError_t dsEnableVideoPort	(	intptr_t	handle,
		bool	enabled
	)

Enable/disable a video port.

This function enables or disables the specified video port.

Parameters

[in]	handle	Handle of the video port.
[in]	enabled	Flag to control the video port state (true to enable, false to disable)

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsEnableVideoPort api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 328 of file dsVideoPort.c.

◆ dsSetResolution()

dsError_t dsSetResolution	(	intptr_t	handle,
		dsVideoPortResolution_t *	resolution,
		bool	persist
	)

Set video port's display resolution.

This function sets the resolution for the video corresponding to the specified port handle.

Parameters

[in]	handle	Handle of the video port.
[in]	*resolution	The address of a structure containing the video port resolution settings.
[in]	persist	In false state allows disabling persist of resolution value.

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsSetResolution api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 409 of file dsVideoPort.c.

◆ dsGetResolution()

dsError_t dsGetResolution	(	intptr_t	handle,
		dsVideoPortResolution_t *	resolution
	)

Get the video display resolution.

This function Gets the resolution for the video corresponding to the specified port and index.

Parameters

[in]	handle	Handle of the video output port.
[in]	*resolution	The address of a structure containing the video output port resolution settings.

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsGetResolution api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 353 of file dsVideoPort.c.

◆ dsSetActiveSource()

dsError_t dsSetActiveSource ( intptr_t handle )

Set the port to the the active source.

Parameters

handle Handle of the video port.

Returns: Device Settings error code

Return values

dsError_t

◆ dsVideoPortTerm()

dsError_t dsVideoPortTerm ( )

Terminate the Video Port sub-system.

This function must terminate all the video output ports. It must reset any data structures used within video port module and release any video port specific handles.

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsVideoPortTerm api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 511 of file dsVideoPort.c.

◆ dsInitResolution()

dsError_t dsInitResolution ( dsVideoPortResolution_t * )

Initialize the Video Resolution.

This function Initialize the Video Resolution

Parameters

[in] Initialize the Video Resolution

Returns: Device Settings error code

Return values

dsError_t

◆ dsRegisterHdcpStatusCallback()

dsError_t dsRegisterHdcpStatusCallback	(	intptr_t	handle,
		dsHDCPStatusCallback_t	cb
	)

Register a callback function to listen for HDCP status.

This function registers a callback function for getting the HDCP status on HDMI Ports

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

dsError_t

◆ dsGetHDCPStatus()

dsError_t dsGetHDCPStatus	(	intptr_t	handle,
		dsHdcpStatus_t *	status
	)

Get current HDCP status.

Parameters

[in] status Handle HDCP status

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsGetHDCPStatus api has been called using IARM support.
dsERR_GENERAL	General failure.

Definition at line 154 of file dsVideoPort.c.

◆ dsGetHDCPProtocol()

dsError_t dsGetHDCPProtocol	(	intptr_t	handle,
		dsHdcpProtocolVersion_t *	protocolVersion
	)

Get STB HDCP protocol version.

Parameters

handle	Handle of the display device.
[in/out]	HDCP protocol version

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsGetHDCPProtocol api has been called.
dsERR_GENERAL	General failure.

Definition at line 177 of file dsVideoPort.c.

◆ dsGetHDCPReceiverProtocol()

dsError_t dsGetHDCPReceiverProtocol	(	intptr_t	handle,
		dsHdcpProtocolVersion_t *	protocolVersion
	)

Get Receiver/TV HDCP protocol version.

Parameters

handle	Handle of the display device.
[in/out]	HDCP protocol version

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsGetHDCPProtocol api has been called.
dsERR_GENERAL	General failure.

Definition at line 200 of file dsVideoPort.c.

◆ dsGetHDCPCurrentProtocol()

dsError_t dsGetHDCPCurrentProtocol	(	intptr_t	handle,
		dsHdcpProtocolVersion_t *	protocolVersion
	)

Get current used HDCP protocol version.

Parameters

handle	Handle of the display device.
[in/out]	HDCP protocol version

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsGetHDCPProtocol api has been called.
dsERR_GENERAL	General failure.

Definition at line 223 of file dsVideoPort.c.

◆ dsGetTVHDRCapabilities()

dsError_t dsGetTVHDRCapabilities	(	intptr_t	handle,
		int *	capabilities
	)

To find the HDR capabilities of TV.

This function is used to get the HDR capabilities supported by the TV.

Parameters

[in]	handle	Handle for the video device (video decoder)
[out]	*capabilities	OR-ed value of supported HDR standards.

Returns: dsError_t Error code.

Definition at line 605 of file dsVideoPort.c.

◆ dsSupportedTvResolutions()

dsError_t dsSupportedTvResolutions	(	intptr_t	handle,
		int *	resolutions
	)

To find the TV supported resolutions.

This function is used to get the TV supported resolutions.

Parameters

[in]	handle	Handle for the video device (video decoder)
[out]	*resolution	OR-ed value supported by TV.

Returns: dsError_t Error code.

Definition at line 627 of file dsVideoPort.c.

◆ dsSetScartParameter()

dsError_t dsSetScartParameter	(	intptr_t	handle,
		const char *	parameter_str,
		const char *	value_str
	)

Sets various SCART parameters.

Supported values: parameter_str value_str "aspect_ratio" "4x3", 16x9" "tv_startup" "on", "off" "tv_startup" "on", "off" "rgb" "on" (disables cvbs) "cvbs" "on" (disables rgb) "macrovision", "*" (not implemented) "cgms", "disabled" "cgms", "copyNever" "cgms", "copyOnce" "cgms", "copyFreely" "cgms", "copyNoMore" "port" "on", "off"

Parameters

[in]	parameter_str	- a name of parameter
[in]	value_str	- a value of parameter

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 380 of file dsVideoPort.c.

◆ dsGetVideoEOTF()

dsError_t dsGetVideoEOTF	(	intptr_t	handle,
		dsHDRStandard_t *	video_eotf
	)

Get current video Electro-Optical Transfer Function (EOT) value;.

Parameters

[in]	handle	- Handle of the display device.
[out]	video_eotf	- pointer to EOFF value

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 796 of file dsVideoPort.c.

◆ dsGetMatrixCoefficients()

dsError_t dsGetMatrixCoefficients	(	intptr_t	handle,
		dsDisplayMatrixCoefficients_t *	matrix_coefficients
	)

Get current matrix coefficients value.

Parameters

[in]	handle	- Handle of the display device.
[out]	matrix_coefficients	- pointer to matrix coefficients value

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 825 of file dsVideoPort.c.

◆ dsGetColorDepth()

dsError_t dsGetColorDepth	(	intptr_t	handle,
		unsigned int *	color_depth
	)

Get current color depth value.

Parameters

[in]	handle	- Handle of the display device.
[out]	color_depth	- pointer to color depths value.

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 854 of file dsVideoPort.c.

◆ dsGetColorSpace()

dsError_t dsGetColorSpace	(	intptr_t	handle,
		dsDisplayColorSpace_t *	color_space
	)

Get current color space setting.

Parameters

[in]	handle	- Handle of the display device.
[out]	color_space	- pointer to color space value.

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 883 of file dsVideoPort.c.

◆ dsGetQuantizationRange()

dsError_t dsGetQuantizationRange	(	intptr_t	handle,
		dsDisplayQuantizationRange_t *	quantization_range
	)

Get quatization range.

Parameters

[in]	handle	- Handle of the display device.
[out]	quantization_range	- pointer to quantization range value.

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 912 of file dsVideoPort.c.

◆ dsGetCurrentOutputSettings()

dsError_t dsGetCurrentOutputSettings	(	intptr_t	handle,
		dsHDRStandard_t *	video_eotf,
		dsDisplayMatrixCoefficients_t *	matrix_coefficients,
		dsDisplayColorSpace_t *	color_space,
		unsigned int *	color_depth,
		dsDisplayQuantizationRange_t *	quantization_range
	)

Get current color space setting, color depth, matrix coefficients, video Electro-Optical Transfer Function (EOT) and quantization range in one call.

Parameters

[in]	handle	- Handle of the display device.
[out]	video_eotf	- pointer to EOFF value
[out]	matrix_coefficients	- pointer to matrix coefficients value
[out]	color_space	- pointer to color space value.
[out]	color_depth	- pointer to color depths value.
[out]	quantization_range	- pointer to quantization range value.

Returns: Device Settings error code

Return values

dsERR_NONE	on success
dsERR_GENERAL	General failure.

Definition at line 941 of file dsVideoPort.c.

◆ dsIsOutputHDR()

dsError_t dsIsOutputHDR	(	intptr_t	handle,
		bool *	hdr
	)

Check Video Output is HDR or not.

This function checks if the video output is HDR or not.

Parameters

[in]	handle	Handle of the video port.
[in]	*hdr	The bool pointer

Returns: Error Code.

Return values

dsError_t

Definition at line 693 of file dsVideoPort.c.

◆ dsResetOutputToSDR()

dsError_t dsResetOutputToSDR ( )

Reset Video Output to SDR.

This function resets the video output to SDR

Returns: Error Code.

Return values

dsError_t

Definition at line 721 of file dsVideoPort.c.

◆ dsSetHdmiPreference()

dsError_t dsSetHdmiPreference	(	intptr_t	handle,
		dsHdcpProtocolVersion_t *	hdcpCurrentProtocol
	)

This API is used to set the Preferred HDMI Protocol.

This function sets the Preferred HDMI Protocol

Parameters

[in]	handle	Handle of the video port.
[in]	*hdcpCurrentProtocol	Address of the structure containing HDCP Protocol version enums dsHDCP_VERSION_1X = 0, < HDCP Protocol version 1.x dsHDCP_VERSION_2X, < HDCP Protocol version 2.x dsHDCP_VERSION_MAX < Maximum index for HDCP protocol.

Returns: Error Code.

Return values

dsError_t

Definition at line 741 of file dsVideoPort.c.

◆ dsGetHdmiPreference()

dsError_t dsGetHdmiPreference	(	intptr_t	handle,
		dsHdcpProtocolVersion_t *	hdcpCurrentProtocol
	)

This API is used to get the Preferred HDMI Protocol.

This function gets the Preferred HDMI Protocol and updates the *hdcpCurrentProtocol accordingly

Parameters

[in]	handle	Handle of the video port.
[in]	*hdcpCurrentProtocol	Address of the structure containing HDCP Protocol version enums dsHDCP_VERSION_1X = 0, < HDCP Protocol version 1.x dsHDCP_VERSION_2X, < HDCP Protocol version 2.x dsHDCP_VERSION_MAX < Maximum index for HDCP protocol.

Returns: Error Code.

Return values

dsError_t

Definition at line 768 of file dsVideoPort.c.

◆ dsSetBackgroundColor()

dsError_t dsSetBackgroundColor	(	intptr_t	handle,
		dsVideoBackgroundColor_t	color
	)

This API is used to set the background color for video port.

This function sets the background color for video port.

Parameters

[in]	handle	Handle of the video port.
[in]	color	color to be set

Returns: Error Code.

Return values

dsError_t

◆ dsSetForceHDRMode()

dsError_t dsSetForceHDRMode	(	intptr_t	handle,
		dsHDRStandard_t	mode
	)

This API is used to set/reset force HDR mode.

This function set/reset force HDR mode for video port.

Parameters

[in]	handle	Handle of the video port.
[in]	mode	dsHDRStandard_t type

Returns: Error Code.

Return values

dsError_t

Definition at line 974 of file dsVideoPort.c.

◆ dsColorDepthCapabilities()

dsError_t dsColorDepthCapabilities	(	intptr_t	handle,
		unsigned int *	colorDepthCapability
	)

To find the color depth capabilities.

This function is used to get the supported color depth capabilities.

Parameters

[in]	handle	Handle for the video port.
[out]	*capabilities	OR-ed value of supported color depth standards.

Returns: dsError_t Error code.

Definition at line 488 of file dsVideoPort.c.

◆ dsGetPreferredColorDepth()

dsError_t dsGetPreferredColorDepth	(	intptr_t	handle,
		dsDisplayColorDepth_t *	colorDepth,
		bool	persist
	)

To get the preffered color depth mode.

This function is used to get the preffered color depth mode.

Parameters

[in]	handle	Handle for the video port.
[out]	colorDepth	color depth value.

Returns: dsError_t Error code.

Definition at line 436 of file dsVideoPort.c.

◆ dsSetPreferredColorDepth()

dsError_t dsSetPreferredColorDepth	(	intptr_t	handle,
		dsDisplayColorDepth_t	colorDepth,
		bool	persist
	)

To set the preffered color depth mode.

This function is used to set the preffered color depth mode.

Parameters

[in]	handle	Handle for the video port.
[in]	colorDepth	color depth value.
[in]	persist	to persist value

Returns: dsError_t Error code.

Definition at line 463 of file dsVideoPort.c.

Description

Typedefs

Functions

Typedef Documentation

◆ dsHDCPStatusCallback_t

Function Documentation

◆ dsVideoPortInit()

◆ dsGetVideoPort()

◆ dsIsVideoPortEnabled()

◆ dsIsDisplayConnected()

◆ dsIsDisplaySurround()

◆ dsGetSurroundMode()

◆ dsIsVideoPortActive()

◆ dsEnableDTCP()

◆ dsEnableHDCP()

◆ dsIsDTCPEnabled()

◆ dsIsHDCPEnabled()

◆ dsEnableVideoPort()

◆ dsSetResolution()

◆ dsGetResolution()

◆ dsSetActiveSource()

◆ dsVideoPortTerm()

◆ dsInitResolution()

◆ dsRegisterHdcpStatusCallback()

◆ dsGetHDCPStatus()

◆ dsGetHDCPProtocol()

◆ dsGetHDCPReceiverProtocol()

◆ dsGetHDCPCurrentProtocol()

◆ dsGetTVHDRCapabilities()

◆ dsSupportedTvResolutions()

◆ dsSetScartParameter()

◆ dsGetVideoEOTF()

◆ dsGetMatrixCoefficients()

◆ dsGetColorDepth()

◆ dsGetColorSpace()

◆ dsGetQuantizationRange()

◆ dsGetCurrentOutputSettings()

◆ dsIsOutputHDR()

◆ dsResetOutputToSDR()

◆ dsSetHdmiPreference()

◆ dsGetHdmiPreference()

◆ dsSetBackgroundColor()

◆ dsSetForceHDRMode()

◆ dsColorDepthCapabilities()

◆ dsGetPreferredColorDepth()

◆ dsSetPreferredColorDepth()