OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Member Functions | Protected Attributes
OpalPluginStreamedAudioTranscoder Class Reference

`#include <opalpluginmgr.h>`

Inheritance diagram for OpalPluginStreamedAudioTranscoder:

## Public Member Functions

| OpalPluginStreamedAudioTranscoder (const PluginCodec_Definition *codec, bool isEncoder)
bool | UpdateMediaFormats (const OpalMediaFormat &input, const OpalMediaFormat &output)
PBoolean | ExecuteCommand (const OpalMediaCommand &command)
virtual bool | AcceptComfortNoise () const
virtual int | ConvertOne (int from) const
Public Member Functions inherited from OpalStreamedTranscoder
| OpalStreamedTranscoder (const OpalMediaFormat &inputMediaFormat, const OpalMediaFormat &outputMediaFormat, unsigned inputBits, unsigned outputBits)
virtual PINDEX | GetOptimalDataFrameSize (PBoolean input) const
virtual PBoolean | Convert (const RTP_DataFrame &input, RTP_DataFrame &output)
Public Member Functions inherited from OpalTranscoder
| OpalTranscoder (const OpalMediaFormat &inputMediaFormat, const OpalMediaFormat &outputMediaFormat)
virtual PBoolean | ConvertFrames (const RTP_DataFrame &input, RTP_DataFrameList &output)
PINDEX | GetMaxOutputSize () const
void | SetMaxOutputSize (PINDEX size)
void | SetCommandNotifier (const PNotifier &notifier)
const PNotifier & | GetCommandNotifier () const
void | NotifyCommand (const OpalMediaCommand &command) const
| Notify command notifier of command.
unsigned | GetSessionID () const
| Get session ID for the transcoder (from OpalMediaStream)
void | SetSessionID (unsigned id)
| Set session ID for the transcoder (from OpalMediaStream)
virtual void | SetInstanceID (const BYTE *instance, unsigned instanceLen)
RTP_DataFrame::PayloadTypes | GetPayloadType (PBoolean input) const
virtual bool | AcceptEmptyPayload () const
virtual bool | AcceptOtherPayloads () const
virtual void | GetStatistics (OpalMediaStatistics &statistics) const
void | CopyTimestamp (RTP_DataFrame &dst, const RTP_DataFrame &src, bool inToOut) const
Public Member Functions inherited from OpalMediaFormatPair
| OpalMediaFormatPair (const OpalMediaFormat &inputMediaFormat, const OpalMediaFormat &outputMediaFormat)
void | PrintOn (ostream &strm) const
virtual Comparison | Compare (const PObject &obj) const
const OpalMediaFormat & | GetInputFormat () const
const OpalMediaFormat & | GetOutputFormat () const
Public Member Functions inherited from OpalPluginTranscoder
| OpalPluginTranscoder (const PluginCodec_Definition *defn, bool isEnc)
| ~OpalPluginTranscoder ()
bool | UpdateOptions (const OpalMediaFormat &fmt)
bool | Transcode (const void *from, unsigned *fromLen, void *to, unsigned *toLen, unsigned *flags) const

## Protected Attributes

bool | comfortNoise
Protected Attributes inherited from OpalStreamedTranscoder
unsigned | inputBitsPerSample
unsigned | outputBitsPerSample
Protected Attributes inherited from OpalTranscoder
PINDEX | maxOutputSize
PNotifier | commandNotifier
PMutex | updateMutex
unsigned | m_sessionID
bool | outputIsRTP
bool | inputIsRTP
bool | acceptEmptyPayload
bool | acceptOtherPayloads
unsigned | m_inClockRate
unsigned | m_outClockRate
Protected Attributes inherited from OpalMediaFormatPair
OpalMediaFormat | inputMediaFormat
OpalMediaFormat | outputMediaFormat
Protected Attributes inherited from OpalPluginTranscoder
const PluginCodec_Definition * | codecDef
bool | isEncoder
void * | context
OpalPluginControl | setCodecOptions
OpalPluginControl | getOutputDataSizeControl

## Constructor & Destructor Documentation

OpalPluginStreamedAudioTranscoder::OpalPluginStreamedAudioTranscoder | ( | const PluginCodec_Definition * | codec,
|  | bool | isEncoder
| ) |  |

## Member Function Documentation

virtual bool OpalPluginStreamedAudioTranscoder::AcceptComfortNoise | ( |  | ) | const

inline virtual

Reimplemented from OpalTranscoder.

References comfortNoise.

virtual int OpalPluginStreamedAudioTranscoder::ConvertOne | ( | int | sample | ) | const

virtual

Convert one sample from one format to another. This function takes the input data as a single sample value and converts it to its output format.

Returns converted value.

Implements OpalStreamedTranscoder.

PBoolean OpalPluginStreamedAudioTranscoder::ExecuteCommand | ( | const OpalMediaCommand & | command | ) |

Reimplemented from OpalPluginTranscoder.

bool OpalPluginStreamedAudioTranscoder::UpdateMediaFormats | ( | const OpalMediaFormat & | inputMediaFormat,
|  | const OpalMediaFormat & | outputMediaFormat
| ) |  |

virtual

Update the input and output media formats. This can be used to adjust the parameters of a codec at run time. Note you cannot change the basic media format, eg change GSM0610 to G.711, only options for that format, eg 6k3 mode to 5k3 mode in G.723.1. If the formats are different then a OpalMediaFormat::Merge() is performed.

If a format is empty (invalid) it is ignored and does not update the internal variable. In this way only the input or output side can be updated.

The default behaviour updates the inputMediaFormat and outputMediaFormat member variables.

Reimplemented from OpalTranscoder.

## Field Documentation

bool OpalPluginStreamedAudioTranscoder::comfortNoise

protected

Referenced by AcceptComfortNoise().

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

- opalpluginmgr.h