class DataFormat

A Data format. More...

Full nameTelEngine::DataFormat
Definition#include <yatephone.h>
InheritsTelEngine::String [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

An extension of a String that can parse data formats

inline  DataFormat ()

DataFormat

Creates a new, empty format string.

inline  DataFormat (const char* value)

DataFormat

Creates a new initialized format.

Parameters:
valueInitial value of the format

inline  DataFormat (const DataFormat& value)

DataFormat

Copy constructor.

Parameters:
valueInitial value of the format

inline  DataFormat (const String& value)

DataFormat

Constructor from String reference

Parameters:
valueInitial value of the format

inline  DataFormat (const String* value)

DataFormat

Constructor from String pointer.

Parameters:
valueInitial value of the format

inline  DataFormat (const FormatInfo* format)

DataFormat

Constructor from format information

Parameters:
formatPointer to existing FormatInfo

inline DataFormat&  operator= (const DataFormat& value)

operator=

Assignment operator.

Reimplemented from String.

const FormatInfo*  getInfo ()

getInfo

[const]

Retrive a pointer to the format information

Returns: Pointer to the associated format info or NULL if error

inline int  frameSize (int defValue = 0)

frameSize

[const]

Retrive the frame size

Parameters:
defValueDefault value to return if format is unknown

Returns: Frame size in octets/frame, 0 for non-framed, defValue if unknown

inline int  frameTime (int defValue = 0)

frameTime

[const]

Retrive the frame time

Parameters:
defValueDefault value to return if format is unknown

Returns: Frame time in microseconds, 0 for variable, defValue if unknown

inline int  sampleRate (int defValue = 0)

sampleRate

[const]

Retrive the sample rate

Parameters:
defValueDefault value to return if format is unknown

Returns: Rate in samples/second (audio) or 1e-6 frames/second (video), 0 for unknown, defValue if unknown format

inline int  numChannels (int defValue = 1)

numChannels

[const]

Retrive the number of channels

Parameters:
defValueDefault value to return if format is unknown

Returns: Number of channels (typically 1), defValue if unknown format

void  changed ()

changed

[protected virtual]

Called whenever the value changed (except in constructors).

Reimplemented from String.


Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54.