Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioSource.SetScheduledStartTime

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function SetScheduledStartTime(time: double): void;
public void SetScheduledStartTime(double time);

Parameters

time Time in seconds.

Description

Changes the time at which a sound that has already been scheduled to play will start.

Notice that depending on the timing not all rescheduling requests can be fulfilled.

One interesting use case for this is stinger sound effects that are initiated by game events, but that you also want to be synchronized to specific beats in music. Then this function can be used to defer the stinger until the next musical transition.

Note: In general it is better to use PlayScheduled to cue up audio. Only use SetScheduledStartTime if you have scheduled an audio clip to play in the future and you need to change the time at which it starts. Calling SetScheduledStartTime will not cause an un-scheduled audio clip to play.

See Also: PlayScheduled.