audiere::OutputStream Class Reference

#include <audiere.h>

Inheritance diagram for audiere::OutputStream:

[legend]Collaboration diagram for audiere::OutputStream:

Detailed Description

A connection to an audio device. Multiple output streams are mixed by the audio device to produce the final waveform that the user hears.

Each output stream can be independently played and stopped. They also each have a volume from 0.0 (silence) to 1.0 (maximum volume).

Definition at line 300 of file audiere.h.

audiere::OutputStream::~OutputStream ( ) [inline, protected]

Definition at line 302 of file audiere.h.

virtual int ADR_CALL audiere::OutputStream::getLength ( ) [pure virtual]

Returns :
number of frames in the stream, or 0 if the stream is not seekable

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual float ADR_CALL audiere::OutputStream::getPan ( ) [pure virtual]

Get current pan.
Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual float ADR_CALL audiere::OutputStream::getPitchShift ( ) [pure virtual]

Get current pitch shift. Defaults to 1.0.
Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual int ADR_CALL audiere::OutputStream::getPosition ( ) [pure virtual]

Returns the current position within the sample source.

Returns :
current position in frames

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual bool ADR_CALL audiere::OutputStream::getRepeat ( ) [pure virtual]

Returns :
true if the stream is repeating

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual float ADR_CALL audiere::OutputStream::getVolume ( ) [pure virtual]

Gets the current volume.

Returns :
current volume of the output stream

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual bool ADR_CALL audiere::OutputStream::isPlaying ( ) [pure virtual]

Returns :
true if the output stream is playing, false otherwise

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual bool ADR_CALL audiere::OutputStream::isSeekable ( ) [pure virtual]

Returns :
true if the stream is seekable, false otherwise

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::play ( ) [pure virtual]

Start playback of the output stream. If the stream is already playing, this does nothing.
Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.
Referenced by audiere::MultipleSoundEffect::play().

virtual void ADR_CALL audiere::OutputStream::reset ( ) [pure 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.
Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::setPan ( float pan ) [pure virtual]

Set current pan.
Parameters:

pan -1.0 = left, 0.0 = center (default), 1.0 = right

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::setPitchShift ( float shift ) [pure virtual]

Set current pitch shift.
Parameters:

shift can range from 0.5 to 2.0. default is 1.0.

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::setPosition ( int position ) [pure 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

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::setRepeat ( bool repeat ) [pure virtual]

Set whether the output stream should repeat.
Parameters:

repeat true if the stream should repeat, false otherwise

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::setVolume ( float volume ) [pure virtual]

Sets the stream's volume.
Parameters:

volume 0.0 = silence, 1.0 = maximum volume (default)

Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

virtual void ADR_CALL audiere::OutputStream::stop ( ) [pure virtual]

Stop playback of the output stream. If the stream is already stopped, this does nothing.
Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, audiere::NullOutputStream, and audiere::OALOutputStream.

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

Generated on Sat Oct 12 01:44:19 2002 for audiere by

1.2.17