OPAL  Version 3.14.3
OpalUDPMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalUDPMediaStream:
Collaboration diagram for OpalUDPMediaStream:

Public Member Functions

 ~OpalUDPMediaStream ()
 
Construction
 OpalUDPMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, OpalTransportUDP &transport)
 
Overrides of OpalMediaStream class
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
 
virtual PBoolean WritePacket (RTP_DataFrame &packet)
 
virtual PBoolean IsSynchronous () const
 
- Public Member Functions inherited from OpalMediaStream
virtual bool InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
 
virtual bool InternalSetPaused (bool pause, bool fromUser, bool fromPatch)
 
virtual bool InternalExecuteCommand (const OpalMediaCommand &command)
 
void PrintOn (ostream &strm) const
 
virtual OpalMediaFormat GetMediaFormat () const
 
virtual bool SetMediaFormat (const OpalMediaFormat &mediaFormat)
 
bool UpdateMediaFormat (const OpalMediaFormat &mediaFormat, bool mergeOnly=false)
 
bool ExecuteCommand (const OpalMediaCommand &command) const
 
virtual PBoolean Open ()
 
virtual bool IsOpen () const
 
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 PBoolean RequiresPatchThread () 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 SetPaused (bool pause)
 
virtual PBoolean SetPatch (OpalMediaPatch *patch)
 
OpalMediaPatchPtr GetPatch () 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
 
 P_DECLARE_BITWISE_ENUM (Details, 6,(DetailMinimum, DetailEOL, DetailNAT, DetailSecured, DetailFEC, DetailAudio, DetailAddresses))
 
virtual void PrintDetail (ostream &strm, const char *prefix=NULL, Details details=Details::All()) const
 
 ~OpalMediaStream ()
 

Additional Inherited Members

- Protected Types inherited from OpalMediaStream
typedef OpalMediaPatchPtr PatchPtr
 
- Protected Member Functions inherited from OpalMediaStream
void IncrementTimestamp (PINDEX size)
 
bool InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
 
OpalMediaPatchPtr InternalSetPatchPart1 (OpalMediaPatch *newPatch)
 
void InternalSetPatchPart2 (const OpalMediaPatchPtr &oldPatch)
 
virtual bool InternalSetJitterBuffer (const OpalJitterBuffer::Init &init) const
 
 OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
 
- Protected Attributes inherited from OpalMediaStream
OpalConnectionconnection
 
unsigned sessionID
 
WORD m_sequenceNumber
 
PString identifier
 
OpalMediaFormat mediaFormat
 
bool m_paused
 
bool m_isSource
 
bool m_isOpen
 
PINDEX m_defaultDataSize
 
unsigned timestamp
 
bool marker
 
OpalMediaPatchPtr m_mediaPatch
 
RTP_DataFrame::PayloadTypes m_payloadType
 
unsigned m_frameTime
 
PINDEX m_frameSize
 

Detailed Description

Media stream that uses UDP.

Constructor & Destructor Documentation

OpalUDPMediaStream::OpalUDPMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
OpalTransportUDP transport 
)

Construct a new media stream for channel.

Parameters
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
transportUDP transport instance
OpalUDPMediaStream::~OpalUDPMediaStream ( )

Member Function Documentation

virtual PBoolean OpalUDPMediaStream::IsSynchronous ( ) const
virtual

Indicate if the media stream is synchronous. Returns false.

Implements OpalMediaStream.

virtual PBoolean OpalUDPMediaStream::ReadPacket ( RTP_DataFrame packet)
virtual

Read an RTP frame of data from the source media stream. The new behaviour simply calls OpalTransportUDP::ReadPDU().

Reimplemented from OpalMediaStream.

virtual PBoolean OpalUDPMediaStream::WritePacket ( RTP_DataFrame packet)
virtual

Write an RTP frame of data to the sink media stream. The new behaviour simply calls OpalTransportUDP::Write().

Reimplemented from OpalMediaStream.


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