SFXXAudioVoice

Engine/source/sfx/xaudio/sfxXAudioVoice.h

Inheritance diagram for SFXXAudioVoice ↕

Data for Non-Streaming Voices

bool

mNonStreamBufferLoaded

Whether we have loaded our non-streaming data.

XAUDIO2_BUFFER

mNonStreamBuffer

Audio buffer for non-streaming voice.

U32

mNonStreamSampleStartPos

Sample to start playing at when seting up mNonStreamBuffer.

Public Types

SFXVoice

Parent

Public Friends

class

SFXXAudioBuffer

class

SFXXAudioDevice

Protected Attributes

X3DAUDIO_EMITTER

mEmitter

The cached X3DAudio emitter data.

bool

mHasStarted

Whether we have started playback.

bool

mHasStopped

Whether the voice has stopped playing.

bool

mIs3D

Used to know what sounds need positional updates.

bool

mIsLooping

Whether playback is looping.

bool

mIsPlaying

Whether playback is currently running.

CRITICAL_SECTION

mLock

F32

mPitch

Since 3D sounds are pitch shifted for doppler effect we need to track the users base pitch.

S32

mSamplesPlayedOffset

XAudio does not reset the SamplesPlayed count as is stated in the docs.

SFXXAudioDevice *

mXAudioDevice

The device that created us.

IXAudio2SourceVoice *

mXAudioVoice

The XAudio voice.

Protected Functions

SFXXAudioVoice(SFXXAudioBuffer * buffer)

This constructor does not create a valid voice.

void

_flush()

SFXXAudioBuffer *

_getBuffer()

void

_loadNonStreamed()

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.

void STDMETHODCALLTYPE

OnBufferEnd(void * bufferContext)

void STDMETHODCALLTYPE

OnBufferStart(void * bufferContext)

void STDMETHODCALLTYPE

OnLoopEnd(void * bufferContext)

void STDMETHODCALLTYPE

OnStreamEnd()

void STDMETHODCALLTYPE

OnVoiceError(void * bufferContext, HRESULT error)

void STDMETHODCALLTYPE

OnVoiceProcessingPassEnd()

void STDMETHODCALLTYPE

OnVoiceProcessingPassStart()

void STDMETHODCALLTYPE

OnVoiceProcessingPassStart(UINT32 BytesRequired)

Public Static Functions

SFXXAudioVoice *

create(IXAudio2 * xaudio, bool is3D, SFXXAudioBuffer * buffer, SFXXAudioVoice * inVoice)

Public Functions

~SFXXAudioVoice()

const X3DAUDIO_EMITTER &

getEmitter()

bool

is3D()

Is this a 3D positional voice.

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)

Sets the minimum and maximum distances for 3d falloff.

void

setPitch(F32 pitch)

Sets the pitch scale.

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

Data for Non-Streaming Voices

bool mNonStreamBufferLoaded

Whether we have loaded our non-streaming data.

We use an explicit flag here as we really can't rely on XAUDIO2_VOICE_STATE.

XAUDIO2_BUFFER mNonStreamBuffer

Audio buffer for non-streaming voice.

U32 mNonStreamSampleStartPos

Sample to start playing at when seting up mNonStreamBuffer.

Public Types

typedef SFXVoice Parent

Public Friends

Protected Attributes

X3DAUDIO_EMITTER mEmitter

The cached X3DAudio emitter data.

bool mHasStarted

Whether we have started playback.

bool mHasStopped

Whether the voice has stopped playing.

bool mIs3D

Used to know what sounds need positional updates.

bool mIsLooping

Whether playback is looping.

bool mIsPlaying

Whether playback is currently running.

CRITICAL_SECTION mLock

F32 mPitch

Since 3D sounds are pitch shifted for doppler effect we need to track the users base pitch.

S32 mSamplesPlayedOffset

XAudio does not reset the SamplesPlayed count as is stated in the docs.

To work around that, we offset the values reported by XAudio through this field.

SFXXAudioDevice * mXAudioDevice

The device that created us.

IXAudio2SourceVoice * mXAudioVoice

The XAudio voice.

Protected Functions

SFXXAudioVoice(SFXXAudioBuffer * buffer)

This constructor does not create a valid voice.

see:

SFXXAudioVoice::create

_flush()

_getBuffer()

_loadNonStreamed()

_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

OnBufferEnd(void * bufferContext)

OnBufferStart(void * bufferContext)

OnLoopEnd(void * bufferContext)

OnStreamEnd()

OnVoiceError(void * bufferContext, HRESULT error)

OnVoiceProcessingPassEnd()

OnVoiceProcessingPassStart()

Deprecated:

This is only here for compatibility with the March 2008 SDK version of IXAudio2VoiceCallback.

OnVoiceProcessingPassStart(UINT32 BytesRequired)

Public Static Functions

create(IXAudio2 * xaudio, bool is3D, SFXXAudioBuffer * buffer, SFXXAudioVoice * inVoice)

Public Functions

~SFXXAudioVoice()

getEmitter()

is3D()

Is this a 3D positional voice.

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

setTransform(const MatrixF & transform)

Reimplemented from: SFXVoice

setVelocity(const VectorF & velocity)

Reimplemented from: SFXVoice

setVolume(F32 volume)

Reimplemented from: SFXVoice