OpalNullMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalNullMediaStream:

Collaboration diagram for OpalNullMediaStream:

Public Member Functions
Construction
	OpalNullMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, bool isSynchronous=false)
	OpalNullMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, bool usePacingDelay, bool requiresPatchThread)
Overrides of OpalMediaStream class
virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual bool	SetPaused (bool pause, bool fromPatch=false)
virtual PBoolean	RequiresPatchThread () const
virtual PBoolean	IsSynchronous () const
Public Member Functions inherited from OpalMediaStream
void	PrintOn (ostream &strm) const
virtual OpalMediaFormat	GetMediaFormat () const
virtual bool	SetMediaFormat (const OpalMediaFormat &mediaFormat)
bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat, bool mergeOnly=false)
virtual PBoolean	ExecuteCommand (const OpalMediaCommand &command)
virtual PBoolean	Open ()
virtual bool	IsOpen () const
virtual PBoolean	Start ()
virtual PBoolean	Close ()
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 bool	EnableJitterBuffer (bool enab=true) const
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
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
	~OpalMediaStream ()
Public Member Functions inherited from OpalMediaStreamPacing
	OpalMediaStreamPacing (const OpalMediaFormat &mediaFormat)
void	Pace (bool reading, PINDEX bytes, bool &marker)
	Delay appropriate time for the written bytes. More...
bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat)

Protected Member Functions
virtual void	InternalClose ()
virtual bool	InternalUpdateMediaFormat (const OpalMediaFormat &newMediaFormat)
Protected Member Functions inherited from OpalMediaStream
void	IncrementTimestamp (PINDEX size)
bool	InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
OpalMediaPatchPtr	InternalSetPatchPart1 (OpalMediaPatch *newPatch)
void	InternalSetPatchPart2 (const OpalMediaPatchPtr &oldPatch)
virtual bool	InternalSetJitterBuffer (const OpalJitterBuffer::Init &init) const
	OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes
bool	m_isSynchronous
bool	m_requiresPatchThread
Protected Attributes inherited from OpalMediaStream
OpalConnection &	connection
unsigned	sessionID
WORD	m_sequenceNumber
PString	identifier
OpalMediaFormat	mediaFormat
bool	m_paused
bool	m_isSource
bool	m_isOpen
PINDEX	m_defaultDataSize
unsigned	timestamp
bool	marker
OpalMediaPatchPtr	m_mediaPatch
RTP_DataFrame::PayloadTypes	m_payloadType
unsigned	m_frameTime
PINDEX	m_frameSize
Protected Attributes inherited from OpalMediaStreamPacing
bool	m_timeOnMarkers
unsigned	m_frameTime
PINDEX	m_frameSize
unsigned	m_timeUnits
PAdaptiveDelay	m_delay

Additional Inherited Members
Protected Types inherited from OpalMediaStream
typedef OpalMediaPatchPtr	PatchPtr

Detailed Description

This class describes a media stream that is used for media bypass.

Constructor & Destructor Documentation

OpalNullMediaStream::OpalNullMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		bool	isSynchronous = false
	)

Construct a new media stream for RTP sessions.

Parameters

conn	Connection that owns the stream
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
isSynchronous	Can accept data and block accordingly

OpalNullMediaStream::OpalNullMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		bool	usePacingDelay,
		bool	requiresPatchThread
	)

Parameters

conn	Connection that owns the stream
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
usePacingDelay	Use delay to pace stream I/O
requiresPatchThread	Requires a patch thread to execute

Member Function Documentation

virtual void OpalNullMediaStream::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 bool OpalNullMediaStream::InternalUpdateMediaFormat ( const OpalMediaFormat &  newMediaFormat )

protectedvirtual

Reimplemented from OpalMediaStream.

virtual PBoolean OpalNullMediaStream::IsSynchronous ( ) const

virtual

Indicate if the media stream is synchronous. Returns m_isSynchronous.

Implements OpalMediaStream.

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

virtual

Read raw media data from the source media stream. The default behaviour does nothing and returns false.

Parameters

data	Data buffer to read to
size	Size of buffer
length	Length of data actually read

Reimplemented from OpalMediaStream.

virtual PBoolean OpalNullMediaStream::RequiresPatchThread ( ) const

virtual

Indicate if the media stream requires a OpalMediaPatch thread (active patch). The default behaviour returns the value of m_isSynchronous.

Reimplemented from OpalMediaStream.

virtual bool OpalNullMediaStream::SetPaused ( bool  pause, bool  fromPatch = false  )

virtual

Set the paused state for stream. This will stop reading/writing data from the stream. Returns true if the pause state was changed

Parameters

pause	Indicate that the stream should be paused
fromPatch	Is being called from OpalMediaPatch

Reimplemented from OpalMediaStream.

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

virtual

Write raw media data to the sink media stream. The default behaviour does nothing and returns false.

Parameters

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

Reimplemented from OpalMediaStream.

Field Documentation

bool OpalNullMediaStream::m_isSynchronous

protected

bool OpalNullMediaStream::m_requiresPatchThread

protected

---

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

• mediastrm.h