OpalRawMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalRawMediaStream:

OpalMediaStream OpalAudioMediaStream OpalFileMediaStream List of all members.

Public Member Functions

Overrides of OpalMediaStream class
virtual BOOL ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual BOOL WriteData (const BYTE *data, PINDEX length, PINDEX &written)
PChannel * GetChannel ()
virtual BOOL Close ()

Protected Member Functions

Construction
 OpalRawMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, BOOL isSource, PChannel *channel, BOOL autoDelete)
 ~OpalRawMediaStream ()

Protected Attributes

PChannel * channel
BOOL autoDelete

Detailed Description

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


Constructor & Destructor Documentation

OpalRawMediaStream::OpalRawMediaStream ( const OpalMediaFormat mediaFormat,
unsigned  sessionID,
BOOL  isSource,
PChannel *  channel,
BOOL  autoDelete 
) [protected]

Construct a new media stream for channel.

Parameters:
mediaFormat  Media format for stream
sessionID  Session number for stream
isSource  Is a source stream
channel  I/O channel to stream to/from
autoDelete  Automatically delete channel

OpalRawMediaStream::~OpalRawMediaStream (  )  [protected]

Delete attached channel if autoDelete enabled.


Member Function Documentation

virtual BOOL OpalRawMediaStream::Close (  )  [virtual]

Close the media stream.

Closes the associated PChannel.

Reimplemented from OpalMediaStream.

PChannel* OpalRawMediaStream::GetChannel (  )  [inline]

Return the associated PChannel

virtual BOOL OpalRawMediaStream::ReadData ( BYTE *  data,
PINDEX  size,
PINDEX &  length 
) [virtual]

Read raw media data from the source media stream. The default behaviour reads from the PChannel object.

Parameters:
data  Data buffer to read to
size  Size of buffer
length  Length of data actually read

Reimplemented from OpalMediaStream.

virtual BOOL OpalRawMediaStream::WriteData ( const BYTE *  data,
PINDEX  length,
PINDEX &  written 
) [virtual]

Write raw media data to the sink media stream. The default behaviour writes to the PChannel object.

Parameters:
data  Data to write
length  Length of data to read.
written  Length of data actually written

Reimplemented from OpalMediaStream.


Member Data Documentation

BOOL OpalRawMediaStream::autoDelete [protected]

PChannel* OpalRawMediaStream::channel [protected]


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