CascadeAudioPlaybackDevice Class Reference

a pure virtual base class for audio playback device driver writers More...

#include <cascade/av/CascadeAudioPlaybackDevice.h>

Inheritance diagram for CascadeAudioPlaybackDevice:

List of all members.

Public Member Functions
	CascadeAudioPlaybackDevice ()
virtual	~CascadeAudioPlaybackDevice ()
virtual bool	GetBufferRequirements (u32 &nMinNumBuffersToSet, u32 &nMaxNumBuffersToSet, u32 &nMinBufferSizeToSet, u32 &nMaxBufferSizeToSet, u32 &nBufferSizeMultipleToSet)=0
virtual bool	GetDefaultBufferRequirements (u32 &nNumBuffersToSet, u32 &nBufferSizeInBytesToSet)=0
virtual bool	Open (u32 nNumBuffers, u32 nBufferSizeInBytes, void **ppBufferLocationsToSet)=0
virtual bool	Close ()=0
virtual bool	QueueBuffer (s16 *pData, u32 nSamples)=0
virtual u32	WaitForBuffer ()=0
virtual bool	GetNumBuffersAvailable (u32 &nNumBuffersAvailableToSet)=0
virtual bool	Pause ()=0
virtual bool	Play ()=0
virtual bool	Flush ()=0
virtual bool	SetVolume (u16 nVolume)=0
virtual bool	SetSampleRate (u32 nSampleRate)=0
virtual u32	GetSampleRate ()=0
virtual bool	IsSupportedSampleRate (u32 nSampleRate)=0
virtual bool	SetOutputFlags (bool bAnalog, bool bSPDIF)=0
virtual void	GetOutputFlags (bool &bAnalogToSet, bool &bSPDIFToSet)=0
Static Public Member Functions
static CascadeAudioPlaybackDevice *	AcquireDefaultAudioPlaybackDevice ()
static void	ReleaseDefaultAudioPlaybackDevice (CascadeAudioPlaybackDevice *pDevice)

---

Detailed Description

a pure virtual base class for audio playback device driver writers

Skip the description

CascadeAudioPlaybackDevice is a pure virtual base class intended for audio playback device driver writers

---

class CascadeAudioPlaybackDevice

---

Constructor & Destructor Documentation

CascadeAudioPlaybackDevice::CascadeAudioPlaybackDevice (   )  [inline]

the default constructor - lightweight This default constructor is lightweight.

virtual CascadeAudioPlaybackDevice::~CascadeAudioPlaybackDevice (   )  [inline, virtual]

destructor The destructor.

---

Member Function Documentation

static CascadeAudioPlaybackDevice* CascadeAudioPlaybackDevice::AcquireDefaultAudioPlaybackDevice (   )  [static]

virtual bool CascadeAudioPlaybackDevice::Close (   )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::Flush (   )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::GetBufferRequirements (  u32 &  nMinNumBuffersToSet, u32 &  nMaxNumBuffersToSet, u32 &  nMinBufferSizeToSet, u32 &  nMaxBufferSizeToSet, u32 &  nBufferSizeMultipleToSet )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::GetDefaultBufferRequirements (  u32 &  nNumBuffersToSet, u32 &  nBufferSizeInBytesToSet )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::GetNumBuffersAvailable (  u32 &  nNumBuffersAvailableToSet  )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual void CascadeAudioPlaybackDevice::GetOutputFlags (  bool &  bAnalogToSet, bool &  bSPDIFToSet )  [pure virtual]

Implemented in PCMAudioPlayer.

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

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::IsSupportedSampleRate (  u32  nSampleRate  )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::Open (  u32  nNumBuffers, u32  nBufferSizeInBytes, void **  ppBufferLocationsToSet )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::Pause (   )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::Play (   )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::QueueBuffer (  s16 *  pData, u32  nSamples )  [pure virtual]

Implemented in PCMAudioPlayer.

static void CascadeAudioPlaybackDevice::ReleaseDefaultAudioPlaybackDevice (  CascadeAudioPlaybackDevice *  pDevice  )  [static]

virtual bool CascadeAudioPlaybackDevice::SetOutputFlags (  bool  bAnalog, bool  bSPDIF )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::SetSampleRate (  u32  nSampleRate  )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual bool CascadeAudioPlaybackDevice::SetVolume (  u16  nVolume  )  [pure virtual]

Implemented in PCMAudioPlayer.

virtual u32 CascadeAudioPlaybackDevice::WaitForBuffer (   )  [pure virtual]

Implemented in PCMAudioPlayer.

---

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

• CascadeAudioPlaybackDevice.h

---