AIL_stop_sequence

The function AIL_stop_sequence stops playback of a sequence.

void AIL_stop_sequence(
  HSEQUENCE S
);

In Parameters

S

indicates the sequence to stop playing.

Discussion

If desired, sequence playback may be resumed from the current position with a call to AIL_resume_sequence.

It is not necessary to stop playback of a sequence with this function before restarting it with AIL_start_sequence, or releasing its handle with AIL_release_sequence_handle.

After stopping playback of a sequence with AIL_stop_sequence, calls to the AIL_sequence_status function will return SEQ_STOPPED, not SEQ_DONE. 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.

AIL_stop_sequence releases all channel locks and sustain pedals, and turns off any active notes in the sequence to be stopped.

AIL_stop_sequence has no effect on sequences whose status is not SEQ_PLAYING.

Example files that use this function: XMIPLAY.C

Group: XMIDI Services
Related Functions: AIL_allocate_sequence_handle, AIL_end_sequence, AIL_release_sequence_handle, AIL_resume_sequence, AIL_sequence_status, AIL_set_sequence_loop_count, AIL_set_sequence_tempo, AIL_set_sequence_volume, 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.