Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioSource.GetSpatializerFloat

Suggest a change

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetSpatializerFloat(index: int, out value: float): bool;
public bool GetSpatializerFloat(int index, out float value);

Parameters

index Zero-based index of user-defined parameter to be read.
value Return value of the user-defined parameter that is read.

Returns

bool True, if the parameter could be read.

Description

Reads 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.

Copyright © 2016 Unity Technologies. Publication 5.4b-R
Tutorials Community Answers Knowledge Base Forums Asset Store