Public Member Functions |
| PVXMLChannel (unsigned frameDelay, PINDEX frameSize) |
| ~PVXMLChannel () |
virtual PBoolean | Open (PVXMLSession *session) |
virtual PBoolean | IsOpen () const |
| Determine if the channel is currently open and read and write operations can be executed on it.
|
virtual PBoolean | Close () |
| Close the channel.
|
virtual PBoolean | Read (void *buffer, PINDEX amount) |
| Low level read from the file channel.
|
virtual PBoolean | Write (const void *buf, PINDEX len) |
| Low level write to the file channel.
|
virtual PWAVFile * | CreateWAVFile (const PFilePath &fn, PBoolean recording=false) |
const PString & | GetMediaFormat () const |
PBoolean | IsMediaPCM () const |
virtual PString | AdjustWavFilename (const PString &fn) |
virtual PBoolean | WriteFrame (const void *buf, PINDEX len)=0 |
virtual PBoolean | IsSilenceFrame (const void *buf, PINDEX len) const =0 |
virtual PBoolean | QueueRecordable (PVXMLRecordable *newItem) |
PBoolean | StartRecording (const PFilePath &fn, unsigned finalSilence=3000, unsigned maxDuration=30000) |
PBoolean | EndRecording () |
PBoolean | IsRecording () const |
virtual PBoolean | ReadFrame (void *buffer, PINDEX amount)=0 |
virtual PINDEX | CreateSilenceFrame (void *buffer, PINDEX amount)=0 |
virtual void | GetBeepData (PBYTEArray &, unsigned) |
virtual PBoolean | QueueResource (const PURL &url, PINDEX repeat=1, PINDEX delay=0) |
virtual PBoolean | QueuePlayable (const PString &type, const PString &str, PINDEX repeat=1, PINDEX delay=0, PBoolean autoDelete=false) |
virtual PBoolean | QueuePlayable (PVXMLPlayable *newItem) |
virtual PBoolean | QueueData (const PBYTEArray &data, PINDEX repeat=1, PINDEX delay=0) |
virtual PBoolean | QueueFile (const PString &fn, PINDEX repeat=1, PINDEX delay=0, PBoolean autoDelete=false) |
virtual PBoolean | QueueCommand (const PString &cmd, PINDEX repeat=1, PINDEX delay=0) |
virtual void | FlushQueue () |
virtual PBoolean | IsPlaying () const |
void | SetPause (PBoolean pause) |
unsigned | GetSampleFrequency () const |
void | SetSilence (unsigned msecs) |
| PDelayChannel (Mode mode, unsigned frameDelay, PINDEX frameSize=0, unsigned maximumSlip=250, unsigned minimumDelay=10) |
| Create a new delay channel with the specified delays.
|
| PDelayChannel (PChannel &channel, Mode mode, unsigned frameDelay, PINDEX frameSize=0, unsigned maximumSlip=250, unsigned minimumDelay=10) |
| Create a new delay channel with the specified delays and channel.
|
| PIndirectChannel () |
| Create a new indirect channel without any channels to redirect to.
|
| ~PIndirectChannel () |
| Close the indirect channel, deleting read/write channels if desired.
|
Comparison | Compare (const PObject &obj) const |
| Determine if the two objects refer to the same indirect channel.
|
virtual PString | GetName () const |
| Get the name of the channel.
|
virtual PBoolean | Shutdown (ShutdownValue option) |
| Close one or both of the data streams associated with a channel.
|
virtual bool | SetLocalEcho (bool localEcho) |
| Set local echo mode.
|
virtual PChannel * | GetBaseReadChannel () const |
| This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel .
|
virtual PChannel * | GetBaseWriteChannel () const |
| This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of PIndirectChannel .
|
virtual PString | GetErrorText (ErrorGroup group=NumErrorGroups) const |
| Get error message description.
|
PBoolean | Open (PChannel &channel) |
| Set the channel for both read and write operations.
|
PBoolean | Open (PChannel *channel, PBoolean autoDelete=true) |
| Set the channel for both read and write operations.
|
PBoolean | Open (PChannel *readChannel, PChannel *writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true) |
| Set the channel for both read and write operations.
|
PChannel * | GetReadChannel () const |
| Get the channel used for read operations.
|
bool | SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations.
|
PChannel * | GetWriteChannel () const |
| Get the channel used for write operations.
|
PBoolean | SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations.
|
PBoolean | SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError) |
| Set error values to those specified.
|
| PChannel () |
| Create the channel.
|
| ~PChannel () |
| Close down the channel.
|
virtual PINDEX | HashFunction () const |
| Calculate a hash value for use in sets and dictionaries.
|
int | GetHandle () const |
| Get the integer operating system handle for the channel.
|
void | SetReadTimeout (const PTimeInterval &time) |
| Set the timeout for read operations.
|
PTimeInterval | GetReadTimeout () const |
| Get the timeout for read operations.
|
virtual PINDEX | GetLastReadCount () const |
| Get the number of bytes read by the last Read() call.
|
virtual int | ReadChar () |
| Read a single 8 bit byte from the channel.
|
PBoolean | ReadBlock (void *buf, PINDEX len) |
| Read len bytes into the buffer from the channel.
|
PString | ReadString (PINDEX len) |
| Read len character into a string from the channel.
|
virtual PBoolean | ReadAsync (void *buf, PINDEX len) |
| Begin an asynchronous read from channel.
|
virtual void | OnReadComplete (void *buf, PINDEX len) |
| User callback function for when a ReadAsync() call has completed or timed out.
|
void | SetWriteTimeout (const PTimeInterval &time) |
| Set the timeout for write operations to complete.
|
PTimeInterval | GetWriteTimeout () const |
| Get the timeout for write operations to complete.
|
virtual PBoolean | Write (const void *buf, PINDEX len, const void *mark) |
| Low level write to the channel with marker.
|
virtual PINDEX | GetLastWriteCount () const |
| Get the number of bytes written by the last Write() call.
|
PBoolean | WriteChar (int c) |
| Write a single character to the channel.
|
PBoolean | WriteString (const PString &str) |
| Write a string to the channel.
|
virtual PBoolean | WriteAsync (const void *buf, PINDEX len) |
| Begin an asynchronous write from channel.
|
virtual void | OnWriteComplete (const void *buf, PINDEX len) |
| User callback function for when a WriteAsync() call has completed or timed out.
|
virtual bool | FlowControl (const void *flowData) |
| Flow Control information Pass data to the channel for flowControl determination.
|
PBoolean | SetBufferSize (PINDEX newSize) |
| Set the iostream buffer size for reads and writes.
|
PBoolean | SendCommandString (const PString &command) |
| Send a command meta-string.
|
void | AbortCommandString () |
| Abort a command string that is in progress.
|
Errors | GetErrorCode (ErrorGroup group=NumErrorGroups) const |
| Get normalised error code.
|
int | GetErrorNumber (ErrorGroup group=NumErrorGroups) const |
| Get OS errro code.
|
virtual PBoolean | Read (const VectorOfSlice &slices) |
| Low level scattered read from the channel.
|
virtual PBoolean | Write (const VectorOfSlice &slices) |
| Low level scattered write to the channel.
|
virtual | ~PObject () |
virtual PObject * | Clone () const |
| Create a copy of the class on the heap.
|
virtual const char * | GetClass (unsigned ancestor=0) const |
| Get the current dynamic type of the object instance.
|
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.
|
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects.
|
bool | operator== (const PObject &obj) const |
| Compare the two objects.
|
bool | operator!= (const PObject &obj) const |
| Compare the two objects.
|
bool | operator< (const PObject &obj) const |
| Compare the two objects.
|
bool | operator> (const PObject &obj) const |
| Compare the two objects.
|
bool | operator<= (const PObject &obj) const |
| Compare the two objects.
|
bool | operator>= (const PObject &obj) const |
| Compare the two objects.
|
virtual void | PrintOn (ostream &strm) const |
| Output the contents of the object to the stream.
|
virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream.
|