PTLib  Version 2.10.11
PVXMLPlayable Class Referenceabstract

#include <vxml.h>

Inheritance diagram for PVXMLPlayable:
PObject PVXMLPlayableCommand PVXMLPlayableData PVXMLPlayableFile PVXMLPlayableStop PVXMLPlayableURL PVXMLPlayableTone PVXMLPlayableFileList

Public Member Functions

 PVXMLPlayable ()
 
virtual PBoolean Open (PVXMLChannel &chan, const PString &arg, PINDEX delay, PINDEX repeat, PBoolean autoDelete)
 
virtual bool OnStart ()=0
 
virtual bool OnRepeat ()
 
virtual bool OnDelay ()
 
virtual void OnStop ()
 
virtual void SetRepeat (PINDEX v)
 
virtual PINDEX GetRepeat () const
 
virtual PINDEX GetDelay () const
 
void SetFormat (const PString &fmt)
 
void SetSampleFrequency (unsigned rate)
 
- Public Member Functions inherited from PObject
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Protected Attributes

PVXMLChannelm_vxmlChannel
 
PChannelm_subChannel
 
PINDEX m_repeat
 
PINDEX m_delay
 
PString m_format
 
unsigned m_sampleFrequency
 
bool m_autoDelete
 
bool m_delayDone
 

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 

Constructor & Destructor Documentation

§ PVXMLPlayable()

PVXMLPlayable::PVXMLPlayable ( )

Member Function Documentation

§ GetDelay()

virtual PINDEX PVXMLPlayable::GetDelay ( ) const
inlinevirtual

§ GetRepeat()

virtual PINDEX PVXMLPlayable::GetRepeat ( ) const
inlinevirtual

§ OnDelay()

virtual bool PVXMLPlayable::OnDelay ( )
virtual

§ OnRepeat()

virtual bool PVXMLPlayable::OnRepeat ( )
virtual

§ OnStart()

virtual bool PVXMLPlayable::OnStart ( )
pure virtual

§ OnStop()

virtual void PVXMLPlayable::OnStop ( )
virtual

§ Open()

virtual PBoolean PVXMLPlayable::Open ( PVXMLChannel chan,
const PString arg,
PINDEX  delay,
PINDEX  repeat,
PBoolean  autoDelete 
)
virtual

§ SetFormat()

void PVXMLPlayable::SetFormat ( const PString fmt)
inline

§ SetRepeat()

virtual void PVXMLPlayable::SetRepeat ( PINDEX  v)
inlinevirtual

§ SetSampleFrequency()

void PVXMLPlayable::SetSampleFrequency ( unsigned  rate)
inline

Member Data Documentation

§ m_autoDelete

bool PVXMLPlayable::m_autoDelete
protected

§ m_delay

PINDEX PVXMLPlayable::m_delay
protected

§ m_delayDone

bool PVXMLPlayable::m_delayDone
protected

§ m_format

PString PVXMLPlayable::m_format
protected

§ m_repeat

PINDEX PVXMLPlayable::m_repeat
protected

§ m_sampleFrequency

unsigned PVXMLPlayable::m_sampleFrequency
protected

§ m_subChannel

PChannel* PVXMLPlayable::m_subChannel
protected

§ m_vxmlChannel

PVXMLChannel* PVXMLPlayable::m_vxmlChannel
protected

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