Unity - Scripting API: AudioSource.SetSpatializerFloat
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Declaration
public bool SetSpatializerFloat(int index, float value);
Parameters
| Parameter | Description |
|---|---|
| index | Zero-based index of user-defined parameter to be set. |
| value | New value of the user-defined parameter. |
Returns
bool True, if the parameter could be set.
Description
Sets a user-defined parameter of a custom spatializer effect that is attached to an AudioSource.
Since this is for internal use in custom inspectors controlling custom spatializer effects implemented as native audio plugins, it is up to the spatializer to perform necessary clipping on the UI and native sides through the setparameter/getparameter callbacks of the native audio plugin.