audiere::DSOutputStream Class Reference

#include <device_ds_stream.h>

Inheritance diagram for audiere::DSOutputStream:

[legend]Collaboration diagram for audiere::DSOutputStream:

[legend]List of all members.

Public Member Functions
	DSOutputStream (DSAudioDevice *device, IDirectSoundBuffer *buffer, int buffer_length, SampleSource *source)
	~DSOutputStream ()
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	DSAudioDevice

---

Detailed Description

Definition at line 17 of file device_ds_stream.h.

---

Constructor & Destructor Documentation

audiere::DSOutputStream::DSOutputStream (  DSAudioDevice *  device, IDirectSoundBuffer *  buffer, int  buffer_length, SampleSource *  source )

Definition at line 8 of file device_ds_stream.cpp. References ADR_GUARD, audiere::GetFrameSize(), setPan(), and setVolume().

audiere::DSOutputStream::~DSOutputStream (   )

Definition at line 46 of file device_ds_stream.cpp. References ADR_GUARD.

---

Member Function Documentation

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

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

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

Get current pan. Implements audiere::OutputStream. Definition at line 124 of file device_ds_stream.cpp.

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

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

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

Returns the current position within the sample source. Returns: current position in frames Implements audiere::OutputStream. Definition at line 185 of file device_ds_stream.cpp. References SYNCHRONIZED.

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

Returns: true if the stream is repeating Implements audiere::OutputStream. Definition at line 97 of file device_ds_stream.cpp. References SYNCHRONIZED.

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

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

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

Returns: true if the output stream is playing, false otherwise Implements audiere::OutputStream. Definition at line 73 of file device_ds_stream.cpp. Referenced by setPosition(), and setRepeat().

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

Returns: true if the stream is seekable, false otherwise Implements audiere::OutputStream. Definition at line 144 of file device_ds_stream.cpp. References SYNCHRONIZED.

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

Start playback of the output stream. If the stream is already playing, this does nothing. Implements audiere::OutputStream. Definition at line 58 of file device_ds_stream.cpp. References ADR_GUARD. Referenced by setPosition().

void audiere::DSOutputStream::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 79 of file device_ds_stream.cpp. References ADR_GUARD, and SYNCHRONIZED.

void audiere::DSOutputStream::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 117 of file device_ds_stream.cpp. References audiere::DSAudioDevice::Pan_AudiereToDirectSound(). Referenced by DSOutputStream().

void audiere::DSOutputStream::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 130 of file device_ds_stream.cpp.

void audiere::DSOutputStream::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 158 of file device_ds_stream.cpp. References isPlaying(), play(), and SYNCHRONIZED.

void audiere::DSOutputStream::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 87 of file device_ds_stream.cpp. References isPlaying(), and SYNCHRONIZED.

void audiere::DSOutputStream::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 104 of file device_ds_stream.cpp. References audiere::DSAudioDevice::Volume_AudiereToDirectSound(). Referenced by DSOutputStream().

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

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

---

Friends And Related Function Documentation

friend class DSAudioDevice [friend]

Definition at line 77 of file device_ds_stream.h.

---

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

• device_ds_stream.h
• device_ds_stream.cpp

---