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

ControlContext.AllocateEffect<TProcessor,TControl>(TProcessor,TControl,AudioFormat?,CreationParameters)

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

Parameters

Parameter Description
processorState The initial state available from the realtime thread.
controlState The initial state available from the control thread.
nestedFormat If not null, the returned EffectInstance will be treated as nested and use this format.
creationParameters Additional parameters and initialization state for the processor. This is generally received from IAudioEffect.CreateInstance

Returns

void An EffectInstance you own and control, that must later be destroyed with ControlContext.Destroy.

Description

Allocate an EffectInstance with the specified processor and control state.

This can generally be used to process the audio of an IAudioEffect, potentially from within another processor.

Additional resources: IAudioEffect.CreateInstance