Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

GeneratorInstance.IControl<T0>.Configure(ControlContext,TRealtime,AudioFormat,Setup,Properties)

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
realtime In case of reconfiguration, the is temporarily suspended from processing, and you can safely modify its properties.
context The ControlContext associated with this call.
format The format you're being suggested to use, for optimal performance. You must initialize to either this or a value of your choosing.
properties Additional properties you can set, or leave as default.
setup Out parameter where you must configure the sample rate and AudioSpeakerMode this GeneratorInstance must run at. The system enforces this to be true for you, and anyone using this GeneratorInstance will handle conversion to another AudioFormat if needed.

Description

Called to configure the GeneratorInstance before it is used, and when the audio system reconfigures. A default implementation will set the and based on the .

Additional resources: ControlContext.GetConfiguration, GeneratorInstance.Configuration