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:

hPAD	A handle to an ASX PAD control.
pszArtist	The string buffer of size nFieldLength allocated by the caller.
nStringLength	The 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:

hPAD	A handle to an ASX PAD control.
pszChannelName	The string buffer of size nFieldLength allocated by the caller.
nStringLength	The 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:

hPAD	A handle to an ASX PAD control.
pszComment	The string buffer of size nFieldLength allocated by the caller.
nStringLength	The 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:

hPAD	A handle to an ASX PAD control.
pnProgramType	Returns 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:

hPAD	A handle to an ASX PAD control.
eType	The RDS/RBDS type selection.
nPTY	The program type code to translate.
pszString	The string buffer of size nStringLength allocated by the caller.
nStringLength	The 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:

hPAD	A handle to an ASX PAD control.
uPI	The 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:

hPAD	A handle to an ASX PAD control.
pszTitle	The string buffer of size nFieldLength allocated by the caller.
nStringLength	The 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.