Poster of Linux kernelThe best gift for a Linux geek
ost::TelTone

ost::TelTone

Section: C Library Functions (3) Updated: 1 May 2009
Local index Up
 

NAME

ost::TelTone - An object that is used to sequence and extract telephony tones based on a telephony tone descriptor retrieved from the parsed international telephony tone database.

 

SYNOPSIS


#include <audio2.h>

Inherits ost::AudioTone.

 

Classes


struct _tonedef

struct _tonekey
 

Public Types


typedef struct ost::TelTone::_tonedef tonedef_t

typedef struct ost::TelTone::_tonekey tonekey_t
 

Public Member Functions


TelTone (tonekey_t *key, Level level, timeout_t frame=20)
Create a tone sequencing object for a specific telephony tone key id.
~TelTone ()

Linear getFrame (void)
Generate and retrieve one frame of linear audio data for the telephony tone sequence being created.
bool isComplete (void)
Check if all audio frames for this tone has been created.  

Static Public Member Functions


static bool load (const char *pathname, const char *locale=NULL)
Load a teltones database file into memory.
static tonekey_t * find (const char *tone, const char *locale=NULL)
find an entry in the teltones database.  

Protected Attributes


tonekey_t * tone

tonedef_t * def

unsigned remaining

unsigned silent

unsigned count

timeout_t framing

Level level

bool complete
 

Detailed Description

An object that is used to sequence and extract telephony tones based on a telephony tone descriptor retrieved from the parsed international telephony tone database.

Author:

David Sugar <dyfet@ostel.com> telephony tone sequencing object.

 

Member Typedef Documentation

 

typedef struct ost::TelTone::_tonedef ost::TelTone::tonedef_t

 

typedef struct ost::TelTone::_tonekey ost::TelTone::tonekey_t

 

Constructor & Destructor Documentation

 

ost::TelTone::TelTone (tonekey_t * key, Level level, timeout_t frame = 20)

Create a tone sequencing object for a specific telephony tone key id.

Parameters:

key for telephony tone.
level for generated tones.
frame timing to use in processing.

 

ost::TelTone::~TelTone ()

 

Member Function Documentation

 

static tonekey_t* ost::TelTone::find (const char * tone, const char * locale = NULL) [static]

find an entry in the teltones database.

Returns:

key of tone list if found, else NULL

Parameters:

tone name
locale to optionally search under

 

Linear ost::TelTone::getFrame (void) [virtual]

Generate and retrieve one frame of linear audio data for the telephony tone sequence being created.

Returns:

pointer to samples generated.

Reimplemented from ost::AudioTone.  

bool ost::TelTone::isComplete (void) [virtual]

Check if all audio frames for this tone has been created.

Some telephony tones, such as dialtone, may be infinite...

Returns:

true if audio is complete.

Reimplemented from ost::AudioTone.  

static bool ost::TelTone::load (const char * pathname, const char * locale = NULL) [static]

Load a teltones database file into memory.

Returns:

true if successful

Parameters:

pathname of file to load.
locale to optionally load.

 

Member Data Documentation

 

bool ost::TelTone::complete [protected]

 

unsigned ost::TelTone::count [protected]

 

tonedef_t* ost::TelTone::def [protected]

 

timeout_t ost::TelTone::framing [protected]

 

Level ost::TelTone::level [protected]

 

unsigned ost::TelTone::remaining [protected]

 

unsigned ost::TelTone::silent [protected]

 

tonekey_t* ost::TelTone::tone [protected]

 

Author

Generated automatically by Doxygen for ccAudio from the source code.


 

Index

NAME
SYNOPSIS
Classes
Public Types
Public Member Functions
Static Public Member Functions
Protected Attributes
Detailed Description
Member Typedef Documentation
typedef struct ost::TelTone::_tonedef ost::TelTone::tonedef_t
typedef struct ost::TelTone::_tonekey ost::TelTone::tonekey_t
Constructor & Destructor Documentation
ost::TelTone::TelTone (tonekey_t * key, Level level, timeout_t frame = 20)
ost::TelTone::~TelTone ()
Member Function Documentation
static tonekey_t* ost::TelTone::find (const char * tone, const char * locale = NULL) [static]
Linear ost::TelTone::getFrame (void) [virtual]
bool ost::TelTone::isComplete (void) [virtual]
static bool ost::TelTone::load (const char * pathname, const char * locale = NULL) [static]
Member Data Documentation
bool ost::TelTone::complete [protected]
unsigned ost::TelTone::count [protected]
tonedef_t* ost::TelTone::def [protected]
timeout_t ost::TelTone::framing [protected]
Level ost::TelTone::level [protected]
unsigned ost::TelTone::remaining [protected]
unsigned ost::TelTone::silent [protected]
tonekey_t* ost::TelTone::tone [protected]
Author

This document was created by man2html, using the manual pages.
Time: 21:51:52 GMT, April 16, 2011