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 The component implementing IAudioEffect.

Returns

ProcessorInstance The ProcessorInstance for the effect, or default if not found.

Description

Gets the effect instance for a specific IAudioEffect component attached to this AudioSource's GameObject.

Use this to get runtime access to effect parameters via the Pipe/messaging system.