class TransportInfo

Transport Information. More...

Full nameCoral::TransportInfo
Definition#include <transportinfo.h>
Inherited byExtendedTransportInfo
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Members


Detailed Description

This class keeps information on an encoding's transport of data: Quality levels and layers, required bandwidth, etc.

See also: EncoderInterface, DecoderInterface

 TransportInfo ()

Constructor.

void  translate ()

Translate byte order.

void  reset ()

Reset.

int  operator== (const TransportInfo& ti)

[const]

== operator.

inline int  operator!= (const TransportInfo& ti)

[const]

!= operator.

const static cardinal MaxQualityLevels

Constant for maximum number of quality levels.

Range<card64> [TransportInfoLevel::MaxQualityLayers] WantedBytesPerSecond

Bytes per second: Minimum, maximum and current quality setting's value for each layer.

Range<card32> [TransportInfoLevel::MaxQualityLayers] WantedPacketsPerSecond

Packets per second: Minimum, maximum and current quality setting's value for each layer.

Range<card32> WantedFramesPerSecond

Frames per second: Minimum, maximum and current quality setting's value.

card32 WantedMaxTransferDelay

Wanted maximum transfer delay in 1/16 milliseconds for base data.

card8 [TransportInfoLevel::MaxQualityLayers] WantedMaxLossRate

Wanted maximum loss rate in fraction of 255 for each layer.

card64 TotalBytesPerSecondLimit

Total bytes per second limit.

card32 TotalPacketsPerSecondLimit

Total packets per second limit.

card32 TotalFramesPerSecondLimit

Total frames per second limit.

card16 Flags

TransportInfo flags. This is a constant set by the encoding.

enum TransportInfoFlags {TIF_None = 0, TIF_HasDynamic = (1 << 0) }

TransportInfo flags enumeration.

card8 QualityLevels

Number of quality levels stored in QualityLevel array. This is a constant set by the encoding.

card8 QualityLayers

Maximum number of quality layers within in a level. It is used to limit the range of valid Wanted values. This is a constant set by the encoding.

card32 StartFramesPerSecond

Start frames per second. This is a constant set by the encoding.

TransportInfoLevel [MaxQualityLevels] QualityLevel

Quality level transport information array. All values are *constants* of the encoding.

TransportInfoLevel CurrentSetting

Current setting's transport information. The encoding will store current setting here.

inline card64  getTotalWantedBytesPerSecond ()

[const]

Calculate of sum of all layers' WantedBytesPerSecond[].getValue() value.

Returns: Total wanted bytes per second.

inline card64  getTotalMinWantedBytesPerSecond ()

[const]

Calculate of sum of all layers' WantedBytesPerSecond[].getMin() value.

Returns: Total minimum wanted bytes per second.

inline card64  getTotalMaxWantedBytesPerSecond ()

[const]

Calculate of sum of all layers' WantedBytesPerSecond[].getMax() value.

Returns: Total maximum wanted bytes per second.

inline card32  getTotalWantedPacketsPerSecond ()

[const]

Calculate of sum of all layers' WantedPacketsPerSecond[].getValue() value.

Returns: Total wanted packets per second.

inline card32  getTotalMinWantedPacketsPerSecond ()

[const]

Calculate of sum of all layers' WantedPacketsPerSecond[].getMin() value.

Returns: Total minimum wanted packets per second.

inline card32  getTotalMaxWantedPacketsPerSecond ()

[const]

Calculate of sum of all layers' WantedPacketsPerSecond[].getMax() value.

Returns: Total maximum wanted packets per second.