OpalMSRPMediaStream Class Reference

#include <msrp.h>

Inheritance diagram for OpalMSRPMediaStream:

Collaboration diagram for OpalMSRPMediaStream:

Public Member Functions
	OpalMSRPMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, OpalMSRPMediaSession &msrpSession)
	~OpalMSRPMediaStream ()
virtual PBoolean	IsSynchronous () const
virtual PBoolean	RequiresPatchThread () const
virtual PBoolean	ReadPacket (RTP_DataFrame &frame)
virtual PBoolean	WritePacket (RTP_DataFrame &frame)
virtual bool	Open ()
PURL	GetRemoteURL () const
void	SetRemoteURL (const PURL &url)
	PDECLARE_NOTIFIER2 (OpalMSRPManager, OpalMSRPMediaStream, OnReceiveMSRP, OpalMSRPManager::IncomingMSRP &)
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 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	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual bool	PushPacket (RTP_DataFrame &packet)
virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)
PINDEX	GetDataSize () const
virtual PBoolean	RequiresPatchThread (OpalMediaStream *stream) 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
OpalMSRPMediaSession &	m_msrpSession
PString	m_remoteParty
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

Constructor & Destructor Documentation

OpalMSRPMediaStream::OpalMSRPMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		OpalMSRPMediaSession &	msrpSession
	)

Parameters

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream

OpalMSRPMediaStream::~OpalMSRPMediaStream

(

)

Member Function Documentation

PURL OpalMSRPMediaStream::GetRemoteURL ( ) const

inline

References OpalMSRPMediaSession::GetRemoteURL(), and m_msrpSession.

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

inlinevirtual

Indicate if the media stream is synchronous. If this returns true then the media stream will block of the amount of time it takes to annunciate the data. For example if the media stream is over a sound card, and 480 bytes of data are to be written it will take 30 milliseconds to complete.

Implements OpalMediaStream.

virtual bool OpalMSRPMediaStream::Open ( )

virtual

Open the media stream using the media format.

The default behaviour simply sets the isOpen variable to true.

Reimplemented from OpalMediaStream.

OpalMSRPMediaStream::PDECLARE_NOTIFIER2	(	OpalMSRPManager	,
		OpalMSRPMediaStream	,
		OnReceiveMSRP	,
		OpalMSRPManager::IncomingMSRP &
	)

virtual PBoolean OpalMSRPMediaStream::ReadPacket ( RTP_DataFrame &  frame )

virtual

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

Reimplemented from OpalMediaStream.

virtual PBoolean OpalMSRPMediaStream::RequiresPatchThread ( ) const

inlinevirtual

Reimplemented from OpalMediaStream.

References OpalMediaStream::IsSink().

void OpalMSRPMediaStream::SetRemoteURL ( const PURL &  url )

inline

References m_msrpSession, and OpalMSRPMediaSession::SetRemoteURL().

virtual PBoolean OpalMSRPMediaStream::WritePacket ( RTP_DataFrame &  frame )

virtual

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

Reimplemented from OpalMediaStream.

Field Documentation

OpalMSRPMediaSession& OpalMSRPMediaStream::m_msrpSession

protected

Referenced by GetRemoteURL(), and SetRemoteURL().

PString OpalMSRPMediaStream::m_remoteParty

protected

---

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

• msrp.h