SFXFMODVoice

Inheritance diagram for SFXFMODVoice ↕

Protected Types

enum

ESettings {
  SET_MinMaxDistance = BIT( 0 )
  SET_Velocity = BIT( 1 )
  SET_Transform = BIT( 2 )
  SET_Volume = BIT( 3 )
  SET_Pitch = BIT( 4 )
  SET_Cone = BIT( 5 )
  SET_Priority = BIT( 6 )
  SET_Reverb = BIT( 7 )
}

Private Types

SFXVoice

Parent

Public Friends

class

SFXFMODBuffer

Protected Attributes

FMOD_CHANNEL *

mChannel

F32

mConeInnerAngle

F32

mConeOuterAngle

F32

mConeOuterVolume

SFXFMODDevice *

mDevice

FMOD_VECTOR

mDirection

F32

mFrequency

F32

mMaxDistance

F32

mMinDistance

FMOD_MODE

mMode

FMOD_VECTOR

mPosition

F32

mPriority

FMOD_REVERB_CHANNELPROPERTIES

mReverb

BitSet32

mSetFlags

FMOD_VECTOR

mVelocity

F32

mVolume

Protected Functions

SFXFMODVoice(SFXFMODDevice * device, SFXFMODBuffer * buffer)

bool

_assignChannel()

SFXFMODBuffer *

_getBuffer()

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

SFXFMODVoice *

create(SFXFMODDevice * device, SFXFMODBuffer * buffer)

Public Functions

~SFXFMODVoice()

bool

isVirtual()

Returns true if the voice is virtualized on the device.

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

setPriority(F32 priority)

Set the priority of this voice.

void

setReverb(const SFXSoundReverbProperties & reverb)

Set the reverb properties for playback of this sound.

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

Protected Types

ESettings

Enumerator

SET_MinMaxDistance = BIT( 0 )
SET_Velocity = BIT( 1 )
SET_Transform = BIT( 2 )
SET_Volume = BIT( 3 )
SET_Pitch = BIT( 4 )
SET_Cone = BIT( 5 )
SET_Priority = BIT( 6 )
SET_Reverb = BIT( 7 )

Private Types

typedef SFXVoice Parent

Public Friends

Protected Attributes

FMOD_CHANNEL * mChannel

F32 mConeInnerAngle

F32 mConeOuterAngle

F32 mConeOuterVolume

SFXFMODDevice * mDevice

FMOD_VECTOR mDirection

F32 mFrequency

F32 mMaxDistance

F32 mMinDistance

FMOD_MODE mMode

FMOD_VECTOR mPosition

F32 mPriority

FMOD_REVERB_CHANNELPROPERTIES mReverb

BitSet32 mSetFlags

FMOD_VECTOR mVelocity

F32 mVolume

Protected Functions

SFXFMODVoice(SFXFMODDevice * device, SFXFMODBuffer * buffer)

_assignChannel()

_getBuffer()

_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(SFXFMODDevice * device, SFXFMODBuffer * buffer)

Public Functions

~SFXFMODVoice()

isVirtual()

Reimplemented from: SFXVoice

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

setPriority(F32 priority)

Reimplemented from: SFXVoice

setReverb(const SFXSoundReverbProperties & reverb)

Reimplemented from: SFXVoice

setTransform(const MatrixF & transform)

Reimplemented from: SFXVoice

setVelocity(const VectorF & velocity)

Reimplemented from: SFXVoice

setVolume(F32 volume)

Reimplemented from: SFXVoice