ADL (AMD Display Library) Public APIs  Version 17.0
Functions

This group outlines all television related APIs. More...

Functions

int ADL2_Display_TVCaps_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpcaps)
 Function to retrieve the TV Caps display information. More...
 
int ADL2_TV_Standard_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefault, int *lpSupportedStandards)
 Function to retrieve the TV standard. More...
 
int ADL2_TV_Standard_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the TV standard. More...
 
int ADL_Display_TVCaps_Get (int iAdapterIndex, int iDisplayIndex, int *lpcaps)
 Function to retrieve the TV Caps display information. More...
 
int ADL_TV_Standard_Get (int iAdapterIndex, int iDisplayIndex, int *lpCurrent, int *lpDefault, int *lpSupportedStandards)
 Function to retrieve the TV standard. More...
 
int ADL_TV_Standard_Set (int iAdapterIndex, int iDisplayIndex, int iCurrent)
 Function to set the TV standard. More...
 

Detailed Description

This group outlines all television related APIs.

Function Documentation

◆ ADL2_Display_TVCaps_Get()

int ADL2_Display_TVCaps_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpcaps 
)

Function to retrieve the TV Caps display information.

This function retrieves the display adjustment information.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpcapsThe pointer to the TV Caps information retrieved from the driver. TV Capabilities and Standards
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_TV_Standard_Get()

int ADL2_TV_Standard_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefault,
int *  lpSupportedStandards 
)

Function to retrieve the TV standard.

This function retrieves the TV standard for a specified display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current TV standard. TV Capabilities and Standards
[out]lpDefaultThe pointer to the default TV standard. TV Capabilities and Standards
[out]lpSupportedStandardsThe pointer to the bit vector of the support video standard.
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_TV_Standard_Set()

int ADL2_TV_Standard_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the TV standard.

This function sets the TV Standard for a specified display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired TV Standard. TV Capabilities and Standards
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_Display_TVCaps_Get()

int ADL_Display_TVCaps_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpcaps 
)

Function to retrieve the TV Caps display information.

This function retrieves the display adjustment information.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpcapsThe pointer to the TV Caps information retrieved from the driver. TV Capabilities and Standards
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_TV_Standard_Get()

int ADL_TV_Standard_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int *  lpCurrent,
int *  lpDefault,
int *  lpSupportedStandards 
)

Function to retrieve the TV standard.

This function retrieves the TV standard for a specified display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]lpCurrentThe pointer to the current TV standard. TV Capabilities and Standards
[out]lpDefaultThe pointer to the default TV standard. TV Capabilities and Standards
[out]lpSupportedStandardsThe pointer to the bit vector of the support video standard.
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_TV_Standard_Set()

int ADL_TV_Standard_Set ( int  iAdapterIndex,
int  iDisplayIndex,
int  iCurrent 
)

Function to set the TV standard.

This function sets the TV Standard for a specified display.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDisplayIndexThe desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]iCurrentThe desired TV Standard. TV Capabilities and Standards
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.

Copyright © 2009-2020 Advanced Micro Devices, Inc. All rights reserved.