Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

audiere::DSOutputBuffer Class Reference

#include <device_ds_buffer.h>

Inheritance diagram for audiere::DSOutputBuffer:

[legend]Collaboration diagram for audiere::DSOutputBuffer:

[legend]List of all members.


Public Methods
	DSOutputBuffer (DSAudioDevice device, IDirectSoundBuffer buffer, int length, int frame_size)
	~DSOutputBuffer ()
void ADR_CALL	play ()
void ADR_CALL	stop ()
bool ADR_CALL	isPlaying ()
void ADR_CALL	reset ()
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 ()

Constructor & Destructor Documentation

audiere::DSOutputBuffer::DSOutputBuffer ( DSAudioDevice * device,

IDirectSoundBuffer * buffer,

int length,

int frame_size

)

Definition at line 7 of file device_ds_buffer.cpp.

audiere::DSOutputBuffer::~DSOutputBuffer ( )

Definition at line 28 of file device_ds_buffer.cpp.

Member Function Documentation

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

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

Implements audiere::OutputStream.
Definition at line 122 of file device_ds_buffer.cpp.

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

Get current pan.
Implements audiere::OutputStream.
Definition at line 96 of file device_ds_buffer.cpp.

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

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

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

Returns the current position within the sample source.

Returns :
current position in frames

Implements audiere::OutputStream.
Definition at line 134 of file device_ds_buffer.cpp.
References play().

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

Returns :
true if the stream is repeating

Implements audiere::OutputStream.
Definition at line 70 of file device_ds_buffer.cpp.

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

Gets the current volume.

Returns :
current volume of the output stream

Implements audiere::OutputStream.
Definition at line 83 of file device_ds_buffer.cpp.

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

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

Implements audiere::OutputStream.
Definition at line 46 of file device_ds_buffer.cpp.
Referenced by setRepeat().

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

Returns :
true if the stream is seekable, false otherwise

Implements audiere::OutputStream.
Definition at line 116 of file device_ds_buffer.cpp.

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

Start playback of the output stream. If the stream is already playing, this does nothing.
Implements audiere::OutputStream.
Definition at line 34 of file device_ds_buffer.cpp.
Referenced by getPosition(), and setRepeat().

void audiere::DSOutputBuffer::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 54 of file device_ds_buffer.cpp.
References setPosition().

void audiere::DSOutputBuffer::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 89 of file device_ds_buffer.cpp.

void audiere::DSOutputBuffer::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 102 of file device_ds_buffer.cpp.

void audiere::DSOutputBuffer::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 128 of file device_ds_buffer.cpp.
Referenced by reset().

void audiere::DSOutputBuffer::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 60 of file device_ds_buffer.cpp.
References isPlaying(), and play().

void audiere::DSOutputBuffer::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 76 of file device_ds_buffer.cpp.

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

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

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

Generated on Sat Oct 12 01:43:57 2002 for audiere by

1.2.17

audiere::DSOutputBuffer Class Reference

Public Methods

Constructor & Destructor Documentation

Member Function Documentation