audiere::NullAudioDevice Class Reference

#include <device_null.h>

Inheritance diagram for audiere::NullAudioDevice:

[legend]Collaboration diagram for audiere::NullAudioDevice:

[legend]List of all members.

Public Member Functions
void	update ()
OutputStream *	openStream (SampleSource *source)
OutputStream *	openBuffer (void *samples, int frame_count, int channel_count, int sample_rate, SampleFormat sample_format)
const char *	getName ()
Static Public Member Functions
static NullAudioDevice *	create (const ParameterList &parameters)
Friends
class	NullOutputStream

---

Detailed Description

Definition at line 18 of file device_null.h.

---

Member Function Documentation

NullAudioDevice * audiere::NullAudioDevice::create (  const ParameterList &  parameters  )  [static]

Definition at line 16 of file device_null.cpp.

const char * audiere::NullAudioDevice::getName (   )  [virtual]

Gets the name of the audio device. For example "directsound" or "oss". Returns: name of audio device Implements audiere::AudioDevice. Definition at line 78 of file device_null.cpp.

OutputStream * audiere::NullAudioDevice::openBuffer (  void *  samples, int  frame_count, int  channel_count, int  sample_rate, SampleFormat  sample_format )  [virtual]

Open a single buffer with the specified PCM data. This is sometimes more efficient than streaming and works on a larger variety of audio devices. In some implementations, this may download the audio data to the sound card's memory itself. Parameters: samples  Buffer containing sample data. openBuffer() does not take ownership of the memory. The application is responsible for freeing it. There must be at least |frame_count * channel_count * GetSampleSize(sample_format)| bytes in the buffer. frame_count  Number of frames in the buffer. channel_count  Number of audio channels. 1 = mono, 2 = stereo. sample_rate  Number of samples per second. sample_format  Format of samples in buffer. Returns: new output stream if successful, 0 if failure Implements audiere::AudioDevice. Definition at line 64 of file device_null.cpp. References ADR_GUARD, audiere::RefPtr< T >::get(), audiere::OpenBufferStream(), and openStream().

OutputStream * audiere::NullAudioDevice::openStream (  SampleSource *  source  )  [virtual]

Open an output stream with a given sample source. If the sample source ever runs out of data, the output stream automatically stops itself. The output stream takes ownership of the sample source, even if opening the output stream fails (in which case the source is immediately deleted). Parameters: source  the source used to feed the output stream with samples Returns: new output stream if successful, 0 if failure Implements audiere::AudioDevice. Definition at line 48 of file device_null.cpp. References ADR_GUARD, NullOutputStream, and SYNCHRONIZED. Referenced by openBuffer().

void audiere::NullAudioDevice::update (   )  [virtual]

Tell the device to do any internal state updates. Some devices update on an internal thread. If that is the case, this method does nothing. Implements audiere::AudioDevice. Definition at line 34 of file device_null.cpp. References ADR_GUARD, and SYNCHRONIZED.

---

Friends And Related Function Documentation

friend class NullOutputStream [friend]

Definition at line 40 of file device_null.h. Referenced by openStream().

---

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

• device_null.h
• device_null.cpp

---