audiere::OutputStream Class Reference

#include <audiere.h>

Inheritance diagram for audiere::OutputStream:

[legend]Collaboration diagram for audiere::OutputStream:

[legend]List of all members.

Public Member Functions
virtual void	play ()=0
virtual void	stop ()=0
virtual bool	isPlaying ()=0
virtual void	reset ()=0
virtual void	setRepeat (bool repeat)=0
virtual bool	getRepeat ()=0
virtual void	setVolume (float volume)=0
virtual float	getVolume ()=0
virtual void	setPan (float pan)=0
virtual float	getPan ()=0
virtual void	setPitchShift (float shift)=0
virtual float	getPitchShift ()=0
virtual bool	isSeekable ()=0
virtual int	getLength ()=0
virtual void	setPosition (int position)=0
virtual int	getPosition ()=0
Protected Member Functions
	~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 478 of file audiere.h.

---

Constructor & Destructor Documentation

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

Definition at line 480 of file audiere.h.

---

Member Function Documentation

virtual int 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, and audiere::NullOutputStream.

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

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

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

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

virtual int 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, and audiere::NullOutputStream.

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

Returns: true if the stream is repeating Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, and audiere::NullOutputStream.

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

Gets the current volume. Returns: current volume of the output stream Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, and audiere::NullOutputStream.

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

Returns: true if the output stream is playing, false otherwise Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, and audiere::NullOutputStream.

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

Returns: true if the stream is seekable, false otherwise Implemented in audiere::DSOutputBuffer, audiere::DSOutputStream, audiere::MixerStream, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

virtual void 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, and audiere::NullOutputStream.

---

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

• audiere.h

---