---

audiere::OALOutputStream Class Reference

#include <device_oal.h>

Inheritance diagram for audiere::OALOutputStream:

[legend]Collaboration diagram for audiere::OALOutputStream:

[legend]List of all members.

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

---

Member Function Documentation

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

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

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

Get current pan. Implements audiere::OutputStream. Definition at line 373 of file device_oal.cpp.

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

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

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

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

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

Returns : true if the stream is repeating Implements audiere::OutputStream. Definition at line 347 of file device_oal.cpp.

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

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

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

Returns : true if the output stream is playing, false otherwise Implements audiere::OutputStream. Definition at line 320 of file device_oal.cpp. Referenced by reset().

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

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

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

Start playback of the output stream. If the stream is already playing, this does nothing. Implements audiere::OutputStream. Definition at line 306 of file device_oal.cpp. Referenced by reset().

void audiere::OALOutputStream::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 326 of file device_oal.cpp. References isPlaying(), play(), and stop().

void audiere::OALOutputStream::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 367 of file device_oal.cpp.

void audiere::OALOutputStream::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 380 of file device_oal.cpp.

void audiere::OALOutputStream::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 407 of file device_oal.cpp.

void audiere::OALOutputStream::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 341 of file device_oal.cpp.

void audiere::OALOutputStream::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 354 of file device_oal.cpp.

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

Stop playback of the output stream. If the stream is already stopped, this does nothing. Implements audiere::OutputStream. Definition at line 313 of file device_oal.cpp. Referenced by reset().

---

Friends And Related Function Documentation

friend class OALAudioDevice [friend]

Definition at line 100 of file device_oal.h.

---

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

• device_oal.h
• device_oal.cpp

---