ost::BayonneAudio Class Reference

Offers core Bayonne audio processing in a self contained class. More...

#include <bayonne.h>

Inheritance diagram for ost::BayonneAudio:

List of all members.

Public Member Functions
	BayonneAudio ()
	Initialize instance of audio.
const char *	getFilename (const char *name, bool write=false)
	Convert a prompt identifier into a complete audio file pathname.
void	cleanup (void)
	Clear open files and other data structures from previous audio processing operations.
void	play (const char **list, Mode mode=modeRead)
	Open a sequence of audio prompts for playback.
void	record (const char *name, Mode mode=modeCreate, const char *annotation=NULL)
	Open an audio prompt for recording.
const char *	getVoicelib (const char *iso)
	Check if a voice library is available.
AudioCodec *	getCodec (void)
	Get audio codec used.
Public Attributes
AudioTone *	tone
	Current tone object to use for generation of audio tones, dtmf dialing sequences, etc.
BayonneTranslator *	translator
	Current language translator in effect for the current set of autio prompts.
char	vlib [60]
	Alternate voicelib construct.
const char *	extension
const char *	voicelib
const char *	libext
const char *	prefixdir
const char *	offset
Encoding	encoding
timeout_t	framing
char	var_position [14]
Protected Member Functions
char *	getContinuation (void)
Protected Attributes
char	filename [256]
const char **	list

---

Detailed Description

Offers core Bayonne audio processing in a self contained class.

The BayonneAudio class is used with each session object.

self contained Bayonne audio processing.

Author:

David Sugar <dyfet@gnutelephony.org>

---

Constructor & Destructor Documentation

ost::BayonneAudio::BayonneAudio

(

)

Initialize instance of audio.

---

Member Function Documentation

char* ost::BayonneAudio::getContinuation

(

void

)

[protected]

const char* ost::BayonneAudio::getFilename	(	const char *	name,
		bool	write = false
	)

Convert a prompt identifier into a complete audio file pathname.

Returns:

pointer to fully qualified file path or NULL if invalid.

Parameters:

	name	of prompt requested.
	write	path required if true.

void ost::BayonneAudio::cleanup

(

void

)

Clear open files and other data structures from previous audio processing operations.

void ost::BayonneAudio::play	(	const char **	list,
		Mode	mode = modeRead
	)

Open a sequence of audio prompts for playback.

Parameters:

	list	of prompts to open.
	mode	for playback file processing of list.

void ost::BayonneAudio::record	(	const char *	name,
		Mode	mode = modeCreate,
		const char *	annotation = NULL
	)

Open an audio prompt for recording.

Parameters:

	name	of prompt to open.
	mode	whether to create or use pre-existing recording.
	annotation	to save in file if supported by format used.

const char* ost::BayonneAudio::getVoicelib

(

const char *

iso

)

Check if a voice library is available.

Returns:

voice library id or NULL if invalid.

Parameters:

iso

name of library to request.

AudioCodec* ost::BayonneAudio::getCodec

(

void

)

[inline]

Get audio codec used.

Returns:

audio codec.

---

Member Data Documentation

char ost::BayonneAudio::filename[256] [protected]

const char** ost::BayonneAudio::list [protected]

AudioTone* ost::BayonneAudio::tone

Current tone object to use for generation of audio tones, dtmf dialing sequences, etc.

BayonneTranslator* ost::BayonneAudio::translator

Current language translator in effect for the current set of autio prompts.

char ost::BayonneAudio::vlib[60]

Alternate voicelib construct.

const char* ost::BayonneAudio::extension

const char * ost::BayonneAudio::voicelib

const char * ost::BayonneAudio::libext

const char * ost::BayonneAudio::prefixdir

const char * ost::BayonneAudio::offset

Encoding ost::BayonneAudio::encoding

timeout_t ost::BayonneAudio::framing

char ost::BayonneAudio::var_position[14]

---

The documentation for this class was generated from the following file:

• bayonne.h