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

ICapabilities

interface in UnityEngine.Audio

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

Description

Describes the runtime behaviour of the GeneratorInstance. These reported values are cached in the beginning and assumed to not change.

This must be implemented identically on both the asset / component / offline version in IAudioGenerator and the runtime instance IRealtime. This is so that offline tooling and asset management can reason about the content in advance, and the engine identically so without depending on loading each other.

Properties

Property Description
isFinite Return true if this GeneratorInstance is finite, meaning it has a defined length and will terminate eventually.
isRealtime 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.
length If you know your length in advance, you should set it here. Otherwise it's assumed to end at some point in the future, if isFinite is set to true.