Skip to content

Api > AudioSource > GetAmbisonicDecoderFloat()


AudioSource.GetAmbisonicDecoderFloat(number index)⚓︎

Reads a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.

Parameters:⚓︎

Name Type Description
index number Zero-based index of user-defined parameter to be read.

Returns:⚓︎

type Description
boolean bool True, if the parameter could be read.
number Return value of the user-defined parameter that is read.

Usage⚓︎

---@type AudioSource
local audiosource;

---@type number
local index;


local val0, val1 = audiosource.GetAmbisonicDecoderFloat(index)