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