OPAL  Version 3.10.4
OpalIMMediaStream Class Reference

#include <im.h>

Inheritance diagram for OpalIMMediaStream:
OpalMediaStream OpalMSRPMediaStream

Public Member Functions

 OpalIMMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
virtual PBoolean IsSynchronous () const
virtual PBoolean RequiresPatchThread () const
bool ReadPacket (RTP_DataFrame &packet)
bool WritePacket (RTP_DataFrame &packet)
- 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 ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
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
virtual bool SetPaused (bool pause, bool fromPatch=false)
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 ()

Additional Inherited Members

- 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 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
OpalMediaPatchmediaPatch
RTP_DataFrame::PayloadTypes m_payloadType
unsigned m_frameTime
PINDEX m_frameSize

Constructor & Destructor Documentation

OpalIMMediaStream::OpalIMMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource 
)
Parameters:
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream

Member Function Documentation

virtual PBoolean OpalIMMediaStream::IsSynchronous ( ) const
inlinevirtual

Indicate if the media stream is synchronous. If this returns true then the media stream will block of the amount of time it takes to annunciate the data. For example if the media stream is over a sound card, and 480 bytes of data are to be written it will take 30 milliseconds to complete.

Implements OpalMediaStream.

bool OpalIMMediaStream::ReadPacket ( RTP_DataFrame packet)
virtual

Read an RTP frame of data from the source media stream. The default behaviour simply calls ReadData() 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.

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.

virtual PBoolean OpalIMMediaStream::RequiresPatchThread ( ) const
inlinevirtual

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.

bool OpalIMMediaStream::WritePacket ( RTP_DataFrame packet)
virtual

Write an RTP frame of data to the sink media stream. The default behaviour simply calls WriteData() 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.

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.


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