OpalMediaFormatInternal Class Reference

#include <mediafmt.h>

Inheritance diagram for OpalMediaFormatInternal:

List of all members.

Public Member Functions
	OpalMediaFormatInternal (const char *fullName, const OpalMediaType &mediaType, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, PBoolean needsJitter, unsigned bandwidth, PINDEX frameSize, unsigned frameTime, unsigned clockRate, time_t timeStamp)
virtual PObject *	Clone () const
virtual void	PrintOn (ostream &strm) const
virtual PBoolean	IsValid () const
virtual PBoolean	IsTransportable () const
virtual PStringToString	GetOptions () const
virtual bool	GetOptionValue (const PString &name, PString &value) const
virtual bool	SetOptionValue (const PString &name, const PString &value)
virtual bool	GetOptionBoolean (const PString &name, bool dflt) const
virtual bool	SetOptionBoolean (const PString &name, bool value)
virtual int	GetOptionInteger (const PString &name, int dflt) const
virtual bool	SetOptionInteger (const PString &name, int value)
virtual double	GetOptionReal (const PString &name, double dflt) const
virtual bool	SetOptionReal (const PString &name, double value)
virtual PINDEX	GetOptionEnum (const PString &name, PINDEX dflt) const
virtual bool	SetOptionEnum (const PString &name, PINDEX value)
virtual PString	GetOptionString (const PString &name, const PString &dflt) const
virtual bool	SetOptionString (const PString &name, const PString &value)
virtual bool	GetOptionOctets (const PString &name, PBYTEArray &octets) const
virtual bool	SetOptionOctets (const PString &name, const PBYTEArray &octets)
virtual bool	SetOptionOctets (const PString &name, const BYTE *data, PINDEX length)
virtual bool	AddOption (OpalMediaOption *option, PBoolean overwrite=PFalse)
virtual OpalMediaOption *	FindOption (const PString &name) const
virtual bool	ToNormalisedOptions ()
virtual bool	ToCustomisedOptions ()
virtual bool	Merge (const OpalMediaFormatInternal &mediaFormat)
virtual bool	IsValidForProtocol (const PString &protocol) const
Protected Attributes
PCaselessString	formatName
RTP_DataFrame::PayloadTypes	rtpPayloadType
PString	rtpEncodingName
OpalMediaType	mediaType
PMutex	media_format_mutex
PSortedList< OpalMediaOption >	options
time_t	codecVersionTime
Friends
class	OpalMediaFormat
class	OpalMediaFormatList
class	OpalAudioFormatInternal
bool	operator== (const char *other, const OpalMediaFormat &fmt)
bool	operator!= (const char *other, const OpalMediaFormat &fmt)
bool	operator== (const PString &other, const OpalMediaFormat &fmt)
bool	operator!= (const PString &other, const OpalMediaFormat &fmt)

---

Constructor & Destructor Documentation

OpalMediaFormatInternal::OpalMediaFormatInternal	(	const char *	fullName,
		const OpalMediaType &	mediaType,
		RTP_DataFrame::PayloadTypes	rtpPayloadType,
		const char *	encodingName,
		PBoolean	needsJitter,
		unsigned	bandwidth,
		PINDEX	frameSize,
		unsigned	frameTime,
		unsigned	clockRate,
		time_t	timeStamp
	)

---

Member Function Documentation

virtual PObject* OpalMediaFormatInternal::Clone

(

)

const [virtual]

Reimplemented in OpalPluginAudioFormatInternal, and OpalAudioFormatInternal.

virtual void OpalMediaFormatInternal::PrintOn

(

ostream &

strm

)

const [virtual]

virtual PBoolean OpalMediaFormatInternal::IsValid

(

)

const [inline, virtual]

virtual PBoolean OpalMediaFormatInternal::IsTransportable

(

)

const [inline, virtual]

virtual PStringToString OpalMediaFormatInternal::GetOptions

(

)

const [virtual]

virtual bool OpalMediaFormatInternal::GetOptionValue	(	const PString &	name,
		PString &	value
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionValue	(	const PString &	name,
		const PString &	value
	)			[virtual]

virtual bool OpalMediaFormatInternal::GetOptionBoolean	(	const PString &	name,
		bool	dflt
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionBoolean	(	const PString &	name,
		bool	value
	)			[virtual]

virtual int OpalMediaFormatInternal::GetOptionInteger	(	const PString &	name,
		int	dflt
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionInteger	(	const PString &	name,
		int	value
	)			[virtual]

virtual double OpalMediaFormatInternal::GetOptionReal	(	const PString &	name,
		double	dflt
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionReal	(	const PString &	name,
		double	value
	)			[virtual]

virtual PINDEX OpalMediaFormatInternal::GetOptionEnum	(	const PString &	name,
		PINDEX	dflt
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionEnum	(	const PString &	name,
		PINDEX	value
	)			[virtual]

virtual PString OpalMediaFormatInternal::GetOptionString	(	const PString &	name,
		const PString &	dflt
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionString	(	const PString &	name,
		const PString &	value
	)			[virtual]

virtual bool OpalMediaFormatInternal::GetOptionOctets	(	const PString &	name,
		PBYTEArray &	octets
	)			const [virtual]

virtual bool OpalMediaFormatInternal::SetOptionOctets	(	const PString &	name,
		const PBYTEArray &	octets
	)			[virtual]

virtual bool OpalMediaFormatInternal::SetOptionOctets	(	const PString &	name,
		const BYTE *	data,
		PINDEX	length
	)			[virtual]

virtual bool OpalMediaFormatInternal::AddOption	(	OpalMediaOption *	option,
		PBoolean	overwrite = PFalse
	)			[virtual]

virtual OpalMediaOption* OpalMediaFormatInternal::FindOption

(

const PString &

name

)

const [virtual]

virtual bool OpalMediaFormatInternal::ToNormalisedOptions

(

)

[virtual]

Reimplemented in OpalPluginAudioFormatInternal.

virtual bool OpalMediaFormatInternal::ToCustomisedOptions

(

)

[virtual]

Reimplemented in OpalPluginAudioFormatInternal.

virtual bool OpalMediaFormatInternal::Merge

(

const OpalMediaFormatInternal &

mediaFormat

)

[virtual]

Reimplemented in OpalAudioFormatInternal.

virtual bool OpalMediaFormatInternal::IsValidForProtocol

(

const PString &

protocol

)

const [virtual]

Reimplemented in OpalPluginAudioFormatInternal.

---

Friends And Related Function Documentation

friend class OpalMediaFormat [friend]

friend class OpalMediaFormatList [friend]

friend class OpalAudioFormatInternal [friend]

bool operator==	(	const char *	other,
		const OpalMediaFormat &	fmt
	)			[friend]

bool operator!=	(	const char *	other,
		const OpalMediaFormat &	fmt
	)			[friend]

bool operator==	(	const PString &	other,
		const OpalMediaFormat &	fmt
	)			[friend]

bool operator!=	(	const PString &	other,
		const OpalMediaFormat &	fmt
	)			[friend]

---

Member Data Documentation

PCaselessString OpalMediaFormatInternal::formatName [protected]

RTP_DataFrame::PayloadTypes OpalMediaFormatInternal::rtpPayloadType [protected]

PString OpalMediaFormatInternal::rtpEncodingName [protected]

OpalMediaType OpalMediaFormatInternal::mediaType [protected]

PMutex OpalMediaFormatInternal::media_format_mutex [protected]

PSortedList<OpalMediaOption> OpalMediaFormatInternal::options [protected]

time_t OpalMediaFormatInternal::codecVersionTime [protected]

---

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

• mediafmt.h

---