OpalVideoMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalVideoMediaStream:

OpalMediaStream List of all members.

Public Member Functions

Construction
 OpalVideoMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PVideoInputDevice *inputDevice, PVideoOutputDevice *outputDevice, BOOL autoDelete=TRUE)
 ~OpalVideoMediaStream ()
Overrides of PChannel class
virtual BOOL Open ()
virtual BOOL ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual BOOL WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual BOOL IsSynchronous () const
virtual BOOL SetDataSize (PINDEX dataSize)

Protected Attributes

PVideoInputDevice * inputDevice
PVideoOutputDevice * outputDevice
BOOL autoDelete
PTimeInterval lastGrabTime

Detailed Description

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


Constructor & Destructor Documentation

OpalVideoMediaStream::OpalVideoMediaStream ( const OpalMediaFormat mediaFormat,
unsigned  sessionID,
PVideoInputDevice *  inputDevice,
PVideoOutputDevice *  outputDevice,
BOOL  autoDelete = TRUE 
)

Construct a new media stream for channel.

Parameters:
mediaFormat  Media format for stream
sessionID  Session number for stream
inputDevice  Device to use for video grabbing
outputDevice  Device to use for video display
autoDelete  Automatically delete PVideoDevices

OpalVideoMediaStream::~OpalVideoMediaStream (  ) 

Delete attached channel if autoDelete enabled.


Member Function Documentation

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

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

Implements OpalMediaStream.

virtual BOOL OpalVideoMediaStream::Open (  )  [virtual]

Open the media stream.

The default behaviour sets the OpalLineInterfaceDevice format and calls Resume() on the associated OpalMediaPatch thread.

Reimplemented from OpalMediaStream.

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

Read raw media data from the source media stream. The default behaviour simply calls ReadPacket() on the data portion of the RTP_DataFrame and sets the frames timestamp and marker from the internal member variables of the media stream class.

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

Reimplemented from OpalMediaStream.

virtual BOOL OpalVideoMediaStream::SetDataSize ( PINDEX  dataSize  )  [virtual]

Override size of frame header is included

Parameters:
dataSize  New data size

Reimplemented from OpalMediaStream.

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

Write raw media data to the sink media stream. The default behaviour calls WritePacket() on the data portion of the RTP_DataFrame and and sets the internal timestamp and marker from the member variables of the media stream class.

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

Reimplemented from OpalMediaStream.


Member Data Documentation

BOOL OpalVideoMediaStream::autoDelete [protected]

PVideoInputDevice* OpalVideoMediaStream::inputDevice [protected]

PTimeInterval OpalVideoMediaStream::lastGrabTime [protected]

PVideoOutputDevice* OpalVideoMediaStream::outputDevice [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