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

EffectInstance.Configure

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

Declaration

public void Configure(ControlContext context, ref AudioConfiguration configuration);

Parameters

Parameter Description
context The ControlContext that owns this EffectInstance.
configuration The new AudioConfiguration the effect should run at.

Description

Manually reconfigure this EffectInstance with the given AudioConfiguration.

This method can only be called on nested EffectInstances (created by your code, not root processors) and only during system-wide reconfiguration when ControlContext.IsSystemWideReconfiguring is true.

During system-wide reconfiguration (for example, when the sample rate changes), the realtime audio thread is suspended, making it safe to reconfigure nested processors. Calling this method at any other time will throw an exception.

Additional resources: ControlContext.AllocateEffect, ControlContext.IsSystemWideReconfiguring