ClientSound Class Reference

A sound file. More...

#include <yatecbase.h>

Inheritance diagram for ClientSound:

String GenObject

List of all members.

Public Member Functions

 ClientSound (const char *name, const char *file, const char *device=0)
virtual ~ClientSound ()
virtual void destruct ()
bool started () const
const Stringfile () const
void file (const char *filename)
bool start (int repeat=-1, bool force=true)
void stop ()

Static Public Member Functions

static bool started (const String &name)
static bool start (const String &name, int repeat=-1, bool force=true)
static void stop (const String &name)
static ClientSoundfind (const String &token, bool byName=true)

Static Public Attributes

static ObjList s_sounds
static Mutex s_soundsMutex

Protected Member Functions

virtual bool doStart ()
virtual void doStop ()

Protected Attributes

String m_file
String m_device
int m_repeat
bool m_started


Detailed Description

A sound file.

This class holds a sound file along with an output device used to play it


Constructor & Destructor Documentation

ClientSound ( const char *  name,
const char *  file,
const char *  device = 0 
) [inline]

Constructor

Parameters:
name The name of this object
file The file to play (should contain the whole path and the file name)
device Optional device used to play the file. Set to 0 to use the default one

virtual ~ClientSound (  )  [inline, virtual]

Destructor. Stop playing the file


Member Function Documentation

virtual void destruct (  )  [inline, virtual]

Stop playing. Release memory

Reimplemented from GenObject.

References TelEngine::destruct().

void file ( const char *  filename  )  [inline]

Set the file played by this sound. The new file will not be used until the next time the sound is started

Parameters:
filename The new file played by this sound

const String& file (  )  const [inline]

Get the file played by this sound

Returns:
The file played by this sound

static ClientSound* find ( const String token,
bool  byName = true 
) [static]

Find a sound object

Parameters:
token The token used to match the sound
byName True to match the sound's name, false to match its file
Returns:
True on success

static bool start ( const String name,
int  repeat = -1,
bool  force = true 
) [static]

Start playing a given sound

Parameters:
name The name of the sound to play
repeat The number of times to play the file if positive, play until explicitely stopped otherwise
force True to start playing the file even if already started
Returns:
True on success

bool start ( int  repeat = -1,
bool  force = true 
)

Start playing the file

Parameters:
repeat The number of times to play the file if positive, play until explicitely stopped otherwise
force True to start playing the file even if already started
Returns:
True on success

static bool started ( const String name  )  [static]

Check if a sound is started

Parameters:
name The name of the sound to check
Returns:
True if the given sound is started

bool started (  )  const [inline]

Check if this sound is started

Returns:
True if this sound is started

static void stop ( const String name  )  [static]

Stop playing a given sound

Parameters:
name The name of the sound to stop

void stop (  ) 

Stop playing the file


Member Data Documentation

ObjList s_sounds [static]

The list of sounds

Mutex s_soundsMutex [static]

Mutex used to lock the sounds list operations


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

Generated on Sun Dec 7 21:45:26 2008 for Yate by  doxygen 1.5.7.1