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 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

int dataRate (  )  const

Get the data rate in bytes/s

Returns:
Data rate or 0 if variable/undefined


Member Data Documentation

const char* name

Standard no-blanks lowercase format name

const char* type

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

int frameSize

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

int frameTime

Frame time in microseconds, 0 for variable

int sampleRate

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

int numChannels

Number of channels, typically 1

bool converter

If this is a valid candidate for conversion


The documentation for this struct was generated from the following file:
Generated on Mon Oct 22 07:43:09 2007 for Yate by  doxygen 1.5.2