OpalMediaCommand Class Reference

#include <mediacmd.h>

Inheritance diagram for OpalMediaCommand:

Collaboration diagram for OpalMediaCommand:

Public Member Functions
	OpalMediaCommand (const OpalMediaType &mediaType, unsigned sessionID=0, unsigned ssrc=0)
Overrides from PObject
virtual void	PrintOn (ostream &strm) const
virtual Comparison	Compare (const PObject &obj) const
virtual PObject *	Clone () const =0
Operations
virtual PString	GetName () const =0
virtual void *	GetPlugInData () const
virtual unsigned *	GetPlugInSize () const
Memebers
const OpalMediaType &	GetMediaType () const
unsigned	GetSessionID () const
unsigned	GetSyncSource () const

Protected Attributes
OpalMediaType	m_mediaType
unsigned	m_sessionID
unsigned	m_ssrc

Detailed Description

This is the base class for a command to a media transcoder and/or media stream. The commands are highly context sensitive, for example OpalVideoUpdatePicture would only apply to a video transcoder.

Constructor & Destructor Documentation

OpalMediaCommand::OpalMediaCommand	(	const OpalMediaType &	mediaType,
		unsigned	sessionID = 0,
		unsigned	ssrc = 0
	)

Parameters

mediaType	Media type to search for in open streams
sessionID	Session for media stream, 0 is use first mediaType stream
ssrc	Sync Source for media stream (if RTP)

Member Function Documentation

virtual PObject* OpalMediaCommand::Clone ( ) const

pure virtual

virtual Comparison OpalMediaCommand::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank. This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Parameters

obj	Object to compare against.

const OpalMediaType& OpalMediaCommand::GetMediaType ( ) const

inline

References m_mediaType.

virtual PString OpalMediaCommand::GetName ( ) const

pure virtual

Get the name of the command.

Implemented in OpalTemporalSpatialTradeOff, OpalVideoPictureLoss, OpalVideoUpdatePicture, OpalMediaMaxPayload, OpalMediaPacketLoss, and OpalMediaFlowControl.

virtual void* OpalMediaCommand::GetPlugInData ( ) const

virtual

Get data buffer pointer for transfer to/from codec plug-in.

virtual unsigned* OpalMediaCommand::GetPlugInSize ( ) const

virtual

Get data buffer size for transfer to/from codec plug-in.

unsigned OpalMediaCommand::GetSessionID ( ) const

inline

References m_sessionID.

unsigned OpalMediaCommand::GetSyncSource ( ) const

inline

References m_ssrc.

virtual void OpalMediaCommand::PrintOn ( ostream &  strm ) const

virtual

Standard stream print function. The PObject class has a << operator defined that calls this function polymorphically.

Parameters

strm	Stream to output text representation

Field Documentation

OpalMediaType OpalMediaCommand::m_mediaType

protected

Referenced by GetMediaType().

unsigned OpalMediaCommand::m_sessionID

protected

Referenced by GetSessionID().

unsigned OpalMediaCommand::m_ssrc

protected

Referenced by GetSyncSource().

---

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

• mediacmd.h