OpalFaxMediaStream Class Reference

#include <t38proto.h>

Inheritance diagram for OpalFaxMediaStream:
OpalMediaStream OpalT38MediaStream

List of all members.

Public Member Functions

virtual PString GetSpanDSPCommandLine (OpalFaxCallInfo &)
Construction

 OpalFaxMediaStream (OpalFaxConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, const PString &token, const PString &filename, bool receive, const PString &stationId)
Overrides of OpalMediaStream class

virtual PBoolean Open ()
virtual PBoolean Close ()
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
virtual PBoolean WritePacket (RTP_DataFrame &packet)
virtual PBoolean IsSynchronous () const
virtual void GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const

Protected Member Functions

 PDECLARE_NOTIFIER (PThread, OpalFaxMediaStream, ReadStdOut)

Protected Attributes

OpalFaxConnectionm_connection
PMutex infoMutex
PString sessionToken
OpalFaxCallInfom_faxCallInfo
PFilePath m_filename
bool m_receive
BYTE writeBuffer [320]
PINDEX writeBufferLen
PString m_stationId
OpalMediaStatistics::Fax m_statistics

Detailed Description

This class describes a media stream that transfers data to/from a fax session


Constructor & Destructor Documentation

OpalFaxMediaStream::OpalFaxMediaStream ( OpalFaxConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
const PString &  token,
const PString &  filename,
bool  receive,
const PString &  stationId 
)

Construct a new media stream for T.38 sessions.

Parameters:
mediaFormat Media format for stream
isSource Is a source stream
token token used to match incoming/outgoing streams

Member Function Documentation

virtual PBoolean OpalFaxMediaStream::Close (  )  [virtual]

Close the media stream.

The default does nothing.

Reimplemented from OpalMediaStream.

virtual PString OpalFaxMediaStream::GetSpanDSPCommandLine ( OpalFaxCallInfo  )  [virtual]

Reimplemented in OpalT38MediaStream.

virtual void OpalFaxMediaStream::GetStatistics ( OpalMediaStatistics statistics,
bool  fromPatch = false 
) const [virtual]

Reimplemented from OpalMediaStream.

virtual PBoolean OpalFaxMediaStream::IsSynchronous (  )  const [virtual]

Indicate if the media stream is synchronous. Returns PFalse for RTP streams.

Implements OpalMediaStream.

virtual PBoolean OpalFaxMediaStream::Open (  )  [virtual]

Open the media stream using the media format.

The default behaviour simply sets the isOpen variable to PTrue.

Reimplemented from OpalMediaStream.

OpalFaxMediaStream::PDECLARE_NOTIFIER ( PThread  ,
OpalFaxMediaStream  ,
ReadStdOut   
) [protected]
virtual PBoolean OpalFaxMediaStream::ReadPacket ( RTP_DataFrame packet  )  [virtual]

Read an RTP frame of data from the source media stream. The new behaviour simply calls RTP_Session::ReadData().

Reimplemented from OpalMediaStream.

Reimplemented in OpalT38MediaStream.

virtual PBoolean OpalFaxMediaStream::WritePacket ( RTP_DataFrame packet  )  [virtual]

Write an RTP frame of data to the sink media stream. The new behaviour simply calls RTP_Session::WriteData().

Reimplemented from OpalMediaStream.

Reimplemented in OpalT38MediaStream.


Member Data Documentation

PMutex OpalFaxMediaStream::infoMutex [protected]
PFilePath OpalFaxMediaStream::m_filename [protected]
PString OpalFaxMediaStream::m_stationId [protected]
PString OpalFaxMediaStream::sessionToken [protected]
BYTE OpalFaxMediaStream::writeBuffer[320] [protected]

The documentation for this class was generated from the following file:
Generated on Tue Jun 15 00:29:14 2010 for OPAL by  doxygen 1.6.3