OPAL Version 3.10.2
OpalVideoMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalVideoMediaStream:
OpalMediaStream

Public Member Functions

Construction
 OpalVideoMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, PVideoInputDevice *inputDevice, PVideoOutputDevice *outputDevice, bool autoDeleteInput=true, bool autoDeleteOutput=true)
 ~OpalVideoMediaStream ()
Overrides of PChannel class
virtual PBoolean Open ()
virtual PBoolean Close ()
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean IsSynchronous () const
virtual PBoolean SetDataSize (PINDEX dataSize, PINDEX frameTime)
virtual PVideoInputDevice * GetVideoInputDevice () const
virtual PVideoOutputDevice * GetVideoOutputDevice () const

Protected Attributes

PVideoInputDevice * m_inputDevice
PVideoOutputDevice * m_outputDevice
bool m_autoDeleteInput
bool m_autoDeleteOutput
PTimeInterval m_lastGrabTime

Constructor & Destructor Documentation

OpalVideoMediaStream::OpalVideoMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
PVideoInputDevice *  inputDevice,
PVideoOutputDevice *  outputDevice,
bool  autoDeleteInput = true,
bool  autoDeleteOutput = true 
)

Construct a new media stream for channel.

Parameters:
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
inputDeviceDevice to use for video grabbing
outputDeviceDevice to use for video display
autoDeleteInputAutomatically delete PVideoInputDevice
autoDeleteOutputAutomatically delete PVideoOutputDevice
OpalVideoMediaStream::~OpalVideoMediaStream ( )

Delete attached channel if autoDelete enabled.


Member Function Documentation

virtual PBoolean OpalVideoMediaStream::Close ( ) [virtual]

Close the media stream.

The default does nothing.

Reimplemented from OpalMediaStream.

virtual PVideoInputDevice* OpalVideoMediaStream::GetVideoInputDevice ( ) const [inline, virtual]

Get the input device (e.g. for statistics)

References m_inputDevice.

virtual PVideoOutputDevice* OpalVideoMediaStream::GetVideoOutputDevice ( ) const [inline, virtual]

Get the output device (e.g. for statistics)

References m_outputDevice.

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

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

Implements OpalMediaStream.

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

Reimplemented from OpalMediaStream.

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

Override size of frame header is included

Parameters:
dataSizeNew data size (in total)
frameTimeIndividual frame time (if applicable)

Reimplemented from OpalMediaStream.

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

Reimplemented from OpalMediaStream.


Field Documentation

PVideoInputDevice* OpalVideoMediaStream::m_inputDevice [protected]

Referenced by GetVideoInputDevice().

PTimeInterval OpalVideoMediaStream::m_lastGrabTime [protected]
PVideoOutputDevice* OpalVideoMediaStream::m_outputDevice [protected]

Referenced by GetVideoOutputDevice().


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