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

GeneratorInstance.ICapabilities.isRealtime

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

public bool isRealtime;

Description

Declare whether this GeneratorInstance must be treated as a source rendering in real time. Realtime generators must be processed at the same sampling rate and buffer size as the system they run in.

Realtime GeneratorInstances shall return the same output every time they are processed. Additionally, the system enforces the buffer size of the passed-in ChannelBuffer equals the length of the AudioFormat.bufferSize that the ControlContext runs in.

Use cases include hardware devices that cannot be rendered at arbitrary rate, or systematic graphs that render ahead of time. If you are not sure whether your GeneratorInstance is realtime or not, you should set this to false.

Additional resources: GeneratorInstance.IControl_1.Configure