Component Video APIs

This group outlines all component video related APIs. More...

Functions
int	ADL2_CV_DongleSettings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpDongleSetting, int *lpOverrideSettingsSupported, int *lpCurOverrideSettings)
	Function to retrieve the settings of the CV dongle. More...
int	ADL2_CV_DongleSettings_Reset (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex)
	Function to reset the CV settings to its default settings. More...
int	ADL2_CV_DongleSettings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iOverrideSettings)
	Function to set the current CV dongle settings. More...
int	ADL_CV_DongleSettings_Get (int iAdapterIndex, int iDisplayIndex, int *lpDongleSetting, int *lpOverrideSettingsSupported, int *lpCurOverrideSettings)
	Function to retrieve the settings of the CV dongle. More...
int	ADL_CV_DongleSettings_Reset (int iAdapterIndex, int iDisplayIndex)
	Function to reset the CV settings to its default settings. More...
int	ADL_CV_DongleSettings_Set (int iAdapterIndex, int iDisplayIndex, int iOverrideSettings)
	Function to set the current CV dongle settings. More...

Detailed Description

This group outlines all component video related APIs.

Function Documentation

ADL2_CV_DongleSettings_Get()

int ADL2_CV_DongleSettings_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpDongleSetting,
		int *	lpOverrideSettingsSupported,
		int *	lpCurOverrideSettings
	)

Function to retrieve the settings of the CV dongle.

This function retrieves the CV dongle settings.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpDongleSetting	The pointer to the CV dongle settings.
[out]	lpOverrideSettingsSupported	The pointer to the supported override settings.
[out]	lpCurOverrideSettings	The pointer to the current CV override settings. Values used by ADL_CV_DongleSettings_xxx

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Deprecated:

Dropping support for component, composite, and S-Video connectors.

Remarks

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

ADL2_CV_DongleSettings_Reset()

int ADL2_CV_DongleSettings_Reset	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex
	)

Function to reset the CV settings to its default settings.

This function resets the CV dongle settings.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

Deprecated:

Dropping support for component, composite, and S-Video connectors.

Remarks

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

ADL2_CV_DongleSettings_Set()

int ADL2_CV_DongleSettings_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int	iOverrideSettings
	)

Function to set the current CV dongle settings.

This function sets the current CV dongle settings to a specified setting.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iOverrideSettings	The new CV settings. Values used by ADL_CV_DongleSettings_xxx

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

Deprecated:

Dropping support for component, composite, and S-Video connectors.

Remarks

Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

ADL_CV_DongleSettings_Get()

int ADL_CV_DongleSettings_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpDongleSetting,
		int *	lpOverrideSettingsSupported,
		int *	lpCurOverrideSettings
	)

Function to retrieve the settings of the CV dongle.

This function retrieves the CV dongle settings.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpDongleSetting	The pointer to the CV dongle settings.
[out]	lpOverrideSettingsSupported	The pointer to the supported override settings.
[out]	lpCurOverrideSettings	The pointer to the current CV override settings. Values used by ADL_CV_DongleSettings_xxx

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Deprecated:

Dropping support for component, composite, and S-Video connectors.

ADL_CV_DongleSettings_Reset()

int ADL_CV_DongleSettings_Reset	(	int	iAdapterIndex,
		int	iDisplayIndex
	)

Function to reset the CV settings to its default settings.

This function resets the CV dongle settings.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

Deprecated:

Dropping support for component, composite, and S-Video connectors.

ADL_CV_DongleSettings_Set()

int ADL_CV_DongleSettings_Set	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int	iOverrideSettings
	)

Function to set the current CV dongle settings.

This function sets the current CV dongle settings to a specified setting.

Supported Platforms:

Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iOverrideSettings	The new CV settings. Values used by ADL_CV_DongleSettings_xxx

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

Deprecated:

Dropping support for component, composite, and S-Video connectors.