Resonance Audio Wwise Plugin Reference

WwiseResonanceAudio Class Reference

WwiseResonanceAudio

This is the main Resonance Audio class that communicates with the Wwise Unity integration.

Summary

Native functions of the system can only be called through this class to preserve the internal system functionality.

Public attributes
maxGainDb = 24.0f
const float
Maximum allowed gain value in decibels.
maxReflectivity = 2.0f
const float
Maximum allowed reflectivity multiplier of a room surface material.
maxReverbBrightness = 1.0f
const float
Maximum allowed reverb brightness modifier value.
maxReverbTime = 3.0f
const float
Maximum allowed reverb time modifier value.
minGainDb = -24.0f
const float
Minimum allowed gain value in decibels.
minReverbBrightness = -1.0f
const float
Minimum allowed reverb brightness modifier value.

Public static attributes
roomEffectsBusName = "Room Effects Bus"
string
Name of the Wwise Audio Bus where the Resonance Audio Room Effects plug-in is attached to.

Public static functions
IsListenerInsideRoom(WwiseResonanceAudioRoom room)
bool
Returns whether the listener is currently inside the given |room| boundaries.
UpdateAudioRoom(WwiseResonanceAudioRoom room, bool roomEnabled)
void
Updates the room effects of the environment with given |room| properties.

Public attributes

maxGainDb

const float maxGainDb = 24.0f

Maximum allowed gain value in decibels.

maxReflectivity

const float maxReflectivity = 2.0f

Maximum allowed reflectivity multiplier of a room surface material.

maxReverbBrightness

const float maxReverbBrightness = 1.0f

Maximum allowed reverb brightness modifier value.

maxReverbTime

const float maxReverbTime = 3.0f

Maximum allowed reverb time modifier value.

minGainDb

const float minGainDb = -24.0f

Minimum allowed gain value in decibels.

minReverbBrightness

const float minReverbBrightness = -1.0f

Minimum allowed reverb brightness modifier value.

Public static attributes

roomEffectsBusName

string roomEffectsBusName = "Room Effects Bus"

Name of the Wwise Audio Bus where the Resonance Audio Room Effects plug-in is attached to.

Public static functions

IsListenerInsideRoom

bool IsListenerInsideRoom(
  WwiseResonanceAudioRoom room
)

Returns whether the listener is currently inside the given |room| boundaries.

UpdateAudioRoom

void UpdateAudioRoom(
  WwiseResonanceAudioRoom room,
  bool roomEnabled
)

Updates the room effects of the environment with given |room| properties.

Note:This should only be called from the main Unity thread.