OPAL Version 3.10.2
OpalVideoFormat Class Reference

#include <mediafmt.h>

Inheritance diagram for OpalVideoFormat:
OpalMediaFormat

Public Types

enum  ContentRole {
  eNoRole, ePresentation, eMainRole, eSpeaker,
  eSignLanguage, eNumRoles
}
enum  { ContentRoleMask = 15 }

Public Member Functions

 OpalVideoFormat (OpalMediaFormatInternal *info=NULL)
 OpalVideoFormat (const char *fullName, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, unsigned maxFrameWidth, unsigned maxFrameHeight, unsigned maxFrameRate, unsigned maxBitRate, time_t timeStamp=0)

Static Public Member Functions

static const PString & FrameWidthOption ()
static const PString & FrameHeightOption ()
static const PString & MinRxFrameWidthOption ()
static const PString & MinRxFrameHeightOption ()
static const PString & MaxRxFrameWidthOption ()
static const PString & MaxRxFrameHeightOption ()
static const PString & TemporalSpatialTradeOffOption ()
static const PString & TxKeyFramePeriodOption ()
static const PString & RateControlEnableOption ()
static const PString & RateControllerOption ()
static const PString & RateControllerBitRateScalerOption ()
static __inline unsigned ContentRoleBit (ContentRole contentRole)
static const PString & ContentRoleOption ()
static const PString & ContentRoleMaskOption ()

Member Enumeration Documentation

anonymous enum
Enumerator:
ContentRoleMask 

The "role" of the content in the video stream based on this media format. This is based on RFC4796 and H.239 semantics and is an enumeration consisting of: Value H.239 RFC4796 NoRole Not used (not populated) Presentation Presentation (0x01) slides Main Live (0x02) main Speaker Live (0x02) speaker SignLanguage Live (0x02) sl

Enumerator:
eNoRole 
ePresentation 
eMainRole 
eSpeaker 
eSignLanguage 
eNumRoles 

Constructor & Destructor Documentation

OpalVideoFormat::OpalVideoFormat ( OpalMediaFormatInternal info = NULL) [inline]
OpalVideoFormat::OpalVideoFormat ( const char *  fullName,
RTP_DataFrame::PayloadTypes  rtpPayloadType,
const char *  encodingName,
unsigned  maxFrameWidth,
unsigned  maxFrameHeight,
unsigned  maxFrameRate,
unsigned  maxBitRate,
time_t  timeStamp = 0 
)
Parameters:
fullNameFull name of media format
rtpPayloadTypeRTP payload type code
encodingNameRTP encoding name
maxFrameWidthWidth of video frame
maxFrameHeightHeight of video frame
maxFrameRateNumber of frames per second
maxBitRateMaximum bits per second
timeStamptimestamp (for versioning)

Member Function Documentation

static __inline unsigned OpalVideoFormat::ContentRoleBit ( ContentRole  contentRole) [inline, static]

References eNoRole.

static const PString& OpalVideoFormat::ContentRoleMaskOption ( ) [static]
static const PString& OpalVideoFormat::ContentRoleOption ( ) [static]
static const PString& OpalVideoFormat::FrameHeightOption ( ) [static]
static const PString& OpalVideoFormat::FrameWidthOption ( ) [static]
static const PString& OpalVideoFormat::MaxRxFrameHeightOption ( ) [static]
static const PString& OpalVideoFormat::MaxRxFrameWidthOption ( ) [static]
static const PString& OpalVideoFormat::MinRxFrameHeightOption ( ) [static]
static const PString& OpalVideoFormat::MinRxFrameWidthOption ( ) [static]
static const PString& OpalVideoFormat::RateControlEnableOption ( ) [static]
static const PString& OpalVideoFormat::RateControllerBitRateScalerOption ( ) [static]
static const PString& OpalVideoFormat::RateControllerOption ( ) [static]
static const PString& OpalVideoFormat::TemporalSpatialTradeOffOption ( ) [static]
static const PString& OpalVideoFormat::TxKeyFramePeriodOption ( ) [static]

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