OPAL  Version 3.18.8
OpalMediaFlowControl Class Reference

#include <mediacmd.h>

Inheritance diagram for OpalMediaFlowControl:
Collaboration diagram for OpalMediaFlowControl:

Public Member Functions

 OpalMediaFlowControl (OpalBandwidth bitRate, const OpalMediaType &mediaType, unsigned sessionID=0, unsigned ssrc=0)
 
 OpalMediaFlowControl (OpalBandwidth bitRate, const OpalMediaType &mediaType, unsigned sessionID, const RTP_SyncSourceArray &ssrcs)
 
virtual PString GetName () const
 
const OpalBandwidthGetMaxBitRate () const
 
const RTP_SyncSourceArrayGetSSRCs () const
 
- Public Member Functions inherited from OpalMediaCommand
 OpalMediaCommand (const OpalMediaType &mediaType, unsigned sessionID=0, unsigned ssrc=0)
 
virtual void PrintOn (ostream &strm) const
 
virtual Comparison Compare (const PObject &obj) const
 
virtual PObject * Clone () const =0
 
virtual void * GetPlugInData () const
 
virtual unsigned * GetPlugInSize () const
 
const OpalMediaTypeGetMediaType () const
 
unsigned GetSessionID () const
 
unsigned GetSyncSource () const
 

Protected Attributes

OpalBandwidth m_bitRate
 
RTP_SyncSourceArray m_ssrcs
 
- Protected Attributes inherited from OpalMediaCommand
OpalMediaType m_mediaType
 
unsigned m_sessionID
 
unsigned m_ssrc
 

Detailed Description

This indicates that the media flow (bit rate) is to be adjusted.

Constructor & Destructor Documentation

OpalMediaFlowControl::OpalMediaFlowControl ( OpalBandwidth  bitRate,
const OpalMediaType mediaType,
unsigned  sessionID = 0,
unsigned  ssrc = 0 
)
Parameters
bitRateBandwidth to use
mediaTypeMedia type to search for in open streams
sessionIDSession for media stream, 0 is use first mediaType stream
ssrcSync Source for media stream (if RTP)
OpalMediaFlowControl::OpalMediaFlowControl ( OpalBandwidth  bitRate,
const OpalMediaType mediaType,
unsigned  sessionID,
const RTP_SyncSourceArray ssrcs 
)
Parameters
bitRateBandwidth to use
mediaTypeMedia type to search for in open streams
sessionIDSession for media stream, 0 is use first mediaType stream
ssrcsSync Source(s) for media stream(s) (if RTP)

Member Function Documentation

const OpalBandwidth& OpalMediaFlowControl::GetMaxBitRate ( ) const
inline

References m_bitRate.

virtual PString OpalMediaFlowControl::GetName ( ) const
virtual

Get the name of the command.

Implements OpalMediaCommand.

const RTP_SyncSourceArray& OpalMediaFlowControl::GetSSRCs ( ) const
inline

References m_ssrcs.

Field Documentation

OpalBandwidth OpalMediaFlowControl::m_bitRate
protected

Referenced by GetMaxBitRate().

RTP_SyncSourceArray OpalMediaFlowControl::m_ssrcs
protected

Referenced by GetSSRCs().


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