libvpb
4.2.61
|
Modules | |
Programmable tone detector | |
More information on the libvpb programmable tone detector is available here. | |
Classes | |
struct | VPB_TONE |
Tone definition structure. More... | |
Enumerations | |
enum | VPB_TONE_ID { VPB_TONE_DIAL , VPB_TONE_RINGING , VPB_TONE_BUSY , VPB_TONE_CONGESTION , VPB_TONE_UNOBTAINABLE , VPB_TONE_CALLWAITING , VPB_TONE_STUTTERDIAL , VPB_TONE_ID_MAX } |
Symbolic identifiers for predefined, localised tones. More... | |
Tone generation | |
int WINAPI | vpb_playtone_async (int handle, const VPB_TONE &vpb_tone) |
Start a user defined tone playing and return immediately. | |
int WINAPI | vpb_playtone_async (int handle, const VPB_TONE *vpb_tone) |
Start a user defined tone playing and return immediately. | |
int WINAPI | vpb_playtone_async (int handle, VPB_TONE_ID tone_id) |
Start a locale specific predefined tone playing and return immediately. | |
int WINAPI | vpb_playtone_sync (int handle, const VPB_TONE &vpb_tone) |
Play a user defined tone, return when playback completes. | |
int WINAPI | vpb_playtone_sync (int handle, const VPB_TONE *vpb_tone) |
Play a user defined tone, return when playback completes. | |
int WINAPI | vpb_playtone_sync (int handle, VPB_TONE_ID tone_id) |
Play a locale specific predefined tone, return when playback completes. | |
int WINAPI | vpb_tone_terminate (int handle) |
Terminate a currently playing tone (user defined or dtmf). More... | |
Dial string aliases | |
int WINAPI | vpb_settone (char ident, const VPB_TONE *tone) |
Enables user to (re)define the tone associated with a dial string character. More... | |
int WINAPI | vpb_gettone (char ident, VPB_TONE *tone) |
Get the parameters of the tone represented in dial strings by ident. More... | |
int WINAPI | vpb_playtone_state (int handle) |
Returns state of play tone (1= playing, 0 = not playing) More... | |
enum VPB_TONE_ID |
Symbolic identifiers for predefined, localised tones.
int WINAPI vpb_gettone | ( | char | ident, |
VPB_TONE * | tone | ||
) |
Get the parameters of the tone represented in dial strings by ident.
ident | The dial string character to retrieve tone data for. |
tone | The returned VPB_TONE parameters for ident. |
VPB_OK
if all went well. various | exceptions may be thrown in the event of error. |
int WINAPI vpb_playtone_state | ( | int | handle | ) |
Returns state of play tone (1= playing, 0 = not playing)
int WINAPI vpb_settone | ( | char | ident, |
const VPB_TONE * | tone | ||
) |
Enables user to (re)define the tone associated with a dial string character.
ident | The dial string character to use for this tone. |
tone | The VPB_TONE structure that defines this tone. |
Any occurrence of ident in a dial string sent via vpb_dial_sync()
or similar functions will subsequently use the tone defined here.
VPB_OK
if all went well. various | exceptions may be thrown in the event of error. |
vpb_open()
if you wish to redefine the default tones, else your settings for those will be overwritten. int WINAPI vpb_tone_terminate | ( | int | handle | ) |
Terminate a currently playing tone (user defined or dtmf).
handle | The handle of the port to stop tone playback for. |
VPB_OK
if all went well. various | exceptions may be thrown if things go badly. |