AudioScience HPI Version_4.23.0
Data Structures | Typedefs | Enumerations | Functions

E:/asi/sw/drv/hpi/hpirds.h File Reference

RDS analysis functions. More...

#include "hpi.h"

Data Structures

struct  HPI_RDS_GROUP
 Raw RDS data. More...

Typedefs

typedef struct HPI_RDS_DATA * HPI_RDS_HANDLE
 RDS data structure.
typedef char * HPI_RDS_STRING
 Pointer to a string.

Enumerations

enum  eHPI_RDS_errors {
  HPI_RDS_ERROR_NOERROR = 0, HPI_RDS_ERROR_UNKNOWN_GROUP = 1, HPI_RDS_ERROR_INVALID_DATASIZE = 2, HPI_RDS_ERROR_BLOCK_DATA = 3,
  HPI_RDS_ERROR_HANDLE = 4
}
 

Error codes returned from HPI_RDS_AnalyzeGroup().

More...

Functions

HPI_RDS_HANDLE HPI_RDS_Create (enum eHPI_RDS_type eType)
 Create an HPIRDS instance.
void HPI_RDS_Delete (HPI_RDS_HANDLE h)
 Delete an HPIRDS instance.
void HPI_RDS_Clear (HPI_RDS_HANDLE h)
 Clears internal HPIRDS data structures.
enum eHPI_RDS_errors HPI_RDS_AnalyzeGroup (HPI_RDS_HANDLE h, const char *pData, const unsigned int nDataSize)
 Analyze a block of RDS data.
enum eHPI_RDS_errors HPI_RDS_Get_BlockErrorCounts (HPI_RDS_HANDLE h, unsigned int *uBlock0, unsigned int *uBlock1, unsigned int *uBlock2, unsigned int *uBlock3)
 Get error counts per block.
unsigned int HPI_RDS_Get_GroupType (HPI_RDS_HANDLE h)
 Get the group type.
char HPI_RDS_Get_GroupVersion (HPI_RDS_HANDLE h)
 Get the group verion.
unsigned int HPI_RDS_Get_PS_Ready (HPI_RDS_HANDLE h)
 Get PS (program service) name ready flag.
HPI_RDS_STRING HPI_RDS_Get_PS (HPI_RDS_HANDLE h)
 Get PS (program service) name.
void HPI_RDS_Set_RT_Threshold (HPI_RDS_HANDLE h, unsigned int nCount)
 Sets the RT (Radio Test) good character threshold.
unsigned int HPI_RDS_Get_RT_Ready (HPI_RDS_HANDLE h)
 Get RT (Radio Text) ready flag.
HPI_RDS_STRING HPI_RDS_Get_RT (HPI_RDS_HANDLE h)
 Get RT (Radio Text).
unsigned short HPI_RDS_Get_PI (HPI_RDS_HANDLE h)
 Get PI (Program Identification).
uint8_t HPI_RDS_Get_PTY (HPI_RDS_HANDLE h)
 Get PTY (Program Type).
HPI_RDS_STRING HPI_RDS_Get_PTY_Translate (enum eHPI_RDS_type eType, unsigned int uPTY)
 Get PTY (Program Type) text given PTY number and data type.
HPI_RDS_STRING HPI_RDS_Get_PTY_Text (HPI_RDS_HANDLE h)
 Get PTY string.
unsigned int HPI_RDS_Get_TP (HPI_RDS_HANDLE h)
 Get TP (Traffic Program).

Detailed Description

RDS analysis functions.

Copyright (C) 1997-2017 AudioScience, Inc. All rights reserved.

This software is provided 'as-is', without any express or implied warranty. In no event will AudioScience Inc. be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This copyright notice and list of conditions may not be altered or removed from any source distribution.

AudioScience, Inc. <support@audioscience.com>

( This license is GPL compatible see http://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses )