OpalMediaTypeDefinition Class Reference

#include <mediatype.h>

Inheritance diagram for OpalMediaTypeDefinition:

Collaboration diagram for OpalMediaTypeDefinition:

Public Member Functions
	OpalMediaTypeDefinition (const char *mediaType, const char *mediaSession, unsigned requiredSessionId=0, OpalMediaType::AutoStartMode autoStart=OpalMediaType::DontOffer)
	Create a new media type definition. More...
virtual	~OpalMediaTypeDefinition ()
OpalMediaType::AutoStartMode	GetAutoStart () const
void	SetAutoStart (OpalMediaType::AutoStartMode v)
void	SetAutoStart (OpalMediaType::AutoStartMode v, bool on)
unsigned	GetDefaultSessionId () const
const PString &	GetMediaSessionType () const
virtual bool	MatchesSDP (const PCaselessString &sdpMediaType, const PCaselessString &sdpTransport, const PStringArray &sdpLines, PINDEX index)
	Determine of this media type is valid for SDP m= section. More...
virtual SDPMediaDescription *	CreateSDPMediaDescription (const OpalTransportAddress &localAddress) const
	create an SDP media description entry for this media type More...

Protected Attributes
OpalMediaType	m_mediaType
PString	m_mediaSessionType
unsigned	m_defaultSessionId
OpalMediaType::AutoStartMode	m_autoStart

Detailed Description

This class defines the type used to define the attributes of a media type

Constructor & Destructor Documentation

OpalMediaTypeDefinition::OpalMediaTypeDefinition	(	const char *	mediaType,
		const char *	mediaSession,
		unsigned	requiredSessionId = 0,
		OpalMediaType::AutoStartMode	autoStart = OpalMediaType::DontOffer
	)

Create a new media type definition.

Parameters

mediaType	name of the media type (audio, video etc)
mediaSession	name of media session class (via factory)
requiredSessionId	Session ID to use, asserts if already in use
autoStart	Default value for auto-start transmit & receive

virtual OpalMediaTypeDefinition::~OpalMediaTypeDefinition ( )

virtual

Member Function Documentation

virtual SDPMediaDescription* OpalMediaTypeDefinition::CreateSDPMediaDescription ( const OpalTransportAddress &  localAddress ) const

virtual

create an SDP media description entry for this media type

Reimplemented in OpalVideoMediaType, OpalAudioMediaType, and OpalH224MediaType.

OpalMediaType::AutoStartMode OpalMediaTypeDefinition::GetAutoStart ( ) const

inline

Get flags for media type can auto-start on call initiation.

References m_autoStart.

Referenced by OpalMediaType::GetAutoStart().

unsigned OpalMediaTypeDefinition::GetDefaultSessionId ( ) const

inline

Return the default session ID for this media type.

References m_defaultSessionId.

const PString& OpalMediaTypeDefinition::GetMediaSessionType ( ) const

inline

Return the default session type (factory name) for this media type.

References m_mediaSessionType.

virtual bool OpalMediaTypeDefinition::MatchesSDP ( const PCaselessString &  sdpMediaType, const PCaselessString &  sdpTransport, const PStringArray &  sdpLines, PINDEX  index  )

virtual

Determine of this media type is valid for SDP m= section.

Reimplemented in OpalRTPAVPMediaType, and OpalH224MediaType.

void OpalMediaTypeDefinition::SetAutoStart ( OpalMediaType::AutoStartMode  v )

inline

Set flag for media type can auto-start receive on call initiation.

References m_autoStart.

Referenced by OpalManager::SetAutoStartReceiveVideo(), and OpalManager::SetAutoStartTransmitVideo().

void OpalMediaTypeDefinition::SetAutoStart ( OpalMediaType::AutoStartMode  v, bool  on  )

inline

References m_autoStart.

Field Documentation

OpalMediaType::AutoStartMode OpalMediaTypeDefinition::m_autoStart

protected

Referenced by GetAutoStart(), and SetAutoStart().

unsigned OpalMediaTypeDefinition::m_defaultSessionId

protected

Referenced by GetDefaultSessionId().

PString OpalMediaTypeDefinition::m_mediaSessionType

protected

Referenced by GetMediaSessionType().

OpalMediaType OpalMediaTypeDefinition::m_mediaType

protected

---

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

• mediatype.h