Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8

◆ SetMultiplePositions() [1/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetMultiplePositions ( AkGameObjectID  in_GameObjectID,
const AkChannelEmitter *  in_pPositions,
AkUInt16  in_NumPositions,
MultiPositionType  in_eMultiPositionType = MultiPositionType_MultiDirections,
AkSetPositionFlags  in_eFlags = AkSetPositionFlags_Default 
)

Sets multiple positions to a single game object, with flexible assignment of input channels. Setting multiple positions on a single game object is a way to simulate multiple emission sources while using the resources of only one voice. This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area.

Note: Calling AK::SoundEngine::SetMultiplePositions() with only one position is the same as calling AK::SoundEngine::SetPosition()
Returns
  • AK_Success when successful
  • AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
  • AK_InvalidParameter if parameters are not valid.
See also
Parameters
in_GameObjectIDGame Object identifier.
in_pPositionsArray of positions to apply, each using its own channel mask.
in_NumPositionsNumber of positions specified in the provided array.
in_eMultiPositionTypeAK::SoundEngine::MultiPositionType
in_eFlagsOptional flags to independently set the position of the emitter or listener component.

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