OpalAudioMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalAudioMediaStream:

OpalRawMediaStream OpalMediaStream List of all members.

Public Member Functions

Construction
 OpalAudioMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, BOOL isSource, PINDEX buffers, PSoundChannel *channel, BOOL autoDelete=TRUE)
 OpalAudioMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, BOOL isSource, PINDEX buffers, const PString &deviceName)
Overrides of OpalMediaStream class
virtual BOOL SetDataSize (PINDEX dataSize)
virtual BOOL IsSynchronous () const

Protected Attributes

PINDEX soundChannelBuffers

Detailed Description

This class describes a media stream that transfers data to/from a audio PSoundChannel.


Constructor & Destructor Documentation

OpalAudioMediaStream::OpalAudioMediaStream ( const OpalMediaFormat mediaFormat,
unsigned  sessionID,
BOOL  isSource,
PINDEX  buffers,
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
channel  Audio device to stream to/from
autoDelete  Automatically delete PSoundChannel

OpalAudioMediaStream::OpalAudioMediaStream ( const OpalMediaFormat mediaFormat,
unsigned  sessionID,
BOOL  isSource,
PINDEX  buffers,
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
deviceName  Name of audio device to stream to/from


Member Function Documentation

virtual BOOL OpalAudioMediaStream::IsSynchronous (  )  const [virtual]

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

Implements OpalMediaStream.

virtual BOOL OpalAudioMediaStream::SetDataSize ( PINDEX  dataSize  )  [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

Reimplemented from OpalMediaStream.


Member Data Documentation

PINDEX OpalAudioMediaStream::soundChannelBuffers [protected]


The documentation for this class was generated from the following file:
Generated on Mon Sep 25 16:21:51 2006 for OPAL by  doxygen 1.4.7