---

audiere::NullOutputStream Class Reference

#include <device_null.h>

Inheritance diagram for audiere::NullOutputStream:

[legend]Collaboration diagram for audiere::NullOutputStream:

[legend]List of all members.

Public Methods
void ADR_CALL	play ()
void ADR_CALL	stop ()
void ADR_CALL	reset ()
bool ADR_CALL	isPlaying ()
void ADR_CALL	setRepeat (bool repeat)
bool ADR_CALL	getRepeat ()
void ADR_CALL	setVolume (float volume)
float ADR_CALL	getVolume ()
void ADR_CALL	setPan (float pan)
float ADR_CALL	getPan ()
void ADR_CALL	setPitchShift (float shift)
float ADR_CALL	getPitchShift ()
bool ADR_CALL	isSeekable ()
int ADR_CALL	getLength ()
void ADR_CALL	setPosition (int position)
int ADR_CALL	getPosition ()
Friends
class	NullAudioDevice

---

Member Function Documentation

int audiere::NullOutputStream::getLength (    )  [virtual]

Returns : number of frames in the stream, or 0 if the stream is not seekable Implements audiere::OutputStream. Definition at line 190 of file device_null.cpp.

float audiere::NullOutputStream::getPan (    )  [virtual]

Get current pan. Implements audiere::OutputStream. Definition at line 166 of file device_null.cpp.

float audiere::NullOutputStream::getPitchShift (    )  [virtual]

Get current pitch shift. Defaults to 1.0. Implements audiere::OutputStream. Definition at line 178 of file device_null.cpp.

int audiere::NullOutputStream::getPosition (    )  [virtual]

Returns the current position within the sample source. Returns : current position in frames Implements audiere::OutputStream. Definition at line 204 of file device_null.cpp.

bool audiere::NullOutputStream::getRepeat (    )  [virtual]

Returns : true if the stream is repeating Implements audiere::OutputStream. Definition at line 141 of file device_null.cpp. References audiere::RefPtr< NullAudioDevice >::get(), and SYNCHRONIZED.

float audiere::NullOutputStream::getVolume (    )  [virtual]

Gets the current volume. Returns : current volume of the output stream Implements audiere::OutputStream. Definition at line 154 of file device_null.cpp.

bool audiere::NullOutputStream::isPlaying (    )  [virtual]

Returns : true if the output stream is playing, false otherwise Implements audiere::OutputStream. Definition at line 128 of file device_null.cpp.

bool audiere::NullOutputStream::isSeekable (    )  [virtual]

Returns : true if the stream is seekable, false otherwise Implements audiere::OutputStream. Definition at line 184 of file device_null.cpp.

void audiere::NullOutputStream::play (    )  [virtual]

Start playback of the output stream. If the stream is already playing, this does nothing. Implements audiere::OutputStream. Definition at line 106 of file device_null.cpp. References ADR_GUARD.

void audiere::NullOutputStream::reset (    )  [virtual]

Reset the sample source or buffer to the beginning. On seekable streams, this operation is equivalent to setPosition(0). On some output streams, this operation can be moderately slow, as up to several seconds of PCM buffer must be refilled. Implements audiere::OutputStream. Definition at line 120 of file device_null.cpp. References audiere::RefPtr< NullAudioDevice >::get(), and SYNCHRONIZED. Referenced by setPosition().

void audiere::NullOutputStream::setPan (  float    pan )  [virtual]

Set current pan. Parameters: pan  -1.0 = left, 0.0 = center (default), 1.0 = right Implements audiere::OutputStream. Definition at line 160 of file device_null.cpp.

void audiere::NullOutputStream::setPitchShift (  float    shift )  [virtual]

Set current pitch shift. Parameters: shift  can range from 0.5 to 2.0. default is 1.0. Implements audiere::OutputStream. Definition at line 172 of file device_null.cpp.

void audiere::NullOutputStream::setPosition (  int    position )  [virtual]

Sets the current position within the sample source. If the stream is not seekable, this method does nothing. Parameters: position  current position in frames Implements audiere::OutputStream. Definition at line 196 of file device_null.cpp. References audiere::RefPtr< NullAudioDevice >::get(), reset(), and SYNCHRONIZED.

void audiere::NullOutputStream::setRepeat (  bool    repeat )  [virtual]

Set whether the output stream should repeat. Parameters: repeat  true if the stream should repeat, false otherwise Implements audiere::OutputStream. Definition at line 134 of file device_null.cpp. References audiere::RefPtr< NullAudioDevice >::get(), and SYNCHRONIZED.

void audiere::NullOutputStream::setVolume (  float    volume )  [virtual]

Sets the stream's volume. Parameters: volume  0.0 = silence, 1.0 = maximum volume (default) Implements audiere::OutputStream. Definition at line 148 of file device_null.cpp.

void audiere::NullOutputStream::stop (    )  [virtual]

Stop playback of the output stream. If the stream is already stopped, this does nothing. Implements audiere::OutputStream. Definition at line 114 of file device_null.cpp.

---

Friends And Related Function Documentation

friend class NullAudioDevice [friend]

Definition at line 90 of file device_null.h.

---

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

• device_null.h
• device_null.cpp

---