OpalAudioMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalAudioMediaStream:

Public Member Functions
Construction
	OpalAudioMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PINDEX buffers, unsigned bufferTime, PSoundChannel *channel, bool autoDelete=true)
	OpalAudioMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PINDEX buffers, unsigned bufferTime, const PString &deviceName)
Overrides of OpalMediaStream class
virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)
virtual PBoolean	IsSynchronous () const
Protected Attributes
PINDEX	m_soundChannelBuffers
unsigned	m_soundChannelBufferTime

---

Constructor & Destructor Documentation

OpalAudioMediaStream::OpalAudioMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		PINDEX	buffers,
		unsigned	bufferTime,
		PSoundChannel *	channel,
		bool	autoDelete = true
	)

Construct a new media stream for audio.

Parameters:

	mediaFormat	Media format for stream
	sessionID	Session number for stream
	isSource	Is a source stream
	buffers	Number of buffers on sound channel
	bufferTime	Buffering time on sound channel (milliseconds)
	channel	Audio device to stream to/from
	autoDelete	Automatically delete PSoundChannel

OpalAudioMediaStream::OpalAudioMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		PINDEX	buffers,
		unsigned	bufferTime,
		const PString &	deviceName
	)

Construct a new media stream for audio.

Parameters:

	mediaFormat	Media format for stream
	sessionID	Session number for stream
	isSource	Is a source stream
	buffers	Number of buffers on sound channel
	bufferTime	Buffering time on sound channel (milliseconds)
	deviceName	Name of audio device to stream to/from

---

Member Function Documentation

virtual PBoolean OpalAudioMediaStream::IsSynchronous

(

)

const [virtual]

Indicate if the media stream is synchronous. Returns true for LID streams.

Implements OpalMediaStream.

virtual PBoolean OpalAudioMediaStream::SetDataSize	(	PINDEX	dataSize,
		PINDEX	frameTime
	)			[virtual]

Set the data size in bytes that is expected to be used. Some media streams can make use of this information to perform optimisations.

The defafault simply sets teh member variable defaultDataSize.

Parameters:

	dataSize	New data size (in total)
	frameTime	Individual frame time (if applicable)

Reimplemented from OpalMediaStream.

---

Field Documentation

PINDEX OpalAudioMediaStream::m_soundChannelBuffers [protected]

unsigned OpalAudioMediaStream::m_soundChannelBufferTime [protected]

---

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

• mediastrm.h