OpalLocalMediaStream Class Reference

#include <localep.h>

Inheritance diagram for OpalLocalMediaStream:

Collaboration diagram for OpalLocalMediaStream:

Public Member Functions
Construction
	OpalLocalMediaStream (OpalLocalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, OpalLocalEndPoint::Synchronicity synchronicity)
Overrides of OpalMediaStream class
virtual PBoolean	ReadPacket (RTP_DataFrame &packet)
virtual PBoolean	WritePacket (RTP_DataFrame &packet)
virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean	IsSynchronous () const
Public Member Functions inherited from OpalMediaStream
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 PBoolean	Start ()
virtual PBoolean	Close ()
virtual void	OnStartMediaPatch ()
virtual void	OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean	WritePackets (RTP_DataFrameList &packets)
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	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
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 ()
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 ()
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
OpalLocalConnection &	m_connection
OpalLocalEndPoint::Synchronicity	m_synchronicity
PBYTEArray	m_silence
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

Local media stream. This class represents a media stream on the local machine that can receive media via virtual functions.

Constructor & Destructor Documentation

OpalLocalMediaStream::OpalLocalMediaStream	(	OpalLocalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		OpalLocalEndPoint::Synchronicity	synchronicity
	)

Construct a new media stream for local system.

Parameters

conn	Connection for media stream
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
synchronicity	Synchronous mode

Member Function Documentation

virtual void OpalLocalMediaStream::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 OpalLocalMediaStream::IsSynchronous ( ) const

virtual

Indicate if the media stream is synchronous. Returns true for LID streams.

Implements OpalMediaStream.

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

virtual

Read raw media data from the source media stream. The default behaviour reads from the OpalLine object.

Parameters

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

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::ReadPacket ( RTP_DataFrame &  packet )

virtual

Read an RTP frame of data from the source media stream. The default behaviour simply calls ReadData() on the data portion of the RTP_DataFrame and sets the frames timestamp and marker from the internal member variables of the media stream class.

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::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 read.
written	Length of data actually written

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::WritePacket ( RTP_DataFrame &  packet )

virtual

Write an RTP frame of data to the sink media stream. The default behaviour simply calls WriteData() on the data portion of the RTP_DataFrame and and sets the internal timestamp and marker from the member variables of the media stream class.

Reimplemented from OpalMediaStream.

Field Documentation

OpalLocalConnection& OpalLocalMediaStream::m_connection

protected

PBYTEArray OpalLocalMediaStream::m_silence

protected

OpalLocalEndPoint::Synchronicity OpalLocalMediaStream::m_synchronicity

protected

---

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

• localep.h