CreateCue

Creates an audio cue.

Synopsis

Item CreateCue (TagArg *tagList)

Description

This macro calls CreateItem() to create an audio cue, which is an item associated with a system signal. A task can get the signal mask of the cue's signal using the GetCueSignal() call.

When a task uses an audio timing call such as SignalAtTime(), it passes the item number of the audio cue to the function. The task then calls WaitSignal() to enter wait state, where it waits for the cue's signal at the specified time.

Since each task has its own set signals, Cues cannot be shared among tasks.

Call DeleteCue() to dispose of a Cue item.

Arguments

None

Return Value

The function returns the item number of the cue (a positive value) or an error code (a negative value) if an error occurs.

Implementation

Macro implemented in the audio.h V21.

Associated Files

audio.h