Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

Result

struct 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

The result returned from a GeneratorInstance.IRealtime.Process call.

This primarily contains the amount of frames actually written into the passed-in ChannelBuffer, and the status of the generator (eg. whether it has finished or not).

Additional resources: RealtimeContext.Process

Properties

Property Description
processedFrames Number of frames processed by the GeneratorInstance in RealtimeContext.Process.

Public Methods

Method Description
isFinished If this is true, the GeneratorInstance has finished generating audio and won't produce any more frames.

Static Methods

Method Description
Finished Creates a new Result that indicates the generator has finished from this point on, having delivered GeneratorInstance.Result.processedFrames additionally.

Operators

Operator Description
Result Creates a new Result from a number of frames processed.