AmAudioFrontlist Class Reference

AmAudio device with a playlist and a background AmAudio. More...

#include <AmAdvancedAudio.h>

Inheritance diagram for AmAudioFrontlist:

AmPlaylist AmAudio

Public Member Functions

 AmAudioFrontlist (AmEventQueue *q)
 AmAudioFrontlist (AmEventQueue *q, AmAudio *back_audio)
void setBackAudio (AmAudio *new_ba)

Protected Member Functions

int put (unsigned int user_ts, unsigned char *buffer, unsigned int size)
int get (unsigned int user_ts, unsigned char *buffer, unsigned int size)

Detailed Description

AmAudio device with a playlist and a background AmAudio.

AmAudioFrontlist is an AmAudio device, that has a playlist in front of a AmAudio entry, the 'back' device. The back device is only used if the playlist is empty. - This can be useful when for example announcements should be played to the participant while in a conference.

Member Function Documentation

int AmAudioFrontlist::put ( unsigned int  user_ts,
unsigned char *  buffer,
unsigned int  size 
) [protected, virtual]

Put some samples to the output stream.

Warning:
For packet based payloads / file formats, use: 
           nb_sample = input buffer size / sample size of the reference format
whereby the format with/from which the codec works is the reference one.
Returns:
# bytes written, else -1 if error (0 is OK)

Reimplemented from AmPlaylist.

int AmAudioFrontlist::get ( unsigned int  user_ts,
unsigned char *  buffer,
unsigned int  size 
) [protected, virtual]

Get some samples from input stream.

Warning:
For packet based payloads / file formats, use: 
           nb_sample = input buffer size / sample size of the reference format
whereby the format with/from which the codec works is the reference one.
Returns:
# bytes read, else -1 if error (0 is OK)

Reimplemented from AmPlaylist.

The documentation for this class was generated from the following files:
Generated on Fri May 16 12:02:06 2008 for SEMS by  doxygen 1.5.1
Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login