OPAL  Version 3.10.10
OpalMediaCommand Class Referenceabstract

#include <mediacmd.h>

Inheritance diagram for OpalMediaCommand:
OpalTemporalSpatialTradeOff OpalVideoUpdatePicture OpalVideoPictureLoss

Public Member Functions

Overrides from PObject
void PrintOn (ostream &strm) const
 
virtual Comparison Compare (const PObject &obj) const
 
Operations
virtual PString GetName () const =0
 
virtual void * GetPlugInData () const
 
virtual unsigned * GetPlugInSize () const
 

Detailed Description

This is the base class for a command to a media transcoder and/or media stream. The commands are highly context sensitive, for example OpalVideoUpdatePicture would only apply to a video transcoder.

Member Function Documentation

◆ Compare()

virtual Comparison OpalMediaCommand::Compare ( const PObject &  obj) const
inlinevirtual

Compare the two objects and return their relative rank. This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns
LessThan, EqualTo or GreaterThan according to the relative rank of the objects.
Parameters
objObject to compare against.

References GetName().

◆ GetName()

virtual PString OpalMediaCommand::GetName ( ) const
pure virtual

Get the name of the command.

Implemented in OpalTemporalSpatialTradeOff, OpalVideoPictureLoss, and OpalVideoUpdatePicture.

Referenced by Compare(), and PrintOn().

◆ GetPlugInData()

virtual void* OpalMediaCommand::GetPlugInData ( ) const
inlinevirtual

Get data buffer pointer for transfer to/from codec plug-in.

◆ GetPlugInSize()

virtual unsigned* OpalMediaCommand::GetPlugInSize ( ) const
inlinevirtual

Get data buffer size for transfer to/from codec plug-in.

◆ PrintOn()

void OpalMediaCommand::PrintOn ( ostream &  strm) const
inline

Standard stream print function. The PObject class has a << operator defined that calls this function polymorphically.

Parameters
strmStream to output text representation

References GetName().


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