OPAL  Version 3.10.4
OpalFileMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalFileMediaStream:
OpalRawMediaStream OpalMediaStreamPacing OpalMediaStream

Public Member Functions

Construction
 OpalFileMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PFile *file, bool autoDelete=true)
 OpalFileMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, const PFilePath &path)
Overrides of OpalMediaStream class
virtual PBoolean IsSynchronous () const
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)

Protected Attributes

PFile file

Detailed Description

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


Constructor & Destructor Documentation

OpalFileMediaStream::OpalFileMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
PFile *  file,
bool  autoDelete = true 
)

Construct a new media stream for files.

Parameters:
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
fileFile to stream to/from
autoDeleteAutomatically delete file
OpalFileMediaStream::OpalFileMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
const PFilePath &  path 
)

Construct a new media stream for files.

Parameters:
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
pathFile path to stream to/from

Member Function Documentation

virtual PBoolean OpalFileMediaStream::IsSynchronous ( ) const [virtual]

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

Implements OpalMediaStream.

virtual PBoolean OpalFileMediaStream::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:
dataData buffer to read to
sizeSize of buffer
lengthLength of data actually read

Reimplemented from OpalRawMediaStream.

virtual PBoolean OpalFileMediaStream::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:
dataData to write
lengthLength of data to read.
writtenLength of data actually written

Reimplemented from OpalRawMediaStream.


Field Documentation

PFile OpalFileMediaStream::file [protected]

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