OPAL  Version 3.10.4
OpalIVRMediaStream Class Reference

#include <ivr.h>

Inheritance diagram for OpalIVRMediaStream:
OpalRawMediaStream OpalMediaStream

Public Member Functions

Construction
 OpalIVRMediaStream (OpalIVRConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource, PVXMLSession &vxml)
Overrides of OpalMediaStream class
virtual PBoolean Open ()
virtual PBoolean Close ()
virtual PBoolean IsSynchronous () const
- Public Member Functions inherited from OpalRawMediaStream
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
PChannel * GetChannel ()
bool SetChannel (PChannel *channel, bool autoDelete=true)
virtual unsigned GetAverageSignalLevel ()
- Public Member Functions inherited from OpalMediaStream
void PrintOn (ostream &strm) const
virtual OpalMediaFormat GetMediaFormat () const
bool UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual bool InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean ExecuteCommand (const OpalMediaCommand &command)
virtual PBoolean Start ()
virtual void OnStartMediaPatch ()
virtual void OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean WritePackets (RTP_DataFrameList &packets)
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
virtual PBoolean WritePacket (RTP_DataFrame &packet)
bool PushPacket (RTP_DataFrame &packet)
virtual PBoolean SetDataSize (PINDEX dataSize, PINDEX frameTime)
PINDEX GetDataSize () const
virtual PBoolean RequiresPatchThread (OpalMediaStream *stream) const
virtual PBoolean RequiresPatchThread () const
virtual bool EnableJitterBuffer (bool enab=true) const
OpalConnectionGetConnection () const
bool IsSource () const
bool IsSink () const
unsigned GetSessionID () const
void SetSessionID (unsigned id)
PString GetID () const
unsigned GetTimestamp () const
void SetTimestamp (unsigned ts)
bool GetMarker () const
void SetMarker (bool m)
bool IsPaused () const
virtual bool SetPaused (bool pause, bool fromPatch=false)
bool IsOpen () const
virtual PBoolean SetPatch (OpalMediaPatch *patch)
OpalMediaPatchGetPatch () const
void AddFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
bool RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
virtual void GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const
 ~OpalMediaStream ()

Protected Attributes

PVXMLSession & m_vxmlSession
- Protected Attributes inherited from OpalRawMediaStream
PChannel * m_channel
bool m_autoDelete
PMutex m_channelMutex
PBYTEArray m_silence
PUInt64 m_averageSignalSum
unsigned m_averageSignalSamples
PMutex m_averagingMutex
- Protected Attributes inherited from OpalMediaStream
OpalConnectionconnection
unsigned sessionID
PString identifier
OpalMediaFormat mediaFormat
bool m_paused
bool isSource
bool isOpen
PINDEX defaultDataSize
unsigned timestamp
bool marker
unsigned mismatchedPayloadTypes
OpalMediaPatchmediaPatch
RTP_DataFrame::PayloadTypes m_payloadType
unsigned m_frameTime
PINDEX m_frameSize

Additional Inherited Members

- Protected Member Functions inherited from OpalRawMediaStream
void CollectAverage (const BYTE *buffer, PINDEX size)
 OpalRawMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PChannel *channel, bool autoDelete)
 ~OpalRawMediaStream ()
- Protected Member Functions inherited from OpalMediaStream
void IncrementTimestamp (PINDEX size)
bool InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
 OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Detailed Description

This class describes a media stream that transfers data to/from an IVR vxml session.


Constructor & Destructor Documentation

OpalIVRMediaStream::OpalIVRMediaStream ( OpalIVRConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
PBoolean  isSource,
PVXMLSession &  vxml 
)

Construct a new media stream for IVR session.

Parameters:
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
vxmlvxml session to use

Member Function Documentation

virtual PBoolean OpalIVRMediaStream::Close ( )
virtual

Close the media stream.

   Closes the associated PChannel.

Reimplemented from OpalRawMediaStream.

virtual PBoolean OpalIVRMediaStream::IsSynchronous ( ) const
virtual

Indicate if the media stream is synchronous. Returns false for IVR streams.

Implements OpalMediaStream.

virtual PBoolean OpalIVRMediaStream::Open ( )
virtual

Open the media stream using the media format.

   The default behaviour simply sets the member variable "mediaFormat"
   and "defaultDataSize".

Reimplemented from OpalMediaStream.


Field Documentation

PVXMLSession& OpalIVRMediaStream::m_vxmlSession
protected

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