Version

menu_open
Wwise SDK 2023.1.4

◆ SetGameObjectOutputBusVolume()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetGameObjectOutputBusVolume ( AkGameObjectID  in_emitterObjID,
AkGameObjectID  in_listenerObjID,
AkReal32  in_fControlValue 
)

Sets the Output Bus Volume (direct) to be used for the specified game object. The control value is a number ranging from 0.0f to 1.0f. Output Bus Volumes are stored per listener association, so calling this function will override the default set of listeners. The game object in_emitterObjID will now reference its own set of listeners which will be the same as the old set of listeners, but with the new associated gain. Future changes to the default listener set will not be picked up by this game object unless ResetListenersToDefault() is called.

See also
Returns
  • AK_Success when successful
  • AK_InvalidFloatValue if the value specified was NaN or Inf
Parameters
in_emitterObjIDAssociated emitter game object ID
in_listenerObjIDAssociated listener game object ID. Pass AK_INVALID_GAME_OBJECT to set the Output Bus Volume for all connected listeners.
in_fControlValueA multiplier in the range [0.0f:16.0f] ( -∞ dB to +24 dB). A value greater than 1.0f will amplify the sound.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise