Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

FormatInfo Struct Reference

#include <yatephone.h>

List of all members.

Public Member Functions

int guessSamples (int len) const
int dataRate () const
 FormatInfo ()
 FormatInfo (const char *_name, int fsize=0, int ftime=10000, const char *_type="audio", int srate=8000, int nchan=1, bool convert=false)

Public Attributes

const char * name
const char * type
int frameSize
int frameTime
int sampleRate
int numChannels
bool converter


Detailed Description

A structure to hold information about a data format.


Constructor & Destructor Documentation

FormatInfo  )  [inline]
 

Default constructor - used to initialize arrays

FormatInfo const char *  _name,
int  fsize = 0,
int  ftime = 10000,
const char *  _type = "audio",
int  srate = 8000,
int  nchan = 1,
bool  convert = false
[inline]
 

Normal constructor


Member Function Documentation

int dataRate  )  const
 

Get the data rate in bytes/s

Returns:
Data rate or 0 if variable/undefined

int guessSamples int  len  )  const
 

Guess the number of samples in an encoded data block

Parameters:
len Length of the data block in octets
Returns:
Number of samples or 0 if unknown


Member Data Documentation

bool converter
 

If this is a valid candidate for conversion

int frameSize
 

Frame size in octets/frame, 0 for non-framed formats

int frameTime
 

Frame time in microseconds, 0 for variable

const char* name
 

Standard no-blanks lowercase format name

int numChannels
 

Number of channels, typically 1

int sampleRate
 

Rate in samples/second (audio) or 1e-6 frames/second (video), 0 for unknown

const char* type
 

Format type: "audio", "video", "text"


The documentation for this struct was generated from the following file:
Generated on Fri Jul 7 03:11:38 2006 for Yate by  doxygen 1.4.4