SFXALVoice

Inheritance diagram for SFXALVoice ↕

Public Types

SFXVoice

Parent

Public Friends

class

SFXALBuffer

class

SFXALDevice

Protected Attributes

Mutex

mMutex

const OPENALFNTABLE &

mOpenAL

F32

mResumeAtSampleOffset

Buggy OAL jumps around when pausing. Save playback cursor here.

U32

mSampleOffset

Amount by which OAL's reported sample position is offset.

ALuint

mSourceName

Protected Functions

SFXALVoice(const OPENALFNTABLE & oalft, SFXALBuffer * buffer, ALuint sourceName)

SFXALBuffer *

_getBuffer()

void

_lateBindStaticBufferIfNecessary()

For non-streaming buffers, late-bind the audio buffer to the source as OAL will not accept writes to buffers already bound.

void

_pause()

Pause playback on the device.

void

_play()

Start playback on the device.

void

_seek(U32 sample)

Set the playback cursor on the device.

SFXStatus

_status()

Return the current playback status (playing, paused, or stopped).

void

_stop()

Stop playback on the device.

U32

_tell()

Get the playback cursor on the device.

Public Static Functions

SFXALVoice *

create(SFXALDevice * device, SFXALBuffer * buffer)

Public Functions

~SFXALVoice()

void

play(bool looping)

Starts playback from the current position.

void

setCone(F32 innerAngle, F32 outerAngle, F32 outerVolume)

Set sound cone of a 3D sound.

void

setMinMaxDistance(F32 min, F32 max)

SFXVoice.

void

setPitch(F32 pitch)

Sets the pitch scale.

void

setRolloffFactor(F32 factor)

Set the distance attenuation rolloff factor. Support by device optional.

void

setTransform(const MatrixF & transform)

Sets the position and orientation for a 3d voice.

void

setVelocity(const VectorF & velocity)

Sets the velocity for a 3d voice.

void

setVolume(F32 volume)

Sets the volume.

Detailed Description

Public Types

typedef SFXVoice Parent

Public Friends

Protected Attributes

Mutex mMutex

const OPENALFNTABLE & mOpenAL

F32 mResumeAtSampleOffset

Buggy OAL jumps around when pausing. Save playback cursor here.

U32 mSampleOffset

Amount by which OAL's reported sample position is offset.

OAL's sample position is relative to the current queue state, so we manually need to keep track of how far into the total queue we are.

ALuint mSourceName

Protected Functions

SFXALVoice(const OPENALFNTABLE & oalft, SFXALBuffer * buffer, ALuint sourceName)

_getBuffer()

_lateBindStaticBufferIfNecessary()

For non-streaming buffers, late-bind the audio buffer to the source as OAL will not accept writes to buffers already bound.

_pause()

Reimplemented from: SFXVoice

_play()

Reimplemented from: SFXVoice

_seek(U32 sample)

Reimplemented from: SFXVoice

_status()

Reimplemented from: SFXVoice

_stop()

Reimplemented from: SFXVoice

_tell()

Reimplemented from: SFXVoice

Public Static Functions

create(SFXALDevice * device, SFXALBuffer * buffer)

Public Functions

~SFXALVoice()

play(bool looping)

Reimplemented from: SFXVoice

setCone(F32 innerAngle, F32 outerAngle, F32 outerVolume)

Reimplemented from: SFXVoice

setMinMaxDistance(F32 min, F32 max)

Reimplemented from: SFXVoice

setPitch(F32 pitch)

Reimplemented from: SFXVoice

setRolloffFactor(F32 factor)

Reimplemented from: SFXVoice

setTransform(const MatrixF & transform)

Reimplemented from: SFXVoice

setVelocity(const VectorF & velocity)

Reimplemented from: SFXVoice

setVolume(F32 volume)

Reimplemented from: SFXVoice