AIL_end_sequence

The function AIL_end_sequence terminates playback of a sequence, setting its status to SEQ_DONE.

void AIL_end_sequence(
  HSEQUENCE S
);

In Parameters

S

indicates the sequence to terminate.

Discussion

After stopping playback of a sequence with AIL_end_sequence, calls to the AIL_sequence_status function will return SEQ_DONE, not SEQ_STOPPED. If the application manages its allocated sequence handles by reusing handles whose status is SEQ_DONE, as described in the remarks for the AIL_allocate_sequence_handle function, AIL_end_sequence may be more appropriate than AIL_stop_sequence. AIL_end_sequence is similar to AIL_stop_sequence, but it resets the sequence's status to SEQ_DONE instead of SEQ_STOPPED.

Group: XMIDI Services
Related Functions: AIL_allocate_sequence_handle, AIL_end_sequence, AIL_resume_sequence, AIL_sequence_status, AIL_set_sequence_loop_count, AIL_start_sequence, AIL_stop_sequence
Related Basic Types: HSEQUENCE, MILES_SEQUENCE_STATUS, void

For technical support, e-mail Miles3@radgametools.com
© Copyright 1991-2007 RAD Game Tools, Inc. All Rights Reserved.