OPAL  Version 3.10.4
OpalMSRPMediaStream Class Reference

#include <msrp.h>

Inheritance diagram for OpalMSRPMediaStream:
OpalIMMediaStream OpalMediaStream

Public Member Functions

 OpalMSRPMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, OpalMSRPMediaSession &msrpSession)
 ~OpalMSRPMediaStream ()
virtual PBoolean RequiresPatchThread () const
virtual PBoolean ReadPacket (RTP_DataFrame &frame)
virtual PBoolean WritePacket (RTP_DataFrame &frame)
virtual bool Open ()
virtual bool Close ()
PURL GetRemoteURL () const
void SetRemoteURL (const PURL &url)
 PDECLARE_NOTIFIER2 (OpalMSRPManager, OpalMSRPMediaStream, OnReceiveMSRP, OpalMSRPManager::IncomingMSRP &)
- Public Member Functions inherited from OpalIMMediaStream
 OpalIMMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
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 Start ()
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 ()

Protected Attributes

OpalMSRPMediaSessionm_msrpSession
PString m_remoteParty
RFC4103Context m_rfc4103Context

Constructor & Destructor Documentation

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

Member Function Documentation

virtual bool OpalMSRPMediaStream::Close ( )
virtual

Close the media stream.

   The default does nothing.

Reimplemented from OpalMediaStream.

PURL OpalMSRPMediaStream::GetRemoteURL ( ) const
inline
virtual bool OpalMSRPMediaStream::Open ( )
virtual

Open the media stream using the media format.

   The default behaviour simply sets the isOpen variable to true.

Reimplemented from OpalMediaStream.

OpalMSRPMediaStream::PDECLARE_NOTIFIER2 ( OpalMSRPManager  ,
OpalMSRPMediaStream  ,
OnReceiveMSRP  ,
OpalMSRPManager::IncomingMSRP  
)
virtual PBoolean OpalMSRPMediaStream::ReadPacket ( RTP_DataFrame frame)
virtual

Read raw media data from the source media stream. The default behaviour reads from the PChannel object.

Reimplemented from OpalIMMediaStream.

virtual PBoolean OpalMSRPMediaStream::RequiresPatchThread ( ) const
inlinevirtual

Reimplemented from OpalIMMediaStream.

References OpalMediaStream::isSource.

void OpalMSRPMediaStream::SetRemoteURL ( const PURL &  url)
inline
virtual PBoolean OpalMSRPMediaStream::WritePacket ( RTP_DataFrame frame)
virtual

Write raw media data to the sink media stream. The default behaviour writes to the PChannel object.

Reimplemented from OpalIMMediaStream.


Field Documentation

OpalMSRPMediaSession& OpalMSRPMediaStream::m_msrpSession
protected

Referenced by GetRemoteURL(), and SetRemoteURL().

PString OpalMSRPMediaStream::m_remoteParty
protected
RFC4103Context OpalMSRPMediaStream::m_rfc4103Context
protected

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