API reference

MetaXRAcousticNativeInterface 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 : INativeInterface
[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):
  1. Meta XR Audio Plugin for Wwise
  2. Meta XR Audio Plugin for FMOD
  3. Meta XR Audio Plugin for Unity
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
INativeInterface MetaXRAcousticNativeInterface.Interface

Inner Interface

INativeInterface Interface

Abstract parent class for all classes that wrap a binary's interface.

Methods

AudioGeometryGetSimplifiedMesh ( geometry , vertices , indices , materialIndices )
Get the mesh information that is currently saved to a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryGetSimplifiedMesh(IntPtr geometry, out float[] vertices, out uint[] indices, out uint[] materialIndices)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: out float []  An array of vertices that describe the mesh
indices: out uint []  An array of integers that describe the mesh
materialIndices: out uint []  An array of integers that describe the materials
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryGetTransform ( geometry , matrix4x4 )
Get the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryGetTransform(IntPtr geometry, out float[] matrix4x4)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix4x4: out float []
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshFile ( geometry , filePath )
Read in baked geometry from a .xrageo file into a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryReadMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
filePath: string  A fully qualified path to the .xrageo file that should be read
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshMemory ( geometry , data , dataLength )
Read in geometry data as raw data input stored in an array. This allows alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryReadMeshMemory(IntPtr geometry, IntPtr data, UInt64 dataLength)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetObjectFlag ( geometry , flag , enabled )
Set the properties of a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometrySetObjectFlag(IntPtr geometry, ObjectFlags flag, bool enabled)
Parameters
geometry: IntPtr  A pointer to the geometry object
flag: ObjectFlags  The property about the geometry to be set
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetTransform ( geometry , matrix )
Set the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometrySetTransform(IntPtr geometry, in Matrix4x4 matrix)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix: in Matrix4x4  A 4x4 matrix that contains the transform to apply
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount )
Bake mesh data into a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryUploadMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadSimplifiedMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount , simplification )
Bake mesh data into a geometry object with simplification flags.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryUploadSimplifiedMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount, ref MeshSimplification simplification)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
simplification: ref MeshSimplification  A struct containing flags for mesh simplification
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFile ( geometry , filePath )
Write a geometry object into a .xrageo file.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryWriteMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object to be written
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFileObj ( geometry , filePath )
Save the mesh data of a geometry object into an .obj file.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioGeometryWriteMeshFileObj(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialGetFrequency ( material , property , frequency , value )
Get the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioMaterialGetFrequency(IntPtr material, MaterialProperty property, float frequency, out float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
frequency: float  The frequency to get the value at
value: out float  The returned material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialReset ( material , property )
Remove all the set values for a material property.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioMaterialReset(IntPtr material, MaterialProperty property)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialSetFrequency ( material , property , frequency , value )
Set the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioMaterialSetFrequency(IntPtr material, MaterialProperty property, float frequency, float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to set
frequency: float  The frequency to set the value at
value: float  The desired value of the material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRCompute ( sceneIR , parameters )
Bake an Acoustic Map given particular parameters. It will use automatically generated points.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRCompute(IntPtr sceneIR, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRComputeCustomPoints ( sceneIR , points , pointCount , parameters )
Bake an Acoustic Map given particular parameters. It will use custom points.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRComputeCustomPoints(IntPtr sceneIR, float[] points, UIntPtr pointCount, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of custom points to be used for the baking
pointCount: UIntPtr  The number of points in the points array
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetEnabled ( sceneIR , enabled )
Get whether an Acoustic Map object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRGetEnabled(IntPtr sceneIR, out bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: out bool  bool specifying if the Acoustic Map is be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPointCount ( sceneIR , pointCount )
Get the number of points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRGetPointCount(IntPtr sceneIR, out UIntPtr pointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
pointCount: out UIntPtr  The number of points in the Acoustic Map
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPoints ( sceneIR , points , maxPointCount )
Get the exact points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRGetPoints(IntPtr sceneIR, float[] points, UIntPtr maxPointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of the points used in the Acoustic Map
maxPointCount: UIntPtr  The maximum number of points that can be stored in the points array
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetStatus ( sceneIR , status )
Get the current computation status of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRGetStatus(IntPtr sceneIR, out AcousticMapStatus status)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
status: out AcousticMapStatus  The current computation status of the Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetTransform ( sceneIR , matrix4x4 )
Get the transform currently applied to an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRGetTransform(IntPtr sceneIR, out float[] matrix4x4)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix4x4: out float []  The transform currently applied to the Acoustic Map represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadFile ( sceneIR , filePath )
Read a .xramap file into an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRReadFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path which the .xramap file that should be read from
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadMemory ( sceneIR , data , dataLength )
Read a raw data array into an Acoustic Map object. Allows for alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRReadMemory(IntPtr sceneIR, IntPtr data, UInt64 dataLength)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetEnabled ( sceneIR , enabled )
Set an Acoustic Map object to be enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRSetEnabled(IntPtr sceneIR, bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: bool  bool specifying if the Acoustic Map should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetTransform ( sceneIR , matrix )
Set the transform of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRSetTransform(IntPtr sceneIR, in Matrix4x4 matrix)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRWriteFile ( sceneIR , filePath )
Write an Acoustic Map into a .xramap file.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.AudioSceneIRWriteFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetBox ( control , sizeX , sizeY , sizeZ )
Get the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneGetBox(IntPtr control, out float sizeX, out float sizeY, out float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: out float  The size of the boundary along the x axis
sizeY: out float  The size of the boundary along the y axis
sizeZ: out float  The size of the boundary along the z axis
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetEnabled ( control , enabled )
Get whether a Control Zone object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneGetEnabled(IntPtr control, out bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: out bool  bool specifying if the Control Zone is enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetFadeDistance ( control , fadeX , fadeY , fadeZ )
Get the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneGetFadeDistance(IntPtr control, out float fadeX, out float fadeY, out float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: out float  The amount of fade in the x direction
fadeY: out float  The amount of fade in the y direction
fadeZ: out float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetTransform ( control , matrix4x4 )
Get the transform currently applied to a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneGetTransform(IntPtr control, out float[] matrix4x4)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix4x4: out float []  The transform currently applied to the Control Zone represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneReset ( control , property )
Remove all values set for a particular property of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneReset(IntPtr control, ControlZoneProperty property)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
Returns
int
ControlZoneSetBox ( control , sizeX , sizeY , sizeZ )
Set the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneSetBox(IntPtr control, float sizeX, float sizeY, float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: float  The width of the boundary
sizeY: float  The height of the boundary
sizeZ: float  The depth of the boundary
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetEnabled ( control , enabled )
Enable or Disable Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneSetEnabled(IntPtr control, bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: bool  bool specifying if the Control Zone should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFadeDistance ( control , fadeX , fadeY , fadeZ )
Set the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneSetFadeDistance(IntPtr control, float fadeX, float fadeY, float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: float  The amount of fade in the x direction
fadeY: float  The amount of fade in the y direction
fadeZ: float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFrequency ( control , property , frequency , value )
Set a property of the Control Zone object for a particular frequency.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneSetFrequency(IntPtr control, ControlZoneProperty property, float frequency, float value)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
frequency: float  The frequency to change the property at in Hz
value: float  The new value of the property at frequency
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetTransform ( control , matrix )
Set the transform of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.ControlZoneSetTransform(IntPtr control, in Matrix4x4 matrix)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioGeometry ( geometry )
Create a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.CreateAudioGeometry(out IntPtr geometry)
Parameters
geometry: out IntPtr  A pointer to the created geometry object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioMaterial ( material )
Create a new material object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.CreateAudioMaterial(out IntPtr material)
Parameters
material: out IntPtr  A pointer to the newly created material object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioSceneIR ( sceneIR )
Create a new Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.CreateAudioSceneIR(out IntPtr sceneIR)
Parameters
sceneIR: out IntPtr  A pointer to the newly created Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
CreateControlZone ( control )
Create a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.CreateControlZone(out IntPtr control)
Parameters
control: out IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioGeometry ( geometry )
Destroy a geometry object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.DestroyAudioGeometry(IntPtr geometry)
Parameters
geometry: IntPtr  A pointer to the geometry object that should be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioMaterial ( material )
Destroy a material object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.DestroyAudioMaterial(IntPtr material)
Parameters
material: IntPtr  A pointer to the material object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioSceneIR ( sceneIR )
Destroy an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.DestroyAudioSceneIR(IntPtr sceneIR)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyControlZone ( control )
Destroy a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.DestroyControlZone(IntPtr control)
Parameters
control: IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
InitializeAudioSceneIRParameters ( parameters )
Generate the default values for the parameters of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.InitializeAudioSceneIRParameters(out MapParameters parameters)
Parameters
parameters: out MapParameters  The initialized parameters with default values
Returns
int  Returns an ovrResult indicating success or failure
SetAcousticModel ( model )
Explicitly set the reflection model.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.SetAcousticModel(AcousticModel model)
Parameters
Returns
int
SetEnabled ( feature , enabled )
Turn on and off specific features of the library.
Signature
int MetaXRAcousticNativeInterface.INativeInterface.SetEnabled(int feature, bool enabled)
Parameters
feature: int  specific property to query
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
SetEnabled ( feature , enabled )
Signature
int MetaXRAcousticNativeInterface.INativeInterface.SetEnabled(EnableFlagInternal feature, bool enabled)
Parameters
enabled: bool
Returns
int

Inner Classes

DummyInterface Class

Implements MetaXRAcousticNativeInterface.INativeInterface

Methods

AudioGeometryGetSimplifiedMesh ( geometry , vertices , indices , materialIndices )
Get the mesh information that is currently saved to a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryGetSimplifiedMesh(IntPtr geometry, out float[] vertices, out uint[] indices, out uint[] materialIndices)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: out float []  An array of vertices that describe the mesh
indices: out uint []  An array of integers that describe the mesh
materialIndices: out uint []  An array of integers that describe the materials
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryGetTransform ( geometry , matrix4x4 )
Get the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryGetTransform(IntPtr geometry, out float[] matrix4x4)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix4x4: out float []
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshFile ( geometry , filePath )
Read in baked geometry from a .xrageo file into a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryReadMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
filePath: string  A fully qualified path to the .xrageo file that should be read
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshMemory ( geometry , data , dataLength )
Read in geometry data as raw data input stored in an array. This allows alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryReadMeshMemory(IntPtr geometry, IntPtr data, UInt64 dataLength)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetObjectFlag ( geometry , flag , enabled )
Set the properties of a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometrySetObjectFlag(IntPtr geometry, ObjectFlags flag, bool enabled)
Parameters
geometry: IntPtr  A pointer to the geometry object
flag: ObjectFlags  The property about the geometry to be set
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetTransform ( geometry , matrix )
Set the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometrySetTransform(IntPtr geometry, in Matrix4x4 matrix)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix: in Matrix4x4  A 4x4 matrix that contains the transform to apply
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount )
Bake mesh data into a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryUploadMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadSimplifiedMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount , simplification )
Bake mesh data into a geometry object with simplification flags.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryUploadSimplifiedMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount, ref MeshSimplification simplification)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
simplification: ref MeshSimplification  A struct containing flags for mesh simplification
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFile ( geometry , filePath )
Write a geometry object into a .xrageo file.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryWriteMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object to be written
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFileObj ( geometry , filePath )
Save the mesh data of a geometry object into an .obj file.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioGeometryWriteMeshFileObj(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialGetFrequency ( material , property , frequency , value )
Get the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioMaterialGetFrequency(IntPtr material, MaterialProperty property, float frequency, out float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
frequency: float  The frequency to get the value at
value: out float  The returned material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialReset ( material , property )
Remove all the set values for a material property.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioMaterialReset(IntPtr material, MaterialProperty property)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialSetFrequency ( material , property , frequency , value )
Set the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioMaterialSetFrequency(IntPtr material, MaterialProperty property, float frequency, float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to set
frequency: float  The frequency to set the value at
value: float  The desired value of the material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRCompute ( sceneIR , parameters )
Bake an Acoustic Map given particular parameters. It will use automatically generated points.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRCompute(IntPtr sceneIR, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRComputeCustomPoints ( sceneIR , points , pointCount , parameters )
Bake an Acoustic Map given particular parameters. It will use custom points.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRComputeCustomPoints(IntPtr sceneIR, float[] points, UIntPtr pointCount, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of custom points to be used for the baking
pointCount: UIntPtr  The number of points in the points array
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetEnabled ( sceneIR , enabled )
Get whether an Acoustic Map object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRGetEnabled(IntPtr sceneIR, out bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: out bool  bool specifying if the Acoustic Map is be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPointCount ( sceneIR , pointCount )
Get the number of points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRGetPointCount(IntPtr sceneIR, out UIntPtr pointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
pointCount: out UIntPtr  The number of points in the Acoustic Map
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPoints ( sceneIR , points , maxPointCount )
Get the exact points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRGetPoints(IntPtr sceneIR, float[] points, UIntPtr maxPointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of the points used in the Acoustic Map
maxPointCount: UIntPtr  The maximum number of points that can be stored in the points array
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetStatus ( sceneIR , status )
Get the current computation status of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRGetStatus(IntPtr sceneIR, out AcousticMapStatus status)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
status: out AcousticMapStatus  The current computation status of the Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetTransform ( sceneIR , matrix4x4 )
Get the transform currently applied to an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRGetTransform(IntPtr sceneIR, out float[] matrix4x4)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix4x4: out float []  The transform currently applied to the Acoustic Map represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadFile ( sceneIR , filePath )
Read a .xramap file into an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRReadFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path which the .xramap file that should be read from
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadMemory ( sceneIR , data , dataLength )
Read a raw data array into an Acoustic Map object. Allows for alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRReadMemory(IntPtr sceneIR, IntPtr data, UInt64 dataLength)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetEnabled ( sceneIR , enabled )
Set an Acoustic Map object to be enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRSetEnabled(IntPtr sceneIR, bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: bool  bool specifying if the Acoustic Map should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetTransform ( sceneIR , matrix )
Set the transform of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRSetTransform(IntPtr sceneIR, in Matrix4x4 matrix)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRWriteFile ( sceneIR , filePath )
Write an Acoustic Map into a .xramap file.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.AudioSceneIRWriteFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetBox ( control , sizeX , sizeY , sizeZ )
Get the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneGetBox(IntPtr control, out float sizeX, out float sizeY, out float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: out float  The size of the boundary along the x axis
sizeY: out float  The size of the boundary along the y axis
sizeZ: out float  The size of the boundary along the z axis
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetEnabled ( control , enabled )
Get whether a Control Zone object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneGetEnabled(IntPtr control, out bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: out bool  bool specifying if the Control Zone is enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetFadeDistance ( control , fadeX , fadeY , fadeZ )
Get the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneGetFadeDistance(IntPtr control, out float fadeX, out float fadeY, out float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: out float  The amount of fade in the x direction
fadeY: out float  The amount of fade in the y direction
fadeZ: out float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetTransform ( control , matrix4x4 )
Get the transform currently applied to a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneGetTransform(IntPtr control, out float[] matrix4x4)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix4x4: out float []  The transform currently applied to the Control Zone represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneReset ( control , property )
Remove all values set for a particular property of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneReset(IntPtr control, ControlZoneProperty property)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
Returns
int
ControlZoneSetBox ( control , sizeX , sizeY , sizeZ )
Set the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneSetBox(IntPtr control, float sizeX, float sizeY, float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: float  The width of the boundary
sizeY: float  The height of the boundary
sizeZ: float  The depth of the boundary
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetEnabled ( control , enabled )
Enable or Disable Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneSetEnabled(IntPtr control, bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: bool  bool specifying if the Control Zone should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFadeDistance ( control , fadeX , fadeY , fadeZ )
Set the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneSetFadeDistance(IntPtr control, float fadeX, float fadeY, float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: float  The amount of fade in the x direction
fadeY: float  The amount of fade in the y direction
fadeZ: float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFrequency ( control , property , frequency , value )
Set a property of the Control Zone object for a particular frequency.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneSetFrequency(IntPtr control, ControlZoneProperty property, float frequency, float value)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
frequency: float  The frequency to change the property at in Hz
value: float  The new value of the property at frequency
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetTransform ( control , matrix )
Set the transform of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.ControlZoneSetTransform(IntPtr control, in Matrix4x4 matrix)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioGeometry ( geometry )
Create a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.CreateAudioGeometry(out IntPtr geometry)
Parameters
geometry: out IntPtr  A pointer to the created geometry object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioMaterial ( material )
Create a new material object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.CreateAudioMaterial(out IntPtr material)
Parameters
material: out IntPtr  A pointer to the newly created material object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioSceneIR ( sceneIR )
Create a new Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.CreateAudioSceneIR(out IntPtr sceneIR)
Parameters
sceneIR: out IntPtr  A pointer to the newly created Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
CreateControlZone ( control )
Create a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.CreateControlZone(out IntPtr control)
Parameters
control: out IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioGeometry ( geometry )
Destroy a geometry object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.DestroyAudioGeometry(IntPtr geometry)
Parameters
geometry: IntPtr  A pointer to the geometry object that should be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioMaterial ( material )
Destroy a material object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.DestroyAudioMaterial(IntPtr material)
Parameters
material: IntPtr  A pointer to the material object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioSceneIR ( sceneIR )
Destroy an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.DestroyAudioSceneIR(IntPtr sceneIR)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyControlZone ( control )
Destroy a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.DestroyControlZone(IntPtr control)
Parameters
control: IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
InitializeAudioSceneIRParameters ( parameters )
Generate the default values for the parameters of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.InitializeAudioSceneIRParameters(out MapParameters parameters)
Parameters
parameters: out MapParameters  The initialized parameters with default values
Returns
int  Returns an ovrResult indicating success or failure
SetAcousticModel ( model )
Explicitly set the reflection model.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.SetAcousticModel(AcousticModel model)
Parameters
Returns
int
SetEnabled ( feature , enabled )
Turn on and off specific features of the library.
Signature
int MetaXRAcousticNativeInterface.DummyInterface.SetEnabled(int feature, bool enabled)
Parameters
feature: int  specific property to query
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
SetEnabled ( feature , enabled )
Signature
int MetaXRAcousticNativeInterface.DummyInterface.SetEnabled(EnableFlagInternal feature, bool enabled)
Parameters
enabled: bool
Returns
int

FMODPluginInterface Class

Implements MetaXRAcousticNativeInterface.INativeInterface

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 MetaXRAcousticNativeInterface.FMODPluginInterface.binaryName

Methods

AudioGeometryGetSimplifiedMesh ( geometry , vertices , indices , materialIndices )
Get the mesh information that is currently saved to a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryGetSimplifiedMesh(IntPtr geometry, out float[] vertices, out uint[] indices, out uint[] materialIndices)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: out float []  An array of vertices that describe the mesh
indices: out uint []  An array of integers that describe the mesh
materialIndices: out uint []  An array of integers that describe the materials
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryGetTransform ( geometry , matrix4x4 )
Get the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryGetTransform(IntPtr geometry, out float[] matrix4x4)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix4x4: out float []
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshFile ( geometry , filePath )
Read in baked geometry from a .xrageo file into a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryReadMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
filePath: string  A fully qualified path to the .xrageo file that should be read
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshMemory ( geometry , data , dataLength )
Read in geometry data as raw data input stored in an array. This allows alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryReadMeshMemory(IntPtr geometry, IntPtr data, UInt64 dataLength)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetObjectFlag ( geometry , flag , enabled )
Set the properties of a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometrySetObjectFlag(IntPtr geometry, ObjectFlags flag, bool enabled)
Parameters
geometry: IntPtr  A pointer to the geometry object
flag: ObjectFlags  The property about the geometry to be set
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetTransform ( geometry , matrix )
Set the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometrySetTransform(IntPtr geometry, in Matrix4x4 matrix)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix: in Matrix4x4  A 4x4 matrix that contains the transform to apply
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount )
Bake mesh data into a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryUploadMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadSimplifiedMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount , simplification )
Bake mesh data into a geometry object with simplification flags.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryUploadSimplifiedMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount, ref MeshSimplification simplification)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
simplification: ref MeshSimplification  A struct containing flags for mesh simplification
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFile ( geometry , filePath )
Write a geometry object into a .xrageo file.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryWriteMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object to be written
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFileObj ( geometry , filePath )
Save the mesh data of a geometry object into an .obj file.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioGeometryWriteMeshFileObj(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialGetFrequency ( material , property , frequency , value )
Get the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioMaterialGetFrequency(IntPtr material, MaterialProperty property, float frequency, out float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
frequency: float  The frequency to get the value at
value: out float  The returned material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialReset ( material , property )
Remove all the set values for a material property.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioMaterialReset(IntPtr material, MaterialProperty property)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialSetFrequency ( material , property , frequency , value )
Set the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioMaterialSetFrequency(IntPtr material, MaterialProperty property, float frequency, float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to set
frequency: float  The frequency to set the value at
value: float  The desired value of the material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRCompute ( sceneIR , parameters )
Bake an Acoustic Map given particular parameters. It will use automatically generated points.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRCompute(IntPtr sceneIR, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRComputeCustomPoints ( sceneIR , points , pointCount , parameters )
Bake an Acoustic Map given particular parameters. It will use custom points.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRComputeCustomPoints(IntPtr sceneIR, float[] points, UIntPtr pointCount, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of custom points to be used for the baking
pointCount: UIntPtr  The number of points in the points array
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetEnabled ( sceneIR , enabled )
Get whether an Acoustic Map object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRGetEnabled(IntPtr sceneIR, out bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: out bool  bool specifying if the Acoustic Map is be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPointCount ( sceneIR , pointCount )
Get the number of points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRGetPointCount(IntPtr sceneIR, out UIntPtr pointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
pointCount: out UIntPtr  The number of points in the Acoustic Map
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPoints ( sceneIR , points , maxPointCount )
Get the exact points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRGetPoints(IntPtr sceneIR, float[] points, UIntPtr maxPointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of the points used in the Acoustic Map
maxPointCount: UIntPtr  The maximum number of points that can be stored in the points array
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetStatus ( sceneIR , status )
Get the current computation status of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRGetStatus(IntPtr sceneIR, out AcousticMapStatus status)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
status: out AcousticMapStatus  The current computation status of the Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetTransform ( sceneIR , matrix4x4 )
Get the transform currently applied to an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRGetTransform(IntPtr sceneIR, out float[] matrix4x4)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix4x4: out float []  The transform currently applied to the Acoustic Map represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadFile ( sceneIR , filePath )
Read a .xramap file into an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRReadFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path which the .xramap file that should be read from
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadMemory ( sceneIR , data , dataLength )
Read a raw data array into an Acoustic Map object. Allows for alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRReadMemory(IntPtr sceneIR, IntPtr data, UInt64 dataLength)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetEnabled ( sceneIR , enabled )
Set an Acoustic Map object to be enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRSetEnabled(IntPtr sceneIR, bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: bool  bool specifying if the Acoustic Map should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetTransform ( sceneIR , matrix )
Set the transform of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRSetTransform(IntPtr sceneIR, in Matrix4x4 matrix)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRWriteFile ( sceneIR , filePath )
Write an Acoustic Map into a .xramap file.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.AudioSceneIRWriteFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetBox ( control , sizeX , sizeY , sizeZ )
Get the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneGetBox(IntPtr control, out float sizeX, out float sizeY, out float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: out float  The size of the boundary along the x axis
sizeY: out float  The size of the boundary along the y axis
sizeZ: out float  The size of the boundary along the z axis
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetEnabled ( control , enabled )
Get whether a Control Zone object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneGetEnabled(IntPtr control, out bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: out bool  bool specifying if the Control Zone is enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetFadeDistance ( control , fadeX , fadeY , fadeZ )
Get the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneGetFadeDistance(IntPtr control, out float fadeX, out float fadeY, out float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: out float  The amount of fade in the x direction
fadeY: out float  The amount of fade in the y direction
fadeZ: out float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetTransform ( control , matrix4x4 )
Get the transform currently applied to a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneGetTransform(IntPtr control, out float[] matrix4x4)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix4x4: out float []  The transform currently applied to the Control Zone represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneReset ( control , property )
Remove all values set for a particular property of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneReset(IntPtr control, ControlZoneProperty property)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
Returns
int
ControlZoneSetBox ( control , sizeX , sizeY , sizeZ )
Set the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneSetBox(IntPtr control, float sizeX, float sizeY, float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: float  The width of the boundary
sizeY: float  The height of the boundary
sizeZ: float  The depth of the boundary
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetEnabled ( control , enabled )
Enable or Disable Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneSetEnabled(IntPtr control, bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: bool  bool specifying if the Control Zone should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFadeDistance ( control , fadeX , fadeY , fadeZ )
Set the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneSetFadeDistance(IntPtr control, float fadeX, float fadeY, float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: float  The amount of fade in the x direction
fadeY: float  The amount of fade in the y direction
fadeZ: float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFrequency ( control , property , frequency , value )
Set a property of the Control Zone object for a particular frequency.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneSetFrequency(IntPtr control, ControlZoneProperty property, float frequency, float value)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
frequency: float  The frequency to change the property at in Hz
value: float  The new value of the property at frequency
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetTransform ( control , matrix )
Set the transform of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.ControlZoneSetTransform(IntPtr control, in Matrix4x4 matrix)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioGeometry ( geometry )
Create a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.CreateAudioGeometry(out IntPtr geometry)
Parameters
geometry: out IntPtr  A pointer to the created geometry object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioMaterial ( material )
Create a new material object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.CreateAudioMaterial(out IntPtr material)
Parameters
material: out IntPtr  A pointer to the newly created material object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioSceneIR ( sceneIR )
Create a new Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.CreateAudioSceneIR(out IntPtr sceneIR)
Parameters
sceneIR: out IntPtr  A pointer to the newly created Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
CreateControlZone ( control )
Create a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.CreateControlZone(out IntPtr control)
Parameters
control: out IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioGeometry ( geometry )
Destroy a geometry object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.DestroyAudioGeometry(IntPtr geometry)
Parameters
geometry: IntPtr  A pointer to the geometry object that should be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioMaterial ( material )
Destroy a material object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.DestroyAudioMaterial(IntPtr material)
Parameters
material: IntPtr  A pointer to the material object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioSceneIR ( sceneIR )
Destroy an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.DestroyAudioSceneIR(IntPtr sceneIR)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyControlZone ( control )
Destroy a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.DestroyControlZone(IntPtr control)
Parameters
control: IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
InitializeAudioSceneIRParameters ( parameters )
Generate the default values for the parameters of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.InitializeAudioSceneIRParameters(out MapParameters parameters)
Parameters
parameters: out MapParameters  The initialized parameters with default values
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 MetaXRAcousticNativeInterface.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.
ovrAudio_GetVersion ( Major , Minor , Patch )
Signature
static IntPtr MetaXRAcousticNativeInterface.FMODPluginInterface.ovrAudio_GetVersion(out int Major, out int Minor, out int Patch)
Parameters
Major: out int
Minor: out int
Patch: out int
Returns
IntPtr
SetAcousticModel ( model )
Explicitly set the reflection model.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.SetAcousticModel(AcousticModel model)
Parameters
Returns
int
SetEnabled ( feature , enabled )
Turn on and off specific features of the library.
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.SetEnabled(int feature, bool enabled)
Parameters
feature: int  specific property to query
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
SetEnabled ( feature , enabled )
Signature
int MetaXRAcousticNativeInterface.FMODPluginInterface.SetEnabled(EnableFlagInternal feature, bool enabled)
Parameters
enabled: bool
Returns
int

UnityNativeInterface Class

Implements MetaXRAcousticNativeInterface.INativeInterface

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 MetaXRAcousticNativeInterface.UnityNativeInterface.binaryName

Methods

AudioGeometryGetSimplifiedMesh ( geometry , vertices , indices , materialIndices )
Get the mesh information that is currently saved to a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryGetSimplifiedMesh(IntPtr geometry, out float[] vertices, out uint[] indices, out uint[] materialIndices)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: out float []  An array of vertices that describe the mesh
indices: out uint []  An array of integers that describe the mesh
materialIndices: out uint []  An array of integers that describe the materials
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryGetTransform ( geometry , matrix4x4 )
Get the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryGetTransform(IntPtr geometry, out float[] matrix4x4)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix4x4: out float []
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshFile ( geometry , filePath )
Read in baked geometry from a .xrageo file into a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryReadMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
filePath: string  A fully qualified path to the .xrageo file that should be read
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshMemory ( geometry , data , dataLength )
Read in geometry data as raw data input stored in an array. This allows alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryReadMeshMemory(IntPtr geometry, IntPtr data, UInt64 dataLength)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetObjectFlag ( geometry , flag , enabled )
Set the properties of a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometrySetObjectFlag(IntPtr geometry, ObjectFlags flag, bool enabled)
Parameters
geometry: IntPtr  A pointer to the geometry object
flag: ObjectFlags  The property about the geometry to be set
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetTransform ( geometry , matrix )
Set the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometrySetTransform(IntPtr geometry, in Matrix4x4 matrix)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix: in Matrix4x4  A 4x4 matrix that contains the transform to apply
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount )
Bake mesh data into a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryUploadMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadSimplifiedMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount , simplification )
Bake mesh data into a geometry object with simplification flags.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryUploadSimplifiedMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount, ref MeshSimplification simplification)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
simplification: ref MeshSimplification  A struct containing flags for mesh simplification
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFile ( geometry , filePath )
Write a geometry object into a .xrageo file.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryWriteMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object to be written
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFileObj ( geometry , filePath )
Save the mesh data of a geometry object into an .obj file.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioGeometryWriteMeshFileObj(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialGetFrequency ( material , property , frequency , value )
Get the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioMaterialGetFrequency(IntPtr material, MaterialProperty property, float frequency, out float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
frequency: float  The frequency to get the value at
value: out float  The returned material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialReset ( material , property )
Remove all the set values for a material property.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioMaterialReset(IntPtr material, MaterialProperty property)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialSetFrequency ( material , property , frequency , value )
Set the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioMaterialSetFrequency(IntPtr material, MaterialProperty property, float frequency, float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to set
frequency: float  The frequency to set the value at
value: float  The desired value of the material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRCompute ( sceneIR , parameters )
Bake an Acoustic Map given particular parameters. It will use automatically generated points.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRCompute(IntPtr sceneIR, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRComputeCustomPoints ( sceneIR , points , pointCount , parameters )
Bake an Acoustic Map given particular parameters. It will use custom points.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRComputeCustomPoints(IntPtr sceneIR, float[] points, UIntPtr pointCount, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of custom points to be used for the baking
pointCount: UIntPtr  The number of points in the points array
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetEnabled ( sceneIR , enabled )
Get whether an Acoustic Map object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRGetEnabled(IntPtr sceneIR, out bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: out bool  bool specifying if the Acoustic Map is be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPointCount ( sceneIR , pointCount )
Get the number of points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRGetPointCount(IntPtr sceneIR, out UIntPtr pointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
pointCount: out UIntPtr  The number of points in the Acoustic Map
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPoints ( sceneIR , points , maxPointCount )
Get the exact points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRGetPoints(IntPtr sceneIR, float[] points, UIntPtr maxPointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of the points used in the Acoustic Map
maxPointCount: UIntPtr  The maximum number of points that can be stored in the points array
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetStatus ( sceneIR , status )
Get the current computation status of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRGetStatus(IntPtr sceneIR, out AcousticMapStatus status)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
status: out AcousticMapStatus  The current computation status of the Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetTransform ( sceneIR , matrix4x4 )
Get the transform currently applied to an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRGetTransform(IntPtr sceneIR, out float[] matrix4x4)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix4x4: out float []  The transform currently applied to the Acoustic Map represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadFile ( sceneIR , filePath )
Read a .xramap file into an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRReadFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path which the .xramap file that should be read from
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadMemory ( sceneIR , data , dataLength )
Read a raw data array into an Acoustic Map object. Allows for alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRReadMemory(IntPtr sceneIR, IntPtr data, UInt64 dataLength)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetEnabled ( sceneIR , enabled )
Set an Acoustic Map object to be enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRSetEnabled(IntPtr sceneIR, bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: bool  bool specifying if the Acoustic Map should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetTransform ( sceneIR , matrix )
Set the transform of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRSetTransform(IntPtr sceneIR, in Matrix4x4 matrix)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRWriteFile ( sceneIR , filePath )
Write an Acoustic Map into a .xramap file.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.AudioSceneIRWriteFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetBox ( control , sizeX , sizeY , sizeZ )
Get the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneGetBox(IntPtr control, out float sizeX, out float sizeY, out float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: out float  The size of the boundary along the x axis
sizeY: out float  The size of the boundary along the y axis
sizeZ: out float  The size of the boundary along the z axis
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetEnabled ( control , enabled )
Get whether a Control Zone object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneGetEnabled(IntPtr control, out bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: out bool  bool specifying if the Control Zone is enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetFadeDistance ( control , fadeX , fadeY , fadeZ )
Get the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneGetFadeDistance(IntPtr control, out float fadeX, out float fadeY, out float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: out float  The amount of fade in the x direction
fadeY: out float  The amount of fade in the y direction
fadeZ: out float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetTransform ( control , matrix4x4 )
Get the transform currently applied to a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneGetTransform(IntPtr control, out float[] matrix4x4)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix4x4: out float []  The transform currently applied to the Control Zone represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneReset ( control , property )
Remove all values set for a particular property of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneReset(IntPtr control, ControlZoneProperty property)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
Returns
int
ControlZoneSetBox ( control , sizeX , sizeY , sizeZ )
Set the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneSetBox(IntPtr control, float sizeX, float sizeY, float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: float  The width of the boundary
sizeY: float  The height of the boundary
sizeZ: float  The depth of the boundary
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetEnabled ( control , enabled )
Enable or Disable Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneSetEnabled(IntPtr control, bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: bool  bool specifying if the Control Zone should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFadeDistance ( control , fadeX , fadeY , fadeZ )
Set the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneSetFadeDistance(IntPtr control, float fadeX, float fadeY, float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: float  The amount of fade in the x direction
fadeY: float  The amount of fade in the y direction
fadeZ: float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFrequency ( control , property , frequency , value )
Set a property of the Control Zone object for a particular frequency.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneSetFrequency(IntPtr control, ControlZoneProperty property, float frequency, float value)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
frequency: float  The frequency to change the property at in Hz
value: float  The new value of the property at frequency
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetTransform ( control , matrix )
Set the transform of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.ControlZoneSetTransform(IntPtr control, in Matrix4x4 matrix)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioGeometry ( geometry )
Create a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.CreateAudioGeometry(out IntPtr geometry)
Parameters
geometry: out IntPtr  A pointer to the created geometry object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioMaterial ( material )
Create a new material object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.CreateAudioMaterial(out IntPtr material)
Parameters
material: out IntPtr  A pointer to the newly created material object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioSceneIR ( sceneIR )
Create a new Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.CreateAudioSceneIR(out IntPtr sceneIR)
Parameters
sceneIR: out IntPtr  A pointer to the newly created Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
CreateControlZone ( control )
Create a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.CreateControlZone(out IntPtr control)
Parameters
control: out IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioGeometry ( geometry )
Destroy a geometry object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.DestroyAudioGeometry(IntPtr geometry)
Parameters
geometry: IntPtr  A pointer to the geometry object that should be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioMaterial ( material )
Destroy a material object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.DestroyAudioMaterial(IntPtr material)
Parameters
material: IntPtr  A pointer to the material object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioSceneIR ( sceneIR )
Destroy an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.DestroyAudioSceneIR(IntPtr sceneIR)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyControlZone ( control )
Destroy a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.DestroyControlZone(IntPtr control)
Parameters
control: IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
InitializeAudioSceneIRParameters ( parameters )
Generate the default values for the parameters of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.InitializeAudioSceneIRParameters(out MapParameters parameters)
Parameters
parameters: out MapParameters  The initialized parameters with default values
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 MetaXRAcousticNativeInterface.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.
ovrAudio_GetVersion ( Major , Minor , Patch )
Signature
static IntPtr MetaXRAcousticNativeInterface.UnityNativeInterface.ovrAudio_GetVersion(out int Major, out int Minor, out int Patch)
Parameters
Major: out int
Minor: out int
Patch: out int
Returns
IntPtr
SetAcousticModel ( model )
Explicitly set the reflection model.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.SetAcousticModel(AcousticModel model)
Parameters
Returns
int
SetEnabled ( feature , enabled )
Turn on and off specific features of the library.
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.SetEnabled(int feature, bool enabled)
Parameters
feature: int  specific property to query
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
SetEnabled ( feature , enabled )
Signature
int MetaXRAcousticNativeInterface.UnityNativeInterface.SetEnabled(EnableFlagInternal feature, bool enabled)
Parameters
enabled: bool
Returns
int

WwisePluginInterface Class

Implements MetaXRAcousticNativeInterface.INativeInterface

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 MetaXRAcousticNativeInterface.WwisePluginInterface.binaryName

Methods

AudioGeometryGetSimplifiedMesh ( geometry , vertices , indices , materialIndices )
Get the mesh information that is currently saved to a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryGetSimplifiedMesh(IntPtr geometry, out float[] vertices, out uint[] indices, out uint[] materialIndices)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: out float []  An array of vertices that describe the mesh
indices: out uint []  An array of integers that describe the mesh
materialIndices: out uint []  An array of integers that describe the materials
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryGetTransform ( geometry , matrix4x4 )
Get the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryGetTransform(IntPtr geometry, out float[] matrix4x4)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix4x4: out float []
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshFile ( geometry , filePath )
Read in baked geometry from a .xrageo file into a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryReadMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
filePath: string  A fully qualified path to the .xrageo file that should be read
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryReadMeshMemory ( geometry , data , dataLength )
Read in geometry data as raw data input stored in an array. This allows alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryReadMeshMemory(IntPtr geometry, IntPtr data, UInt64 dataLength)
Parameters
geometry: IntPtr  A pointer to the geometry object where the file data will be read
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetObjectFlag ( geometry , flag , enabled )
Set the properties of a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometrySetObjectFlag(IntPtr geometry, ObjectFlags flag, bool enabled)
Parameters
geometry: IntPtr  A pointer to the geometry object
flag: ObjectFlags  The property about the geometry to be set
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometrySetTransform ( geometry , matrix )
Set the transform of a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometrySetTransform(IntPtr geometry, in Matrix4x4 matrix)
Parameters
geometry: IntPtr  A pointer to the geometry object
matrix: in Matrix4x4  A 4x4 matrix that contains the transform to apply
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount )
Bake mesh data into a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryUploadMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryUploadSimplifiedMeshArrays ( geometry , vertices , vertexCount , indices , indexCount , groups , groupCount , simplification )
Bake mesh data into a geometry object with simplification flags.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryUploadSimplifiedMeshArrays(IntPtr geometry, float[] vertices, int vertexCount, int[] indices, int indexCount, MeshGroup[] groups, int groupCount, ref MeshSimplification simplification)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
vertices: float []  An array of vertices that describe the mesh
vertexCount: int  The number of vertices in the vertices array
indices: int []  An array of integers that describe the mesh
indexCount: int  The number of integers in the indices array
groups: MeshGroup []  An array of mesh group data
groupCount: int  The number of mesh groups in the groups array
simplification: ref MeshSimplification  A struct containing flags for mesh simplification
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFile ( geometry , filePath )
Write a geometry object into a .xrageo file.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryWriteMeshFile(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object to be written
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioGeometryWriteMeshFileObj ( geometry , filePath )
Save the mesh data of a geometry object into an .obj file.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioGeometryWriteMeshFileObj(IntPtr geometry, string filePath)
Parameters
geometry: IntPtr  A pointer to the geometry object where the mesh data is baked
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialGetFrequency ( material , property , frequency , value )
Get the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioMaterialGetFrequency(IntPtr material, MaterialProperty property, float frequency, out float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
frequency: float  The frequency to get the value at
value: out float  The returned material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialReset ( material , property )
Remove all the set values for a material property.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioMaterialReset(IntPtr material, MaterialProperty property)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to get
Returns
int  Returns an ovrResult indicating success or failure
AudioMaterialSetFrequency ( material , property , frequency , value )
Set the value of a material property at the given frequency.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioMaterialSetFrequency(IntPtr material, MaterialProperty property, float frequency, float value)
Parameters
material: IntPtr  A pointer to the material object
property: MaterialProperty  The material property to set
frequency: float  The frequency to set the value at
value: float  The desired value of the material property at the given frequency
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRCompute ( sceneIR , parameters )
Bake an Acoustic Map given particular parameters. It will use automatically generated points.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRCompute(IntPtr sceneIR, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRComputeCustomPoints ( sceneIR , points , pointCount , parameters )
Bake an Acoustic Map given particular parameters. It will use custom points.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRComputeCustomPoints(IntPtr sceneIR, float[] points, UIntPtr pointCount, ref MapParameters parameters)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of custom points to be used for the baking
pointCount: UIntPtr  The number of points in the points array
parameters: ref MapParameters  The parameters to be used for the baking
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetEnabled ( sceneIR , enabled )
Get whether an Acoustic Map object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRGetEnabled(IntPtr sceneIR, out bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: out bool  bool specifying if the Acoustic Map is be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPointCount ( sceneIR , pointCount )
Get the number of points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRGetPointCount(IntPtr sceneIR, out UIntPtr pointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
pointCount: out UIntPtr  The number of points in the Acoustic Map
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetPoints ( sceneIR , points , maxPointCount )
Get the exact points used in the Acoustic Map.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRGetPoints(IntPtr sceneIR, float[] points, UIntPtr maxPointCount)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
points: float []  An array of the points used in the Acoustic Map
maxPointCount: UIntPtr  The maximum number of points that can be stored in the points array
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetStatus ( sceneIR , status )
Get the current computation status of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRGetStatus(IntPtr sceneIR, out AcousticMapStatus status)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
status: out AcousticMapStatus  The current computation status of the Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRGetTransform ( sceneIR , matrix4x4 )
Get the transform currently applied to an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRGetTransform(IntPtr sceneIR, out float[] matrix4x4)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix4x4: out float []  The transform currently applied to the Acoustic Map represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadFile ( sceneIR , filePath )
Read a .xramap file into an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRReadFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path which the .xramap file that should be read from
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRReadMemory ( sceneIR , data , dataLength )
Read a raw data array into an Acoustic Map object. Allows for alternate file reading methods.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRReadMemory(IntPtr sceneIR, IntPtr data, UInt64 dataLength)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
data: IntPtr  A pointer to the raw data that should be read
dataLength: UInt64  The number of bytes in the raw data
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetEnabled ( sceneIR , enabled )
Set an Acoustic Map object to be enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRSetEnabled(IntPtr sceneIR, bool enabled)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
enabled: bool  bool specifying if the Acoustic Map should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRSetTransform ( sceneIR , matrix )
Set the transform of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRSetTransform(IntPtr sceneIR, in Matrix4x4 matrix)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
AudioSceneIRWriteFile ( sceneIR , filePath )
Write an Acoustic Map into a .xramap file.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.AudioSceneIRWriteFile(IntPtr sceneIR, string filePath)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object
filePath: string  A fully qualified path to which the output file should be written
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetBox ( control , sizeX , sizeY , sizeZ )
Get the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneGetBox(IntPtr control, out float sizeX, out float sizeY, out float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: out float  The size of the boundary along the x axis
sizeY: out float  The size of the boundary along the y axis
sizeZ: out float  The size of the boundary along the z axis
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetEnabled ( control , enabled )
Get whether a Control Zone object is enabled or disabled.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneGetEnabled(IntPtr control, out bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: out bool  bool specifying if the Control Zone is enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetFadeDistance ( control , fadeX , fadeY , fadeZ )
Get the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneGetFadeDistance(IntPtr control, out float fadeX, out float fadeY, out float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: out float  The amount of fade in the x direction
fadeY: out float  The amount of fade in the y direction
fadeZ: out float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneGetTransform ( control , matrix4x4 )
Get the transform currently applied to a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneGetTransform(IntPtr control, out float[] matrix4x4)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix4x4: out float []  The transform currently applied to the Control Zone represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneReset ( control , property )
Remove all values set for a particular property of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneReset(IntPtr control, ControlZoneProperty property)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
Returns
int
ControlZoneSetBox ( control , sizeX , sizeY , sizeZ )
Set the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneSetBox(IntPtr control, float sizeX, float sizeY, float sizeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
sizeX: float  The width of the boundary
sizeY: float  The height of the boundary
sizeZ: float  The depth of the boundary
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetEnabled ( control , enabled )
Enable or Disable Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneSetEnabled(IntPtr control, bool enabled)
Parameters
control: IntPtr  A pointer to the Control Zone object
enabled: bool  bool specifying if the Control Zone should be enabled or disabled
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFadeDistance ( control , fadeX , fadeY , fadeZ )
Set the distance to fade outward from the boundaries of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneSetFadeDistance(IntPtr control, float fadeX, float fadeY, float fadeZ)
Parameters
control: IntPtr  A pointer to the Control Zone object
fadeX: float  The amount of fade in the x direction
fadeY: float  The amount of fade in the y direction
fadeZ: float  The amount of fade in the z direction
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetFrequency ( control , property , frequency , value )
Set a property of the Control Zone object for a particular frequency.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneSetFrequency(IntPtr control, ControlZoneProperty property, float frequency, float value)
Parameters
control: IntPtr  A pointer to the Control Zone object
property: ControlZoneProperty  The property of the Control Zone to set
frequency: float  The frequency to change the property at in Hz
value: float  The new value of the property at frequency
Returns
int  Returns an ovrResult indicating success or failure
ControlZoneSetTransform ( control , matrix )
Set the transform of a Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.ControlZoneSetTransform(IntPtr control, in Matrix4x4 matrix)
Parameters
control: IntPtr  A pointer to the Control Zone object
matrix: in Matrix4x4  The transform to apply represented in a 4x4 matrix
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioGeometry ( geometry )
Create a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.CreateAudioGeometry(out IntPtr geometry)
Parameters
geometry: out IntPtr  A pointer to the created geometry object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioMaterial ( material )
Create a new material object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.CreateAudioMaterial(out IntPtr material)
Parameters
material: out IntPtr  A pointer to the newly created material object
Returns
int  Returns an ovrResult indicating success or failure
CreateAudioSceneIR ( sceneIR )
Create a new Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.CreateAudioSceneIR(out IntPtr sceneIR)
Parameters
sceneIR: out IntPtr  A pointer to the newly created Acoustic Map object
Returns
int  Returns an ovrResult indicating success or failure
CreateControlZone ( control )
Create a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.CreateControlZone(out IntPtr control)
Parameters
control: out IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioGeometry ( geometry )
Destroy a geometry object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.DestroyAudioGeometry(IntPtr geometry)
Parameters
geometry: IntPtr  A pointer to the geometry object that should be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioMaterial ( material )
Destroy a material object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.DestroyAudioMaterial(IntPtr material)
Parameters
material: IntPtr  A pointer to the material object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyAudioSceneIR ( sceneIR )
Destroy an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.DestroyAudioSceneIR(IntPtr sceneIR)
Parameters
sceneIR: IntPtr  A pointer to the Acoustic Map object to be destroyed
Returns
int  Returns an ovrResult indicating success or failure
DestroyControlZone ( control )
Destroy a new Control Zone object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.DestroyControlZone(IntPtr control)
Parameters
control: IntPtr  A pointer to the Control Zone object
Returns
int  Returns an ovrResult indicating success or failure
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 MetaXRAcousticNativeInterface.WwisePluginInterface.getOrCreateGlobalOvrAudioContext()
Returns
IntPtr  The returned handle to the context.
InitializeAudioSceneIRParameters ( parameters )
Generate the default values for the parameters of an Acoustic Map object.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.InitializeAudioSceneIRParameters(out MapParameters parameters)
Parameters
parameters: out MapParameters  The initialized parameters with default values
Returns
int  Returns an ovrResult indicating success or failure
ovrAudio_GetVersion ( Major , Minor , Patch )
Signature
static IntPtr MetaXRAcousticNativeInterface.WwisePluginInterface.ovrAudio_GetVersion(out int Major, out int Minor, out int Patch)
Parameters
Major: out int
Minor: out int
Patch: out int
Returns
IntPtr
SetAcousticModel ( model )
Explicitly set the reflection model.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.SetAcousticModel(AcousticModel model)
Parameters
Returns
int
SetEnabled ( feature , enabled )
Turn on and off specific features of the library.
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.SetEnabled(int feature, bool enabled)
Parameters
feature: int  specific property to query
enabled: bool  bool specifying if the feature should be enabled
Returns
int  Returns an ovrResult indicating success or failure
SetEnabled ( feature , enabled )
Signature
int MetaXRAcousticNativeInterface.WwisePluginInterface.SetEnabled(EnableFlagInternal feature, bool enabled)
Parameters
enabled: bool
Returns
int

Inner Enum

ovrAudioScalarType Enum

Enumeration of all the data types that could be used in the binary's interface.

Enumeration Constants

MemberDescription
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