#include <iax2medstrm.h>

Inheritance diagram for OpalIAX2MediaStream:

Collaboration diagram for OpalIAX2MediaStream:

Public Member Functions
Overrides of OpalMediaStream class
virtual PBoolean	ReadPacket (RTP_DataFrame &packet)

virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)

virtual PBoolean	IsSynchronous () const

Public Member Functions inherited from OpalMediaStream
virtual PString	GetPatchThreadName () const

virtual bool	InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)

virtual bool	InternalSetPaused (bool pause, bool fromUser, bool fromPatch)

virtual bool	InternalExecuteCommand (const OpalMediaCommand &command)

void	PrintOn (ostream &strm) const

virtual OpalMediaFormat	GetMediaFormat () const

virtual bool	SetMediaFormat (const OpalMediaFormat &mediaFormat)

bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat, bool mergeOnly=false)

bool	ExecuteCommand (const OpalMediaCommand &command) const

virtual PBoolean	Open ()

virtual bool	IsOpen () const

virtual bool	IsEstablished () const

virtual PBoolean	Start ()

virtual PBoolean	Close ()

virtual void	OnStartMediaPatch ()

virtual void	OnStopMediaPatch (OpalMediaPatch &patch)

virtual bool	SetMediaPassThrough (OpalMediaStream &otherStream, bool bypass)

virtual PBoolean	WritePackets (RTP_DataFrameList &packets)

virtual PBoolean	WritePacket (RTP_DataFrame &packet)

virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)

virtual 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	RequireMediaTransportThread (OpalMediaStream &stream) const

virtual bool	EnableJitterBuffer (bool enab=true)

OpalConnection &	GetConnection () 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

bool	SetPaused (bool pause)

virtual PBoolean	SetPatch (OpalMediaPatch *patch)

OpalMediaPatchPtr	GetPatch () 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

	P_DECLARE_BITWISE_ENUM (Details, 6,(DetailMinimum, DetailEOL, DetailNAT, DetailSecured, DetailFEC, DetailAudio, DetailAddresses))

virtual void	PrintDetail (ostream &strm, const char *prefix=NULL, Details details=Details::All()) const

	~OpalMediaStream ()

Protected Member Functions
virtual void	InternalClose ()

Protected Member Functions inherited from OpalMediaStream
OpalMediaPatchPtr	InternalSetPatchPart1 (OpalMediaPatch *newPatch)

void	InternalSetPatchPart2 (const OpalMediaPatchPtr &oldPatch)

virtual bool	InternalSetJitterBuffer (const OpalJitterBuffer::Init &init)

	OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes
IAX2Connection &	connection

PBYTEArray	pendingData

Protected Attributes inherited from OpalMediaStream
OpalConnection &	m_connection

unsigned	m_sessionID

WORD	m_sequenceNumber

RTP_SyncSourceId	m_syncSourceId

PString	m_identifier

OpalMediaFormat	m_mediaFormat

atomic< bool >	m_paused

bool	m_isSource

atomic< bool >	m_isOpen

PINDEX	m_defaultDataSize

unsigned	m_timestamp

bool	m_marker

OpalMediaPatchPtr	m_mediaPatch

RTP_DataFrame::PayloadTypes	m_payloadType

unsigned	m_frameTime

PINDEX	m_frameSize

Additional Inherited Members
Protected Types inherited from OpalMediaStream
typedef OpalMediaPatchPtr	PatchPtr

Detailed Description

This class describes a media stream, which is an interface to the opal classes for generating encoded media data

Member Function Documentation

virtual void OpalIAX2MediaStream::InternalClose ( )

inlineprotectedvirtual

Close any internal components of the stream. This should be used in preference to overriding the Close() function as it is guaranteed to be called exactly once and avoids race conditions in the shut down sequence of a media stream.

Implements OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::IsSynchronous ( ) const

virtual

Indicate if the media stream is synchronous. false if this stream is from the network.

Returns: true if this stream is from a sound card.

Implements OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::ReadPacket ( RTP_DataFrame & packet )

virtual

Goes to the IAX2Connection class, and removes a packet from the connection. The connection class turned the media packet into a RTP_DataFrame class, and jitter buffered it.

Returns: true on successful read of a packet, false on faulty read.

Parameters

packet Data buffer to read to

Reimplemented from OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::WriteData	(	const BYTE *	data,
		PINDEX	length,
		PINDEX &	written
	)

virtual

Write raw media data to the sink media stream. The default behaviour writes to the OpalLine object.

Parameters

data	Data to write
length	Length of data to write.
written	Length of data actually written

Reimplemented from OpalMediaStream.

Field Documentation

IAX2Connection& OpalIAX2MediaStream::connection

protected

The connection is the source/sink of our data packets

PBYTEArray OpalIAX2MediaStream::pendingData

protected

There was unused data from an incoming ethernet frame. The unused data is stored here.

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

iax2medstrm.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation