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

EffectInstance.Process

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 Result Process(ref RealtimeContext context, ChannelBuffer inputBuffer, ChannelBuffer outputBuffer, Arguments effectArgs);

Parameters

Parameter Description
context The RealtimeContext of the current mix cycle.
inputBuffer The buffer holding the audio for the effect to process.
outputBuffer The buffer the effect will put its processing result into.
effectArgs Additional arguments passed along, which can be default-initialized.

Returns

Result A Result struct. It currently carries no data.

Description

Manually process this particular EffectInstance.

In most use cases, you would not call this directly, but rather have the audio system call it for you. If you nest an EffectInstance inside another ProcessorInstance, call this from the owning processor's real-time part, within a mix cycle.