DataFormat Class Reference
A Data format.
More...
#include <yatephone.h>
List of all members.
Detailed Description
A Data format.
An extension of a String that can parse data formats
Constructor & Destructor Documentation
Creates a new, empty format string.
Creates a new initialized format.
- Parameters:
-
| value | Initial value of the format |
Copy constructor.
- Parameters:
-
| value | Initial value of the format |
Constructor from String reference
- Parameters:
-
| value | Initial value of the format |
Constructor from String pointer.
- Parameters:
-
| value | Initial value of the format |
Constructor from format information
- Parameters:
-
Member Function Documentation
virtual void changed |
( |
|
) |
[protected, virtual] |
Called whenever the value changed (except in constructors).
Reimplemented from String.
int frameSize |
( |
int |
defValue = 0 |
) |
const [inline] |
Retrive the frame size
- Parameters:
-
| defValue | Default value to return if format is unknown |
- Returns:
- Frame size in octets/frame, 0 for non-framed, defValue if unknown
int frameTime |
( |
int |
defValue = 0 |
) |
const [inline] |
Retrive the frame time
- Parameters:
-
| defValue | Default value to return if format is unknown |
- Returns:
- Frame time in microseconds, 0 for variable, defValue if unknown
Retrive a pointer to the format information
- Returns:
- Pointer to the associated format info or NULL if error
int numChannels |
( |
int |
defValue = 1 |
) |
const [inline] |
Retrive the number of channels
- Parameters:
-
| defValue | Default value to return if format is unknown |
- Returns:
- Number of channels (typically 1), defValue if unknown format
int sampleRate |
( |
int |
defValue = 0 |
) |
const [inline] |
Retrive the sample rate
- Parameters:
-
| defValue | Default 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
The documentation for this class was generated from the following file: