PDTMFEncoder Class Reference
#include <dtmf.h>
List of all members.
Detailed Description
this class can be used to generate PCM data for DTMF tones at a sample rate of 8khz
Member Enumeration Documentation
Constructor & Destructor Documentation
PDTMFEncoder::PDTMFEncoder |
( |
const char * |
dtmf = NULL , |
|
|
unsigned |
milliseconds = DefaultToneLen | |
|
) |
| | |
Create PCM data for the specified DTMF sequence
- Parameters:
-
| dtmf | character string to encode |
| milliseconds | length of each DTMF tone in milliseconds |
PDTMFEncoder::PDTMFEncoder |
( |
char |
key, |
|
|
unsigned |
milliseconds = DefaultToneLen | |
|
) |
| | |
Create PCM data for the specified dtmf key
- Parameters:
-
| key | character string to encode |
| milliseconds | length of each DTMF tone in milliseconds |
Member Function Documentation
void PDTMFEncoder::AddTone |
( |
double |
frequency1, |
|
|
double |
frequency2 = 0 , |
|
|
unsigned |
milliseconds = DefaultToneLen | |
|
) |
| | |
Add the PCM data for the specified dual-frequency tone to the buffer frequency2 can be zero, which will generate a single frequency tone
void PDTMFEncoder::AddTone |
( |
char |
ch, |
|
|
unsigned |
milliseconds = DefaultToneLen | |
|
) |
| | |
Add the PCM data for the specified tone to the buffer
- Parameters:
-
| ch | character to encode |
| milliseconds | length of DTMF tone in milliseconds |
void PDTMFEncoder::AddTone |
( |
const char * |
str, |
|
|
unsigned |
milliseconds = DefaultToneLen | |
|
) |
| | |
Add the PCM data for the specified tone sequence to the buffer
- Parameters:
-
| str | string to encode |
| milliseconds | length of DTMF tone in milliseconds |
char PDTMFEncoder::DtmfChar |
( |
PINDEX |
i |
) |
|
Convenience function to get the ASCII character for a DTMF index, where the index varies from 0 to 15
- Returns:
- ASCII value
- Parameters:
-
void PDTMFEncoder::GenerateBusyTone |
( |
|
) |
[inline] |
Generate PCM data for a single cadence of the US standard busy tone of 480/620hz for 1/2 second, 1/2 second of silence
References PTones::Generate().
void PDTMFEncoder::GenerateDialTone |
( |
|
) |
[inline] |
Generate PCM data for 1 second of US standard dial tone of 350/440hz
References PTones::Generate().
void PDTMFEncoder::GenerateRingBackTone |
( |
|
) |
[inline] |
Generate PCM data for a single cadence of the US standard ring tone of 440/480hz for 2 seconds, followed by 5 seconds of silence
References PTones::Generate().
The documentation for this class was generated from the following file: