SleepAudioTicks

Enters wait state for a number of audio ticks (OBSOLETE)

Synopsis

Err SleepAudioTicks (int32 Ticks)

Description

This function puts the calling task in wait state for the specified number of ticks of the audio clock. If you use this function to schedule music events you'll regret it, because there will be creeping error in the absolute time. Use the cue-based functions instead.

Arguments

Ticks: The number of audio clock ticks to wait (at 240; Hz or whatever the current rate is).

Return Value

The function returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Folio call implemented in Audio folio V20.

Notes

Use of this function is discouraged because it creates and deletes a cue, which wastes an Item number. Create your own Cue, keep it around, and use SleepUntilTime() instead.

Associated Files

audio.h