FMODUnityResonance.FmodResonanceAudio Class Reference

Detailed Description

This is the main Resonance Audio class that communicates with the FMOD Unity integration. Native functions of the system can only be called through this class to preserve the internal system functionality.

Classes
struct	RoomProperties

Static Public Member Functions
static void	UpdateAudioRoom (FmodResonanceAudioRoom room, bool roomEnabled)
static bool	IsListenerInsideRoom (FmodResonanceAudioRoom room)
	Returns whether the listener is currently inside the given |room| boundaries.

Static Public Attributes
const float	MaxGainDb = 24.0f
	Maximum allowed gain value in decibels.
const float	MinGainDb = -24.0f
	Minimum allowed gain value in decibels.
const float	MaxReverbBrightness = 1.0f
	Maximum allowed reverb brightness modifier value.
const float	MinReverbBrightness = -1.0f
	Minimum allowed reverb brightness modifier value.
const float	MaxReverbTime = 3.0f
	Maximum allowed reverb time modifier value.
const float	MaxReflectivity = 2.0f
	Maximum allowed reflectivity multiplier of a room surface material.

Properties
static FMOD.DSP	ListenerPlugin [get]

Static Private Member Functions
static float	ConvertAmplitudeFromDb (float db)
static void	ConvertAudioTransformFromUnity (ref Vector3 position, ref Quaternion rotation)
static byte[]	GetBytes (IntPtr ptr, int length)
static RoomProperties	GetRoomProperties (FmodResonanceAudioRoom room)
static FMOD.DSP	Initialize ()

Static Private Attributes
static readonly Matrix4x4	flipZ = Matrix4x4.Scale(new Vector3(1, 1, -1))
static readonly string	listenerPluginName = "Resonance Audio Listener"
static readonly int	roomPropertiesSize = Marshal.SizeOf<RoomProperties>()
static readonly int	roomPropertiesIndex = 1
static Bounds	bounds = new Bounds(Vector3.zero, Vector3.zero)
static List< FmodResonanceAudioRoom >	enabledRooms = new List<FmodResonanceAudioRoom>()
static FMOD.VECTOR	listenerPositionFmod = new FMOD.VECTOR()
static FMOD.DSP	listenerPlugin

Member Function Documentation

ConvertAmplitudeFromDb()

static float FMODUnityResonance.FmodResonanceAudio.ConvertAmplitudeFromDb ( float db )

staticprivate

ConvertAudioTransformFromUnity()

static void FMODUnityResonance.FmodResonanceAudio.ConvertAudioTransformFromUnity ( ref Vector3 position, ref Quaternion rotation )

staticprivate

GetBytes()

static byte[] FMODUnityResonance.FmodResonanceAudio.GetBytes ( IntPtr ptr, int length )

staticprivate

GetRoomProperties()

static RoomProperties FMODUnityResonance.FmodResonanceAudio.GetRoomProperties ( FmodResonanceAudioRoom room )

staticprivate

Initialize()

static FMOD.DSP FMODUnityResonance.FmodResonanceAudio.Initialize ( )

staticprivate

IsListenerInsideRoom()

static bool FMODUnityResonance.FmodResonanceAudio.IsListenerInsideRoom ( FmodResonanceAudioRoom room )

static

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

UpdateAudioRoom()

static void FMODUnityResonance.FmodResonanceAudio.UpdateAudioRoom ( FmodResonanceAudioRoom room, bool roomEnabled )

static

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

Note

This should only be called from the main Unity thread.

Member Data Documentation

bounds

Bounds FMODUnityResonance.FmodResonanceAudio.bounds = new Bounds(Vector3.zero, Vector3.zero)

staticprivate

enabledRooms

List<FmodResonanceAudioRoom> FMODUnityResonance.FmodResonanceAudio.enabledRooms = new List<FmodResonanceAudioRoom>()

staticprivate

flipZ

readonly Matrix4x4 FMODUnityResonance.FmodResonanceAudio.flipZ = Matrix4x4.Scale(new Vector3(1, 1, -1))

staticprivate

listenerPlugin

FMOD.DSP FMODUnityResonance.FmodResonanceAudio.listenerPlugin

staticprivate

listenerPluginName

readonly string FMODUnityResonance.FmodResonanceAudio.listenerPluginName = "Resonance Audio Listener"

staticprivate

listenerPositionFmod

FMOD.VECTOR FMODUnityResonance.FmodResonanceAudio.listenerPositionFmod = new FMOD.VECTOR()

staticprivate

MaxGainDb

const float FMODUnityResonance.FmodResonanceAudio.MaxGainDb = 24.0f

static

Maximum allowed gain value in decibels.

MaxReflectivity

const float FMODUnityResonance.FmodResonanceAudio.MaxReflectivity = 2.0f

static

Maximum allowed reflectivity multiplier of a room surface material.

MaxReverbBrightness

const float FMODUnityResonance.FmodResonanceAudio.MaxReverbBrightness = 1.0f

static

Maximum allowed reverb brightness modifier value.

MaxReverbTime

const float FMODUnityResonance.FmodResonanceAudio.MaxReverbTime = 3.0f

static

Maximum allowed reverb time modifier value.

MinGainDb

const float FMODUnityResonance.FmodResonanceAudio.MinGainDb = -24.0f

static

Minimum allowed gain value in decibels.

MinReverbBrightness

const float FMODUnityResonance.FmodResonanceAudio.MinReverbBrightness = -1.0f

static

Minimum allowed reverb brightness modifier value.

roomPropertiesIndex

readonly int FMODUnityResonance.FmodResonanceAudio.roomPropertiesIndex = 1

staticprivate

roomPropertiesSize

readonly int FMODUnityResonance.FmodResonanceAudio.roomPropertiesSize = Marshal.SizeOf<RoomProperties>()

staticprivate

Property Documentation

ListenerPlugin

FMOD.DSP FMODUnityResonance.FmodResonanceAudio.ListenerPlugin

staticgetprivate

---

The documentation for this class was generated from the following file:

• Assets/Plugins/FMOD/addons/ResonanceAudio/Scripts/FmodResonanceAudio.cs