Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

EffectInstance.IControl<T0>.Configure(ControlContext,TProcessor,AudioConfiguration,Setup)

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

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.

Close

Cancel

Parameters

Parameter Description
context The ControlContext associated with this call.
processor The realtime counterpart being configured.
configuration The audio configuration the effect will run at (sample rate, channel count, buffer size).
setup Out parameter where the effect reports per-instance setup information (e.g. sidechain layout). Currently a placeholder; assign default unless you need to declare something specific.

Description

Called to configure the EffectInstance before it is used, and when the audio system reconfigures.

In case of reconfiguration, the TProcessor is temporarily suspended from processing, and you can safely modify its properties.