OpalFaxMediaStream Class Reference

#include <t38proto.h>

Inheritance diagram for OpalFaxMediaStream:

List of all members.

Public Member Functions
Overrides of OpalMediaStream class
virtual BOOL	Open ()
virtual BOOL	Close ()
virtual BOOL	Start ()
virtual BOOL	ReadPacket (RTP_DataFrame &packet)
virtual BOOL	WritePacket (RTP_DataFrame &packet)
virtual BOOL	IsSynchronous () const
virtual PString	GetSpanDSPCommandLine (OpalFaxCallInfo &)
Protected Attributes
PMutex	infoMutex
PString	sessionToken
OpalFaxCallInfo *	faxCallInfo
PFilePath	filename
BOOL	receive
BYTE	writeBuffer [320]
PINDEX	writeBufferLen

---

Detailed Description

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

---

Constructor & Destructor Documentation

OpalFaxMediaStream::OpalFaxMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		BOOL	isSource,
		const PString &	token,
		const PString &	filename,
		BOOL	receive
	)

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

OpalFaxMediaStream::OpalFaxMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		BOOL	isSource,
		const PString &	token,
		const PString &	filename,
		BOOL	receive
	)

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 BOOL OpalFaxMediaStream::Open

(

)

[virtual]

Open the media stream using the media format.

The default behaviour simply sets the isOpen variable to TRUE.

Reimplemented from OpalMediaStream.

virtual BOOL OpalFaxMediaStream::Close

(

)

[virtual]

Close the media stream.

The default does nothing.

Reimplemented from OpalMediaStream.

virtual BOOL OpalFaxMediaStream::Start

(

)

[virtual]

Start the media stream.

The default behaviour calls Resume() on the associated OpalMediaPatch thread if it was suspended.

Reimplemented from OpalMediaStream.

virtual BOOL 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 BOOL 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.

virtual BOOL OpalFaxMediaStream::IsSynchronous

(

)

const [virtual]

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

Implements OpalMediaStream.

virtual PString OpalFaxMediaStream::GetSpanDSPCommandLine

(

OpalFaxCallInfo &

)

[virtual]

Reimplemented in OpalT38MediaStream.

---

Member Data Documentation

PMutex OpalFaxMediaStream::infoMutex [protected]

PString OpalFaxMediaStream::sessionToken [protected]

OpalFaxCallInfo* OpalFaxMediaStream::faxCallInfo [protected]

PFilePath OpalFaxMediaStream::filename [protected]

BOOL OpalFaxMediaStream::receive [protected]

BYTE OpalFaxMediaStream::writeBuffer[320] [protected]

PINDEX OpalFaxMediaStream::writeBufferLen [protected]

---

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

• t38proto.h

---