PAD Control
[Mixer and Controls]

The PAD control supports the reading of "Program Associated Data" from a tuner node. More...

Defines
#define	HPI_PAD_CHANNEL_NAME_LEN   16
	The text string containing the station/channel combination.
#define	HPI_PAD_ARTIST_LEN   64
	The text string containing the artist.
#define	HPI_PAD_TITLE_LEN   64
	The text string containing the title.
#define	HPI_PAD_COMMENT_LEN   256
	The text string containing the comment.
#define	HPI_PAD_PROGRAM_TYPE_INVALID   0xffff
	The PTY when the tuner has not recieved any PTY.
Functions
HPI_ERR	HPI_PAD_GetChannelName (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, char *pszString, const HW32 dwDataLength)
	Get tuner's PAD channel name.
HPI_ERR	HPI_PAD_GetArtist (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, char *pszString, const HW32 dwDataLength)
	Get tuner's PAD artist information.
HPI_ERR	HPI_PAD_GetTitle (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, char *pszString, const HW32 dwDataLength)
	Get tuner's PAD title information.
HPI_ERR	HPI_PAD_GetComment (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, char *pszString, const HW32 dwDataLength)
	Get tuner's PAD comment information.
HPI_ERR	HPI_PAD_GetProgramType (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwPTY)
	Get tuner's PAD program type (PTY).
HPI_ERR	HPI_PAD_GetRdsPI (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwPI)
	Get tuner's PAD RDS program identification (PI).
HPI_ERR	HPI_PAD_GetProgramTypeString (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, const HW32 dwDataType, const HW32 nPTY, char *pszData, const HW32 dwDataLength)
	Translate tuner's PTY into a string.

---

Detailed Description

The PAD control supports the reading of "Program Associated Data" from a tuner node.

---

Define Documentation

#define HPI_PAD_CHANNEL_NAME_LEN   16

The text string containing the station/channel combination.

#define HPI_PAD_ARTIST_LEN   64

The text string containing the artist.

#define HPI_PAD_TITLE_LEN   64

The text string containing the title.

#define HPI_PAD_COMMENT_LEN   256

The text string containing the comment.

#define HPI_PAD_PROGRAM_TYPE_INVALID   0xffff

The PTY when the tuner has not recieved any PTY.

---

Function Documentation

HPI_ERR HPI_PAD_GetChannelName (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, char *  pszString, const HW32  dwDataLength )

Get tuner's PAD channel name. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pszString  Pointer to channel name string buffer. dwDataLength  The length of the passed in pszData in bytes. Minimum length is HPI_PAD_CHANNEL_NAME_LEN.

HPI_ERR HPI_PAD_GetArtist (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, char *  pszString, const HW32  dwDataLength )

Get tuner's PAD artist information. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pszString  Pointer to artist string buffer. dwDataLength  The length of the passed in pszData in bytes. Minimum length is HPI_PAD_ARTIST_LEN.

HPI_ERR HPI_PAD_GetTitle (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, char *  pszString, const HW32  dwDataLength )

Get tuner's PAD title information. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pszString  Pointer to title string buffer. dwDataLength  The length of the passed in pszData in bytes. Minimum length is HPI_PAD_TITLE_LEN.

HPI_ERR HPI_PAD_GetComment (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, char *  pszString, const HW32  dwDataLength )

Get tuner's PAD comment information. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pszString  Pointer to comment string buffer. dwDataLength  The length of the passed in pszData in bytes. Minimum length is HPI_PAD_COMMENT_LEN.

HPI_ERR HPI_PAD_GetProgramType (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwPTY )

Get tuner's PAD program type (PTY). If the PTY field has not been set by the tuner, HPI_PAD_PROGRAM_TYPE_INVALID (0xffff) is returned. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pdwPTY  Pointer to returned Program Type.

HPI_ERR HPI_PAD_GetRdsPI (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwPI )

Get tuner's PAD RDS program identification (PI). Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. pdwPI  Pointer to returned Program Identification.

HPI_ERR HPI_PAD_GetProgramTypeString (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, const HW32  dwDataType, const HW32  nPTY, char *  pszData, const HW32  dwDataLength )

Translate tuner's PTY into a string. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  HPI subsystem handle. hControl  Handle to PAD control. dwDataType  Data type. One of eHPI_RDS_type. nPTY  The PTY value to translate. pszData  Pointer to the returned data string. dwDataLength  String length. Should be 32 or larger.

---