API reference
MetaXRAudioNativeInterface Class
Parent class that functions as a scope for all the code that wraps binary interfaces for the Unity, Wwise and FMOD plug-ins.
Properties
Interface
: NativeInterface
[Get] |
The current interface being used by the system.
The first access of this field will trigger a scan for any Meta XR Audio plugin binaries, which are searched for in the following order (taking the first one found and halting any further search):
If none are found, Unity is assumed, but attempting to call any of the functions of the returned NativeInterface class result in undefined behavior.
Signature
NativeInterface MetaXRAudioNativeInterface.Interface |
Inner Interface
NativeInterface Interface
Abstract parent class for all classes that wrap a binary's interface.
Methods
GetRaycastHits
(
points
, normals
, length
)
|
Retrieves the cache of ray cast hits that are being used to estimate the room.
This is useful for debugging/visualization.
Signature
int MetaXRAudioNativeInterface.NativeInterface.GetRaycastHits(Vector3[] points, Vector3[] normals, int length) Parameters points: Vector3 []
Array of 3D positions where rays were found to intersect scene geoemtry. The length of this array will be equal to the size of the cache.
normals: Vector3 []
Array of 3D normal vectors corresponding to the intersections listed in pointslength: int
Corresponding length of the rays that originate at the listener and terminate at the intersections listed in points.
Returns int
Returns an ovrResult indicating success or failure
|
GetRoomDimensions
(
roomDimensions
, reflectionsCoefs
, position
)
|
Get the current dimensions, reflection coefficients and position of the shoebox room.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.NativeInterface.GetRoomDimensions(float[] roomDimensions, float[] reflectionsCoefs, out Vector3 position) Parameters roomDimensions: float []
The dimensions of the shoebox room in meters. [Width, Height, Depth]
reflectionsCoefs: float []
The reflection coefficients of the shoebox room. [Left, Right, Up, Down, Front Back], each being 4-vector of frequency-dependent reflection coefficients from lowest to highest frequency
position: out Vector3
The position of the shoebox room in Unity world space coordinates. [X,Y,Z]
Returns int
Returns an ovrResult indicating success or failure.
|
SetAdvancedBoxRoomParameters
(
width
, height
, depth
, lockToListenerPosition
, position
, wallMaterials
)
|
Set global shoebox room reverberation parameters.
These parameters are used for reverberation/early reflections if SIMPLE_ROOM_MODELING is enabled. If SIMPLE_ROOM_MODELING is disabled, these values can still be specified and will be cached. Upon enabling room modelling, the cached values will be applied.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetAdvancedBoxRoomParameters(float width, float height, float depth, bool lockToListenerPosition, Vector3 position, float[] wallMaterials) Parameters width: float
Dimensions of shoebox room in meters. Should be > 0.
height: floatdepth: floatlockToListenerPosition: bool
If true, room is centered on listener. If false, room center is specified by RoomPosition coordinates
position: Vector3
Desired position of room's origin which is in the center of the room. Ignored if lockToListenerPosition is true.
wallMaterials: float []
Reflection coefficients (in the range of [0.0, 1.0f]) for room materials for each wall. It is a packed array the refletion coefficients for the right, left, ceiling, floor, front and back walls in that order, each wall having 4 frequency-dependent reflection coefficients in order of increasing frequency.
Returns int
ovrResult indicating success (0) or failure (1)
|
SetDynamicRoomInterpSpeed
(
InterpSpeed
)
|
Set the interpolation speed of the dynamic room model.
Higher values will cause the reverb to update more quickly but less smoothly.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetDynamicRoomInterpSpeed(float InterpSpeed) Parameters InterpSpeed: float
The speed with which to interpolate between the old and new dynamic room model. [0, 1.0], Default = 0.9
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomMaxWallDistance
(
MaxWallDistance
)
|
Set the maximum distance a cast ray can travel in a dynamic simulation.
Larger values allows one to simulate larger rooms but unnecessarily increases CPU usage for smaller rooms.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetDynamicRoomMaxWallDistance(float MaxWallDistance) Parameters MaxWallDistance: float
Max distance, in meters, a project ray can travel before being ignored. [0, 250], Default = 50
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomRaysPerSecond
(
RaysPerSecond
)
|
Set the number of dynamic rays cast per second.
More rays mean more accurate and responsive modelling but at the expense of increased CPU usage.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetDynamicRoomRaysPerSecond(int RaysPerSecond) Parameters RaysPerSecond: int
The number of rays cast per second. [0,8192], Default = 256
Returns int
Returns an ovrResult indicating success or failure
|
SetDynamicRoomRaysRayCacheSize
(
RayCacheSize
)
|
Set the size of the cache that holds the history of cast rays.
A larger value will mean reverb parameters are calculated using more rays/samples (and thus the simulation will be more stable) at the expense of making the reverb less responsive to geometry changes and increasing runtime memory usage.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetDynamicRoomRaysRayCacheSize(int RayCacheSize) Parameters RayCacheSize: int
The number of rays held in the cache. [64,8192], Default = 512
Returns int
Returns an ovrResult indicating success or failure.
|
SetEnabled
(
feature
, enabled
)
|
Enable/disable options in the audio context.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetEnabled(int feature, bool enabled) Parameters enabled: bool
If true, enable the specified feature. If false, disable the specified feature.
Returns int
Returns an ovrResult indicating success or failure
|
SetRoomClutterFactor
(
clutterFactor
)
|
Sets the clutter factor for the global room simulation.
This parameter is meant to simulate effect furniture and other objects have on reverberation. Higher values simulate more furniture and other objects in the room and reduce the T60 of the reverberator (moreso in the higher frequencies than the low). Lower values simulate an emptier room.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetRoomClutterFactor(float[] clutterFactor) Parameters clutterFactor: float []
An array of clutter values for each audio band, [0,1]. 0.0 represents an empty room for that frequency and 1.0 is the maximum T60 reduction for that band.
Returns int
Returns an ovrResult indicating success or failure
|
SetSharedReverbWetLevel
(
linearLevel
)
|
Set the level of the global reverb.
Sets the linear gain applied to the output of the reverberation. Lower values effectively make all objects drier.
Signature
int MetaXRAudioNativeInterface.NativeInterface.SetSharedReverbWetLevel(float linearLevel) Parameters linearLevel: float
Linear gain to be applied to the output of the reverberator. In the range of [0,+Inf)
Returns int
ovrResult indicating success (0) or failure (1)
|
Inner Classes
FMODPluginInterface Class
Implements
MetaXRAudioNativeInterface.NativeInterface
Fields
binaryName
: const string |
Name of the binary this interface wraps.
This value can be used in [DllImport(binaryName)] decorators and tells Unity what the binary name is for the FMOD plug-in.
Signature
const string MetaXRAudioNativeInterface.FMODPluginInterface.binaryName |
Methods
GetRaycastHits
(
points
, normals
, length
)
|
Retrieves the cache of ray cast hits that are being used to estimate the room.
This is useful for debugging/visualization.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.GetRaycastHits(Vector3[] points, Vector3[] normals, int length) Parameters points: Vector3 []
Array of 3D positions where rays were found to intersect scene geoemtry. The length of this array will be equal to the size of the cache.
normals: Vector3 []
Array of 3D normal vectors corresponding to the intersections listed in pointslength: int
Corresponding length of the rays that originate at the listener and terminate at the intersections listed in points.
Returns int
Returns an ovrResult indicating success or failure
|
GetRoomDimensions
(
roomDimensions
, reflectionsCoefs
, position
)
|
Get the current dimensions, reflection coefficients and position of the shoebox room.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.GetRoomDimensions(float[] roomDimensions, float[] reflectionsCoefs, out Vector3 position) Parameters roomDimensions: float []
The dimensions of the shoebox room in meters. [Width, Height, Depth]
reflectionsCoefs: float []
The reflection coefficients of the shoebox room. [Left, Right, Up, Down, Front Back], each being 4-vector of frequency-dependent reflection coefficients from lowest to highest frequency
position: out Vector3
The position of the shoebox room in Unity world space coordinates. [X,Y,Z]
Returns int
Returns an ovrResult indicating success or failure.
|
ovrAudio_GetPluginContext
(
context
)
|
Get the handle to the current context, creating one if necessary.
Note that Unity's editor, player, and standalone builds will have different contexts.
Signature
static int MetaXRAudioNativeInterface.FMODPluginInterface.ovrAudio_GetPluginContext(out IntPtr context) Parameters context: out IntPtr
The returned handle to the context.
Returns int
Returns an ovrResult indicating success or failure.
|
SetAdvancedBoxRoomParameters
(
width
, height
, depth
, lockToListenerPosition
, position
, wallMaterials
)
|
Set global shoebox room reverberation parameters.
These parameters are used for reverberation/early reflections if SIMPLE_ROOM_MODELING is enabled. If SIMPLE_ROOM_MODELING is disabled, these values can still be specified and will be cached. Upon enabling room modelling, the cached values will be applied.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetAdvancedBoxRoomParameters(float width, float height, float depth, bool lockToListenerPosition, Vector3 position, float[] wallMaterials) Parameters width: float
Dimensions of shoebox room in meters. Should be > 0.
height: floatdepth: floatlockToListenerPosition: bool
If true, room is centered on listener. If false, room center is specified by RoomPosition coordinates
position: Vector3
Desired position of room's origin which is in the center of the room. Ignored if lockToListenerPosition is true.
wallMaterials: float []
Reflection coefficients (in the range of [0.0, 1.0f]) for room materials for each wall. It is a packed array the refletion coefficients for the right, left, ceiling, floor, front and back walls in that order, each wall having 4 frequency-dependent reflection coefficients in order of increasing frequency.
Returns int
ovrResult indicating success (0) or failure (1)
|
SetDynamicRoomInterpSpeed
(
InterpSpeed
)
|
Set the interpolation speed of the dynamic room model.
Higher values will cause the reverb to update more quickly but less smoothly.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetDynamicRoomInterpSpeed(float InterpSpeed) Parameters InterpSpeed: float
The speed with which to interpolate between the old and new dynamic room model. [0, 1.0], Default = 0.9
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomMaxWallDistance
(
MaxWallDistance
)
|
Set the maximum distance a cast ray can travel in a dynamic simulation.
Larger values allows one to simulate larger rooms but unnecessarily increases CPU usage for smaller rooms.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetDynamicRoomMaxWallDistance(float MaxWallDistance) Parameters MaxWallDistance: float
Max distance, in meters, a project ray can travel before being ignored. [0, 250], Default = 50
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomRaysPerSecond
(
RaysPerSecond
)
|
Set the number of dynamic rays cast per second.
More rays mean more accurate and responsive modelling but at the expense of increased CPU usage.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetDynamicRoomRaysPerSecond(int RaysPerSecond) Parameters RaysPerSecond: int
The number of rays cast per second. [0,8192], Default = 256
Returns int
Returns an ovrResult indicating success or failure
|
SetDynamicRoomRaysRayCacheSize
(
RayCacheSize
)
|
Set the size of the cache that holds the history of cast rays.
A larger value will mean reverb parameters are calculated using more rays/samples (and thus the simulation will be more stable) at the expense of making the reverb less responsive to geometry changes and increasing runtime memory usage.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetDynamicRoomRaysRayCacheSize(int RayCacheSize) Parameters RayCacheSize: int
The number of rays held in the cache. [64,8192], Default = 512
Returns int
Returns an ovrResult indicating success or failure.
|
SetEnabled
(
feature
, enabled
)
|
Enable/disable options in the audio context.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetEnabled(int feature, bool enabled) Parameters enabled: bool
If true, enable the specified feature. If false, disable the specified feature.
Returns int
Returns an ovrResult indicating success or failure
|
SetEnabled
(
feature
, enabled
)
|
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetEnabled(EnableFlag feature, bool enabled) Parameters feature: EnableFlagenabled: boolReturns int |
SetRoomClutterFactor
(
clutterFactor
)
|
Sets the clutter factor for the global room simulation.
This parameter is meant to simulate effect furniture and other objects have on reverberation. Higher values simulate more furniture and other objects in the room and reduce the T60 of the reverberator (moreso in the higher frequencies than the low). Lower values simulate an emptier room.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetRoomClutterFactor(float[] clutterFactor) Parameters clutterFactor: float []
An array of clutter values for each audio band, [0,1]. 0.0 represents an empty room for that frequency and 1.0 is the maximum T60 reduction for that band.
Returns int
Returns an ovrResult indicating success or failure
|
SetSharedReverbWetLevel
(
linearLevel
)
|
Set the level of the global reverb.
Sets the linear gain applied to the output of the reverberation. Lower values effectively make all objects drier.
Signature
int MetaXRAudioNativeInterface.FMODPluginInterface.SetSharedReverbWetLevel(float linearLevel) Parameters linearLevel: float
Linear gain to be applied to the output of the reverberator. In the range of [0,+Inf)
Returns int
ovrResult indicating success (0) or failure (1)
|
UnityNativeInterface Class
Implements
MetaXRAudioNativeInterface.NativeInterface
Fields
binaryName
: const string |
Name of the binary this interface wraps.
This value can be used in [DllImport(binaryName)] decorators and tells Unity what the binary name is for the Unity plug-in.
Signature
const string MetaXRAudioNativeInterface.UnityNativeInterface.binaryName |
Methods
GetRaycastHits
(
points
, normals
, length
)
|
Retrieves the cache of ray cast hits that are being used to estimate the room.
This is useful for debugging/visualization.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.GetRaycastHits(Vector3[] points, Vector3[] normals, int length) Parameters points: Vector3 []
Array of 3D positions where rays were found to intersect scene geoemtry. The length of this array will be equal to the size of the cache.
normals: Vector3 []
Array of 3D normal vectors corresponding to the intersections listed in pointslength: int
Corresponding length of the rays that originate at the listener and terminate at the intersections listed in points.
Returns int
Returns an ovrResult indicating success or failure
|
GetRoomDimensions
(
roomDimensions
, reflectionsCoefs
, position
)
|
Get the current dimensions, reflection coefficients and position of the shoebox room.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.GetRoomDimensions(float[] roomDimensions, float[] reflectionsCoefs, out Vector3 position) Parameters roomDimensions: float []
The dimensions of the shoebox room in meters. [Width, Height, Depth]
reflectionsCoefs: float []
The reflection coefficients of the shoebox room. [Left, Right, Up, Down, Front Back], each being 4-vector of frequency-dependent reflection coefficients from lowest to highest frequency
position: out Vector3
The position of the shoebox room in Unity world space coordinates. [X,Y,Z]
Returns int
Returns an ovrResult indicating success or failure.
|
ovrAudio_GetPluginContext
(
context
)
|
Get the handle to the current context, creating one if necessary.
Note that Unity's editor, player, and standalone builds will have different contexts.
Signature
static int MetaXRAudioNativeInterface.UnityNativeInterface.ovrAudio_GetPluginContext(out IntPtr context) Parameters context: out IntPtr
The returned handle to the context.
Returns int
Returns an ovrResult indicating success or failure.
|
SetAdvancedBoxRoomParameters
(
width
, height
, depth
, lockToListenerPosition
, position
, wallMaterials
)
|
Set global shoebox room reverberation parameters.
These parameters are used for reverberation/early reflections if SIMPLE_ROOM_MODELING is enabled. If SIMPLE_ROOM_MODELING is disabled, these values can still be specified and will be cached. Upon enabling room modelling, the cached values will be applied.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetAdvancedBoxRoomParameters(float width, float height, float depth, bool lockToListenerPosition, Vector3 position, float[] wallMaterials) Parameters width: float
Dimensions of shoebox room in meters. Should be > 0.
height: floatdepth: floatlockToListenerPosition: bool
If true, room is centered on listener. If false, room center is specified by RoomPosition coordinates
position: Vector3
Desired position of room's origin which is in the center of the room. Ignored if lockToListenerPosition is true.
wallMaterials: float []
Reflection coefficients (in the range of [0.0, 1.0f]) for room materials for each wall. It is a packed array the refletion coefficients for the right, left, ceiling, floor, front and back walls in that order, each wall having 4 frequency-dependent reflection coefficients in order of increasing frequency.
Returns int
ovrResult indicating success (0) or failure (1)
|
SetDynamicRoomInterpSpeed
(
InterpSpeed
)
|
Set the interpolation speed of the dynamic room model.
Higher values will cause the reverb to update more quickly but less smoothly.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetDynamicRoomInterpSpeed(float InterpSpeed) Parameters InterpSpeed: float
The speed with which to interpolate between the old and new dynamic room model. [0, 1.0], Default = 0.9
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomMaxWallDistance
(
MaxWallDistance
)
|
Set the maximum distance a cast ray can travel in a dynamic simulation.
Larger values allows one to simulate larger rooms but unnecessarily increases CPU usage for smaller rooms.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetDynamicRoomMaxWallDistance(float MaxWallDistance) Parameters MaxWallDistance: float
Max distance, in meters, a project ray can travel before being ignored. [0, 250], Default = 50
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomRaysPerSecond
(
RaysPerSecond
)
|
Set the number of dynamic rays cast per second.
More rays mean more accurate and responsive modelling but at the expense of increased CPU usage.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetDynamicRoomRaysPerSecond(int RaysPerSecond) Parameters RaysPerSecond: int
The number of rays cast per second. [0,8192], Default = 256
Returns int
Returns an ovrResult indicating success or failure
|
SetDynamicRoomRaysRayCacheSize
(
RayCacheSize
)
|
Set the size of the cache that holds the history of cast rays.
A larger value will mean reverb parameters are calculated using more rays/samples (and thus the simulation will be more stable) at the expense of making the reverb less responsive to geometry changes and increasing runtime memory usage.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetDynamicRoomRaysRayCacheSize(int RayCacheSize) Parameters RayCacheSize: int
The number of rays held in the cache. [64,8192], Default = 512
Returns int
Returns an ovrResult indicating success or failure.
|
SetEnabled
(
feature
, enabled
)
|
Enable/disable options in the audio context.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetEnabled(int feature, bool enabled) Parameters enabled: bool
If true, enable the specified feature. If false, disable the specified feature.
Returns int
Returns an ovrResult indicating success or failure
|
SetEnabled
(
feature
, enabled
)
|
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetEnabled(EnableFlag feature, bool enabled) Parameters feature: EnableFlagenabled: boolReturns int |
SetRoomClutterFactor
(
clutterFactor
)
|
Sets the clutter factor for the global room simulation.
This parameter is meant to simulate effect furniture and other objects have on reverberation. Higher values simulate more furniture and other objects in the room and reduce the T60 of the reverberator (moreso in the higher frequencies than the low). Lower values simulate an emptier room.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetRoomClutterFactor(float[] clutterFactor) Parameters clutterFactor: float []
An array of clutter values for each audio band, [0,1]. 0.0 represents an empty room for that frequency and 1.0 is the maximum T60 reduction for that band.
Returns int
Returns an ovrResult indicating success or failure
|
SetSharedReverbWetLevel
(
linearLevel
)
|
Set the level of the global reverb.
Sets the linear gain applied to the output of the reverberation. Lower values effectively make all objects drier.
Signature
int MetaXRAudioNativeInterface.UnityNativeInterface.SetSharedReverbWetLevel(float linearLevel) Parameters linearLevel: float
Linear gain to be applied to the output of the reverberator. In the range of [0,+Inf)
Returns int
ovrResult indicating success (0) or failure (1)
|
WwisePluginInterface Class
Implements
MetaXRAudioNativeInterface.NativeInterface
Fields
binaryName
: const string |
Name of the binary this interface wraps.
This value can be used in [DllImport(binaryName)] decorators and tells Unity what the binary name is for the Wwise plug-in.
Signature
const string MetaXRAudioNativeInterface.WwisePluginInterface.binaryName |
Methods
getOrCreateGlobalOvrAudioContext
()
|
Get the handle to the current context, creating one if necessary.
Note that Unity's editor, player, and standalone builds will have different contexts.
Signature
static IntPtr MetaXRAudioNativeInterface.WwisePluginInterface.getOrCreateGlobalOvrAudioContext() Returns IntPtr
The returned handle to the context.
|
GetRaycastHits
(
points
, normals
, length
)
|
Retrieves the cache of ray cast hits that are being used to estimate the room.
This is useful for debugging/visualization.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.GetRaycastHits(Vector3[] points, Vector3[] normals, int length) Parameters points: Vector3 []
Array of 3D positions where rays were found to intersect scene geoemtry. The length of this array will be equal to the size of the cache.
normals: Vector3 []
Array of 3D normal vectors corresponding to the intersections listed in pointslength: int
Corresponding length of the rays that originate at the listener and terminate at the intersections listed in points.
Returns int
Returns an ovrResult indicating success or failure
|
GetRoomDimensions
(
roomDimensions
, reflectionsCoefs
, position
)
|
Get the current dimensions, reflection coefficients and position of the shoebox room.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.GetRoomDimensions(float[] roomDimensions, float[] reflectionsCoefs, out Vector3 position) Parameters roomDimensions: float []
The dimensions of the shoebox room in meters. [Width, Height, Depth]
reflectionsCoefs: float []
The reflection coefficients of the shoebox room. [Left, Right, Up, Down, Front Back], each being 4-vector of frequency-dependent reflection coefficients from lowest to highest frequency
position: out Vector3
The position of the shoebox room in Unity world space coordinates. [X,Y,Z]
Returns int
Returns an ovrResult indicating success or failure.
|
SetAdvancedBoxRoomParameters
(
width
, height
, depth
, lockToListenerPosition
, position
, wallMaterials
)
|
Set global shoebox room reverberation parameters.
These parameters are used for reverberation/early reflections if SIMPLE_ROOM_MODELING is enabled. If SIMPLE_ROOM_MODELING is disabled, these values can still be specified and will be cached. Upon enabling room modelling, the cached values will be applied.
Note, it's easiest to the MetaXRAudioRoomAcousticProperties MonoBehavior instead of calling this function directly.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetAdvancedBoxRoomParameters(float width, float height, float depth, bool lockToListenerPosition, Vector3 position, float[] wallMaterials) Parameters width: float
Dimensions of shoebox room in meters. Should be > 0.
height: floatdepth: floatlockToListenerPosition: bool
If true, room is centered on listener. If false, room center is specified by RoomPosition coordinates
position: Vector3
Desired position of room's origin which is in the center of the room. Ignored if lockToListenerPosition is true.
wallMaterials: float []
Reflection coefficients (in the range of [0.0, 1.0f]) for room materials for each wall. It is a packed array the refletion coefficients for the right, left, ceiling, floor, front and back walls in that order, each wall having 4 frequency-dependent reflection coefficients in order of increasing frequency.
Returns int
ovrResult indicating success (0) or failure (1)
|
SetDynamicRoomInterpSpeed
(
InterpSpeed
)
|
Set the interpolation speed of the dynamic room model.
Higher values will cause the reverb to update more quickly but less smoothly.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetDynamicRoomInterpSpeed(float InterpSpeed) Parameters InterpSpeed: float
The speed with which to interpolate between the old and new dynamic room model. [0, 1.0], Default = 0.9
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomMaxWallDistance
(
MaxWallDistance
)
|
Set the maximum distance a cast ray can travel in a dynamic simulation.
Larger values allows one to simulate larger rooms but unnecessarily increases CPU usage for smaller rooms.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetDynamicRoomMaxWallDistance(float MaxWallDistance) Parameters MaxWallDistance: float
Max distance, in meters, a project ray can travel before being ignored. [0, 250], Default = 50
Returns int
Returns an ovrResult indicating success or failure.
|
SetDynamicRoomRaysPerSecond
(
RaysPerSecond
)
|
Set the number of dynamic rays cast per second.
More rays mean more accurate and responsive modelling but at the expense of increased CPU usage.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetDynamicRoomRaysPerSecond(int RaysPerSecond) Parameters RaysPerSecond: int
The number of rays cast per second. [0,8192], Default = 256
Returns int
Returns an ovrResult indicating success or failure
|
SetDynamicRoomRaysRayCacheSize
(
RayCacheSize
)
|
Set the size of the cache that holds the history of cast rays.
A larger value will mean reverb parameters are calculated using more rays/samples (and thus the simulation will be more stable) at the expense of making the reverb less responsive to geometry changes and increasing runtime memory usage.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetDynamicRoomRaysRayCacheSize(int RayCacheSize) Parameters RayCacheSize: int
The number of rays held in the cache. [64,8192], Default = 512
Returns int
Returns an ovrResult indicating success or failure.
|
SetEnabled
(
feature
, enabled
)
|
Enable/disable options in the audio context.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetEnabled(int feature, bool enabled) Parameters enabled: bool
If true, enable the specified feature. If false, disable the specified feature.
Returns int
Returns an ovrResult indicating success or failure
|
SetEnabled
(
feature
, enabled
)
|
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetEnabled(EnableFlag feature, bool enabled) Parameters feature: EnableFlagenabled: boolReturns int |
SetRoomClutterFactor
(
clutterFactor
)
|
Sets the clutter factor for the global room simulation.
This parameter is meant to simulate effect furniture and other objects have on reverberation. Higher values simulate more furniture and other objects in the room and reduce the T60 of the reverberator (moreso in the higher frequencies than the low). Lower values simulate an emptier room.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetRoomClutterFactor(float[] clutterFactor) Parameters clutterFactor: float []
An array of clutter values for each audio band, [0,1]. 0.0 represents an empty room for that frequency and 1.0 is the maximum T60 reduction for that band.
Returns int
Returns an ovrResult indicating success or failure
|
SetSharedReverbWetLevel
(
linearLevel
)
|
Set the level of the global reverb.
Sets the linear gain applied to the output of the reverberation. Lower values effectively make all objects drier.
Signature
int MetaXRAudioNativeInterface.WwisePluginInterface.SetSharedReverbWetLevel(float linearLevel) Parameters linearLevel: float
Linear gain to be applied to the output of the reverberator. In the range of [0,+Inf)
Returns int
ovrResult indicating success (0) or failure (1)
|
Inner Enum
ovrAudioScalarType Enum
Enumeration of all the data types that could be used in the binary's interface.
Enumeration Constants
| Member | Description |
|---|---|
Int8 |
8-bit signed integer [-128, 127]
|
UInt8 |
8-bit unsigned integer [0, 255]
|
Int16 |
16-bit signed integer [-32768, 32767]
|
UInt16 |
16-bit unsigned integer [0, 65535]
|
Int32 |
32-bit signed integer [-2147483648, 21474836]
|
UInt32 |
32-bit unsigned integer [0, 4294967295]
|
Int64 |
64-bit signed integer [-9223372036854775808, 9223372036854775807]
|
UInt64 |
64-bit unsigned integer [0, 184467440737095516]
|
Float16 |
16-bit floating point number with 1 bit sign, 10 bits exponent, and 15 bits mantissa
|
Float32 |
32-bit floating point number with 1 bit sign, 23 bits exponent, and 23 bits mantissa
|
Float64 |
64-bit floating point number with 1 bit sign, 52 bits exponent, and 52 bits mantissa
|
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta