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

SeekMessage

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

A built-in message asking a processor to seek. Send it through ControlContext.SendMessage to a generator instance, for example an AudioClip instantiated as a generator (backed by a SampleProvider), including within nested generator graphs.

Properties

Property Description
destinationThe clip position to seek to.
when The clip position at which the seek fires: it is applied when playback reaches this position (which itself jumps on each seek). Null means immediate, so the seek applies at the next block. Seeks may be scheduled in any order and are evaluated in send order. A seek whose position playback has already passed, including one the cursor jumped past via an earlier seek, is dropped.

Constructors

Constructor Description
SeekMessageCreates a seek request. Omit when (or pass null) for an immediate seek.