ASX Version4.20.14
Functions

PAD control functions

These functions support Program Auxilary Data for HD Radio and RDS for FM analog. More...

Functions

ASX32_API ASX_ERROR ASX_PAD_GetChannelName (ASX_HANDLE hPAD, char *pszChannelName, const int nStringLength)
 Get a Program Auxilary Data channel name.
ASX32_API ASX_ERROR ASX_PAD_GetArtist (ASX_HANDLE hPAD, char *pszArtist, const int nStringLength)
 Get a Program Auxilary Data artist.
ASX32_API ASX_ERROR ASX_PAD_GetTitle (ASX_HANDLE hPAD, char *pszTitle, const int nStringLength)
 Get a Program Auxilary Data title.
ASX32_API ASX_ERROR ASX_PAD_GetComment (ASX_HANDLE hPAD, char *pszComment, const int nStringLength)
 Get a Program Auxilary Data comment.
ASX32_API ASX_ERROR ASX_PAD_GetProgramType (ASX_HANDLE hPAD, int *pnProgramType)
 Get a Program Auxilary Data program type (PTY).
ASX32_API ASX_ERROR ASX_PAD_GetProgramTypeString (ASX_HANDLE hPAD, const enum asxTUNER_RDS_TYPE eType, const int nPTY, char *pszString, const int nStringLength)
 Get a Program Auxilary Data PTY string.
ASX32_API ASX_ERROR ASX_PAD_GetRdsPI (ASX_HANDLE hPAD, int *uPI)
 Get a Program Identification number.

Detailed Description

These functions support Program Auxilary Data for HD Radio and RDS for FM analog.


Function Documentation

ASX32_API ASX_ERROR ASX_PAD_GetArtist ( ASX_HANDLE  hPAD,
char *  pszArtist,
const int  nStringLength 
)

Get a Program Auxilary Data artist.

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
pszArtistThe string buffer of size nFieldLength allocated by the caller.
nStringLengthThe length of the pszArtist buffer. Should be ASX_LONG_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetChannelName ( ASX_HANDLE  hPAD,
char *  pszChannelName,
const int  nStringLength 
)

Get a Program Auxilary Data channel name.

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
pszChannelNameThe string buffer of size nFieldLength allocated by the caller.
nStringLengthThe length of the pszChannelName buffer. Should be ASX_SHORT_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetComment ( ASX_HANDLE  hPAD,
char *  pszComment,
const int  nStringLength 
)

Get a Program Auxilary Data comment.

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
pszCommentThe string buffer of size nFieldLength allocated by the caller.
nStringLengthThe length of the pszComment buffer. Should be ASX_LONGLONG_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetProgramType ( ASX_HANDLE  hPAD,
int *  pnProgramType 
)

Get a Program Auxilary Data program type (PTY).

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
pnProgramTypeReturns the program type (PTY).
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetProgramTypeString ( ASX_HANDLE  hPAD,
const enum asxTUNER_RDS_TYPE  eType,
const int  nPTY,
char *  pszString,
const int  nStringLength 
)

Get a Program Auxilary Data PTY string.

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
eTypeThe RDS/RBDS type selection.
nPTYThe program type code to translate.
pszStringThe string buffer of size nStringLength allocated by the caller.
nStringLengthThe length of the pszComment buffer. Should be ASX_LONGLONG_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetRdsPI ( ASX_HANDLE  hPAD,
int *  uPI 
)

Get a Program Identification number.

This control will only ever exist on a tuner node. A valid PI will only be returned for a tuner set to analog FM.

Parameters:
hPADA handle to an ASX PAD control.
uPIThe returned program identification number.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.
ASX32_API ASX_ERROR ASX_PAD_GetTitle ( ASX_HANDLE  hPAD,
char *  pszTitle,
const int  nStringLength 
)

Get a Program Auxilary Data title.

This control will only ever exist on a tuner node.

Parameters:
hPADA handle to an ASX PAD control.
pszTitleThe string buffer of size nFieldLength allocated by the caller.
nStringLengthThe length of the pszTitle buffer. Should be ASX_LONG_STRING.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
tuner/main.c.