OpalMixerMediaStream Class Reference

#include <opalmixer.h>

Inheritance diagram for OpalMixerMediaStream:

Public Member Functions
Construction
	OpalMixerMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PSafePtr< OpalMixerNode > node, bool listenOnly)
	~OpalMixerMediaStream ()
Overrides of OpalMediaStream class
virtual PBoolean	Open ()
virtual PBoolean	WritePacket (RTP_DataFrame &packet)
virtual PBoolean	IsSynchronous () const
virtual PBoolean	RequiresPatchThread () const
virtual bool	EnableJitterBuffer (bool enab=true) const
Member variable access
PSafePtr< OpalMixerNode >	GetNode ()
Public Member Functions inherited from OpalMediaStream
void	PrintOn (ostream &strm) const
virtual OpalMediaFormat	GetMediaFormat () const
bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual bool	InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean	ExecuteCommand (const OpalMediaCommand &command)
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	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
bool	PushPacket (RTP_DataFrame &packet)
virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)
PINDEX	GetDataSize () const
virtual PBoolean	RequiresPatchThread (OpalMediaStream *stream) 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 bool	SetPaused (bool pause, bool fromPatch=false)
bool	IsOpen () const
virtual PBoolean	SetPatch (OpalMediaPatch *patch)
OpalMediaPatch *	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 ()

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)
	OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes
PSafePtr< OpalMixerNode >	m_node
bool	m_listenOnly
bool	m_video
Protected Attributes inherited from OpalMediaStream
OpalConnection &	connection
unsigned	sessionID
PString	identifier
OpalMediaFormat	mediaFormat
bool	m_paused
bool	isSource
bool	isOpen
PINDEX	defaultDataSize
unsigned	timestamp
bool	marker
unsigned	mismatchedPayloadTypes
PatchPtr	m_mediaPatch
RTP_DataFrame::PayloadTypes	m_payloadType
unsigned	m_frameTime
PINDEX	m_frameSize

Additional Inherited Members
Protected Types inherited from OpalMediaStream
typedef PSafePtr< OpalMediaPatch, PSafePtrMultiThreaded >	PatchPtr

Detailed Description

Mixer media stream. This class represents a media stream that will send/get media from a mixer.

Constructor & Destructor Documentation

OpalMixerMediaStream()

OpalMixerMediaStream::OpalMixerMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		PSafePtr< OpalMixerNode >	node,
		bool	listenOnly
	)

Construct a new media stream for mixer.

Parameters

conn	Connection for media stream
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
node	Mixer node to send data
listenOnly	Effectively initial pause state

~OpalMixerMediaStream()

OpalMixerMediaStream::~OpalMixerMediaStream

(

)

Destroy stream.

Member Function Documentation

EnableJitterBuffer()

virtual bool OpalMixerMediaStream::EnableJitterBuffer ( bool  enab = true ) const

virtual

Enable jitter buffer for the media stream. Returns true if a jitter buffer is enabled/disabled. Returns false if no jitter buffer exists for the media stream.

The default behaviour sets the mixer jitter buffer size according to the connection parameters, then returns true.

Reimplemented from OpalMediaStream.

GetNode()

PSafePtr<OpalMixerNode> OpalMixerMediaStream::GetNode ( )

inline

Get the mixer node for this stream.

InternalClose()

virtual void OpalMixerMediaStream::InternalClose ( )

protectedvirtual

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.

IsSynchronous()

virtual PBoolean OpalMixerMediaStream::IsSynchronous ( ) const

virtual

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

Implements OpalMediaStream.

Open()

virtual PBoolean OpalMixerMediaStream::Open ( )

virtual

Open the media stream using the media format.

Reimplemented from OpalMediaStream.

RequiresPatchThread()

virtual PBoolean OpalMixerMediaStream::RequiresPatchThread ( ) const

virtual

Indicate if the media stream requires a OpalMediaPatch thread (active patch). This is called on the source/sink stream and is passed the sink/source stream that the patch will initially be using. The function could conditionally require the patch thread to execute a thread reading and writing data, or prevent it from doing so as it can do so in hardware in some way.

The default behaviour returns true if a sink stream. If source stream then threading is from the mixer class.

Reimplemented from OpalMediaStream.

WritePacket()

virtual PBoolean OpalMixerMediaStream::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

m_listenOnly

bool OpalMixerMediaStream::m_listenOnly

protected

m_node

PSafePtr<OpalMixerNode> OpalMixerMediaStream::m_node

protected

m_video

bool OpalMixerMediaStream::m_video

protected

---

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

• opalmixer.h