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 defaultSessionId=0, OpalMediaType::AutoStartMode autoStart=OpalMediaType::DontOffer)
	Create a new media type definition. More...
virtual	~OpalMediaTypeDefinition ()
const OpalMediaType &	GetMediaType () const
OpalMediaType::AutoStartMode	GetAutoStart () const
void	SetAutoStart (OpalMediaType::AutoStartMode v)
void	SetAutoStart (OpalMediaType::AutoStartMode v, bool on)
unsigned	GetDefaultSessionId () const
const PCaselessString &	GetMediaSessionType () const

Protected Attributes
OpalMediaType	m_mediaType
PCaselessString	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	defaultSessionId = 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)
defaultSessionId	Session ID to use
autoStart	Default value for auto-start transmit & receive

virtual OpalMediaTypeDefinition::~OpalMediaTypeDefinition ( )

virtual

Member Function Documentation

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 PCaselessString& OpalMediaTypeDefinition::GetMediaSessionType ( ) const

inline

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

References m_mediaSessionType.

const OpalMediaType& OpalMediaTypeDefinition::GetMediaType ( ) const

inline

References m_mediaType.

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
	)

Field Documentation

OpalMediaType::AutoStartMode OpalMediaTypeDefinition::m_autoStart

protected

Referenced by GetAutoStart(), and SetAutoStart().

unsigned OpalMediaTypeDefinition::m_defaultSessionId

protected

Referenced by GetDefaultSessionId().

PCaselessString OpalMediaTypeDefinition::m_mediaSessionType

protected

Referenced by GetMediaSessionType().

OpalMediaType OpalMediaTypeDefinition::m_mediaType

protected

Referenced by GetMediaType().

---

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

• mediatype.h