Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetAmbisonicDecoderFloat(int, out float)

Reads a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AudioModule

GetAmbisonicDecoderFloat(int, float)

public bool GetAmbisonicDecoderFloat(int index, out float value)

Parameters

index

int
Zero-based index of user-defined parameter to be read.

value

float
Return value of the user-defined parameter that is read.

Returns

Type

Description

boolTrue, if the parameter could be read.

Remarks

Since this is for internal use in custom inspectors controlling custom ambisonic decoder effects implemented as native audio plugins, it is up to the decoder to perform necessary clipping on the UI and native sides through the setparameter/getparameter callbacks of the native audio plugin.