|
Wwise SDK 2025.1.0
|
#include <AkCommandTypes.h>
Public Attributes | |
| AkGameObjectID | gameObjectID |
| Game Object ID. More... | |
| AkGameObjectID | distanceProbeID |
| Probe Game Object ID. More... | |
Detailed Description
Use the position of a separate game object for distance calculations for a specified listener. When this command is executed, Wwise calculates distance attenuation and filtering based on the distance between the distance probe Game Object (distanceProbeID) and the emitter Game Object's position. In third-person perspective applications, the distance probe Game Object may be set to the player character's position, and the listener Game Object's position to that of the camera. In this scenario, attenuation is based on the distance between the character and the sound, whereas panning, spatialization, and spread and focus calculations are base on the camera. Both Game Objects, gameObjectID and distanceProbeID must have been previously registered. To clear the distance probe, and revert to using the listener position for distance calculations, set distanceProbeID to AK_INVALID_GAME_OBJECT.
 | Note: If the distance probe Game Object is assigned multiple positions, then the first position is used for distance calculations by the listener. |
This command can fail for the following reasons:
- AK_InvalidParameter:
gameObjectIDis not a valid game object ID. - AK_IDNotFound:
gameObjectIDis not a registered game object ordistanceProbeIDis specified and not a registered game object. - AK_InsufficientMemory: Not enough memory to complete the operation.
- See also
- AkCommand_SetDistanceProbe
Definition at line 538 of file AkCommandTypes.h.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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