OPAL  Version 3.10.4
OpalNullMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalNullMediaStream:
OpalMediaStream OpalMediaStreamPacing

Public Member Functions

Construction
 OpalNullMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, bool isSynchronous=false)
 OpalNullMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, bool usePacingDelay, bool requiresPatchThread)
Overrides of OpalMediaStream class
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean RequiresPatchThread () const
virtual PBoolean IsSynchronous () const

Protected Attributes

bool m_isSynchronous
bool m_requiresPatchThread

Detailed Description

This class describes a media stream that is used for media bypass.


Constructor & Destructor Documentation

OpalNullMediaStream::OpalNullMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
bool  isSynchronous = false 
)

Construct a new media stream for RTP sessions.

Parameters:
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
isSynchronousCan accept data and block accordingly
OpalNullMediaStream::OpalNullMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
bool  usePacingDelay,
bool  requiresPatchThread 
)
Parameters:
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
usePacingDelayUse delay to pace stream I/O
requiresPatchThreadRequires a patch thread to execute

Member Function Documentation

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

Indicate if the media stream is synchronous. Returns m_isSynchronous.

Implements OpalMediaStream.

virtual PBoolean OpalNullMediaStream::ReadData ( BYTE *  data,
PINDEX  size,
PINDEX &  length 
) [virtual]

Read raw media data from the source media stream. The default behaviour does nothing and returns false.

Parameters:
dataData buffer to read to
sizeSize of buffer
lengthLength of data actually read

Reimplemented from OpalMediaStream.

virtual PBoolean OpalNullMediaStream::RequiresPatchThread ( ) const [virtual]

Indicate if the media stream requires a OpalMediaPatch thread (active patch). The default behaviour returns the value of m_isSynchronous.

Reimplemented from OpalMediaStream.

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

Write raw media data to the sink media stream. The default behaviour does nothing and returns false.

Parameters:
dataData to write
lengthLength of data to read.
writtenLength of data actually written

Reimplemented from OpalMediaStream.


Field Documentation


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