CascadeAudioCodec Class Reference

base class of audio codecs More...

#include <cascade/av/CascadeAudioCodec.h>

Inheritance diagram for CascadeAudioCodec:

List of all members.

Public Types
enum	SamplePolarity { kSigned = 0, kUnsigned = 1 }
enum	SampleEndianness { kLittleEndian = 0, kBigEndian = 1 }
enum	SampleOrder { kLeftRight = 0, kRightLeft = 1 }
Public Member Functions
	CascadeAudioCodec ()
virtual	~CascadeAudioCodec ()
virtual CascadeStream *	GetOutputStream ()
virtual u64	GetSize ()
virtual u64	GetPosition ()
virtual bool	SeekToPosition (u64 nPosition)
virtual u32	GetSampleRate ()=0
virtual u32	GetNumChannels ()=0
virtual u32	GetBitsPerSample ()=0
virtual u32	GetDurationInMilliseconds ()=0
virtual SamplePolarity	GetSamplePolarity ()=0
virtual SampleEndianness	GetSampleEndianness ()=0
virtual SampleOrder	GetSampleOrder ()=0

---

Detailed Description

base class of audio codecs

Skip the description

CascadeAudioCodec is the base class of simple stream based audio codecs.

---

class CascadeAudioCodec

---

Member Enumeration Documentation

enum CascadeAudioCodec::SampleEndianness

Enumeration values: kLittleEndian  kBigEndian

enum CascadeAudioCodec::SampleOrder

Enumeration values: kLeftRight  kRightLeft

enum CascadeAudioCodec::SamplePolarity

Enumeration values: kSigned  kUnsigned

---

Constructor & Destructor Documentation

CascadeAudioCodec::CascadeAudioCodec (   )

constructor This constructor is light weight.

virtual CascadeAudioCodec::~CascadeAudioCodec (   )  [virtual]

destructor This destructor is light weight.

---

Member Function Documentation

virtual u32 CascadeAudioCodec::GetBitsPerSample (   )  [pure virtual]

virtual u32 CascadeAudioCodec::GetDurationInMilliseconds (   )  [pure virtual]

virtual u32 CascadeAudioCodec::GetNumChannels (   )  [pure virtual]

virtual CascadeStream* CascadeAudioCodec::GetOutputStream (   )  [inline, virtual]

returns the output stream instance Call this function to get the output stream for the codec. You may then use this stream to pull data from the codec. Returns: the output stream to pull data from or NULL on error Implements CascadeCodec.

virtual u64 CascadeAudioCodec::GetPosition (   )  [inline, virtual]

returns the current position in the stream Returns the current position in the stream. Returns: the current position in the stream Implements CascadeStream.

virtual SampleEndianness CascadeAudioCodec::GetSampleEndianness (   )  [pure virtual]

virtual SampleOrder CascadeAudioCodec::GetSampleOrder (   )  [pure virtual]

virtual SamplePolarity CascadeAudioCodec::GetSamplePolarity (   )  [pure virtual]

virtual u32 CascadeAudioCodec::GetSampleRate (   )  [pure virtual]

virtual u64 CascadeAudioCodec::GetSize (   )  [inline, virtual]

returns the output stream instance (this) Each audio codec is also a CascadeStream so the default implementation of GetOutputStream() for audio codecs returns this. Returns: the output stream to pull data from Implements CascadeStream.

virtual bool CascadeAudioCodec::SeekToPosition (  u64  nPosition  )  [inline, virtual]

seeks to a position in the stream SeekToPositions seeks to a byte position in the stream. Returns: whether or not the seek succeeded Implements CascadeStream.

---

The documentation for this class was generated from the following file:

• CascadeAudioCodec.h

---