Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Configure(ControlContext, in AudioConfiguration)

Manually reconfigure this EffectInstance with the given AudioConfiguration.
Read time 1 minuteLast updated 2 days ago

Definition

Configure(ControlContext, AudioConfiguration)

public void Configure(ControlContext context, in AudioConfiguration configuration)

Parameters

The ControlContext that owns this EffectInstance.

configuration

The new AudioConfiguration the effect should run at.

Remarks

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.