OPAL  Version 3.10.10
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 bool SetPaused (bool pause, bool fromPatch=false)
virtual PBoolean RequiresPatchThread () const
virtual PBoolean IsSynchronous () const
- Public Member Functions inherited from OpalMediaStream
void PrintOn (ostream &strm) const
virtual OpalMediaFormat GetMediaFormat () const
bool UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual bool InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean ExecuteCommand (const OpalMediaCommand &command)
virtual PBoolean Open ()
virtual PBoolean Start ()
virtual PBoolean Close ()
virtual void OnStartMediaPatch ()
virtual void OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean WritePackets (RTP_DataFrameList &packets)
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
virtual PBoolean WritePacket (RTP_DataFrame &packet)
bool PushPacket (RTP_DataFrame &packet)
virtual PBoolean SetDataSize (PINDEX dataSize, PINDEX frameTime)
PINDEX GetDataSize () const
virtual PBoolean RequiresPatchThread (OpalMediaStream *stream) const
virtual bool EnableJitterBuffer (bool enab=true) const
OpalConnectionGetConnection () const
bool IsSource () const
bool IsSink () const
unsigned GetSessionID () const
void SetSessionID (unsigned id)
PString GetID () const
unsigned GetTimestamp () const
void SetTimestamp (unsigned ts)
bool GetMarker () const
void SetMarker (bool m)
bool IsPaused () const
bool IsOpen () const
virtual PBoolean SetPatch (OpalMediaPatch *patch)
OpalMediaPatchGetPatch () const
void AddFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
bool RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
virtual void GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const
 ~OpalMediaStream ()
- Public Member Functions inherited from OpalMediaStreamPacing
 OpalMediaStreamPacing (const OpalMediaFormat &mediaFormat)
void Pace (bool reading, PINDEX bytes, bool &marker)
 Delay appropriate time for the written bytes.

Protected Member Functions

virtual void InternalClose ()
- Protected Member Functions inherited from OpalMediaStream
void IncrementTimestamp (PINDEX size)
bool InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
 OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes

bool m_isSynchronous
bool m_requiresPatchThread
- Protected Attributes inherited from OpalMediaStream
OpalConnectionconnection
unsigned sessionID
PString identifier
OpalMediaFormat mediaFormat
bool m_paused
bool isSource
bool isOpen
PINDEX defaultDataSize
unsigned timestamp
bool marker
unsigned mismatchedPayloadTypes
PatchPtr m_mediaPatch
RTP_DataFrame::PayloadTypes m_payloadType
unsigned m_frameTime
PINDEX m_frameSize
- Protected Attributes inherited from OpalMediaStreamPacing
bool m_isAudio
unsigned m_frameTime
PINDEX m_frameSize
unsigned m_timeUnits
PAdaptiveDelay m_delay

Additional Inherited Members

- Protected Types inherited from OpalMediaStream
typedef PSafePtr
< OpalMediaPatch,
PSafePtrMultiThreaded > 
PatchPtr

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 void OpalNullMediaStream::InternalClose ( )
inlineprotectedvirtual

Close any internal components of the stream. This should be used in preference to overriding the Close() function as it is guaranteed to be called exactly once and avoids race conditions in the shut down sequence of a media stream.

Implements OpalMediaStream.

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 bool OpalNullMediaStream::SetPaused ( bool  pause,
bool  fromPatch = false 
)
virtual

Set the paused state for stream. This will stop reading/writing data from the stream. Returns true if the pause state was changed

Parameters
pauseIndicate that the stream should be paused
fromPatchIs being called from OpalMediaPatch

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

bool OpalNullMediaStream::m_isSynchronous
protected
bool OpalNullMediaStream::m_requiresPatchThread
protected

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