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

AudioSource.GetEffectInstance

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

Switch to Manual

Declaration

public ProcessorInstance GetEffectInstance(TComponent effectComponent);

Parameters

Parameter Description
effectComponent Component implementing IAudioEffect on the same GameObject as this AudioSource.

Returns

ProcessorInstance The ProcessorInstance for the effect, or a default-initialized instance if the component has no instantiated effect.

Description

Gets a handle to the effect instantiated from a specific IAudioEffect component attached to this AudioSource's GameObject.

Use this for runtime scripting control of an attached effect while it is playing, for example to send messages with ControlContext.SendMessage. Since the AudioSource owns the instance, check for its existence using ControlContext.Exists.