OPAL Version 3.10.2
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

Protected Attributes

OpalConnectionconn
PVXMLSession & vxmlSession

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::vxmlSession [protected]

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