Miles Sound System SDK 7.2a

AIL_set_sequence_loop_count

The function AIL_set_sequence_loop_count arranges for a sequence to be restarted immediately upon completion, for a total of two or more iterations.

void AIL_set_sequence_loop_count(
  HSEQUENCE S,
  S32 loop_count
);

In Parameters

S: indicates the sequence to loop.
loop_count: should be set to the desired number of iterations.

Discussion

A loop_count value of 1 results in a single iteration, with no looping. This is the default loop count value, as initialized by AIL_init_sequence.

A loop_count value of 0 creates an infinite loop, which can be interrupted by calling AIL_stop_sequence, AIL_end_sequence, or by calling AIL_set_sequence_loop_count to establish a different loop count.

loop_count values of 2 or more cause the sequence to be played a total of 2 or more times. The current number of iterations remaining may be monitored with AIL_sequence_loop_count.

This function provides a convenient way to loop sequences without requiring the composer to enclose the sequence in XMIDI For/Next...Break controllers. Under MSS version 2, the only way to loop a sequence was to use these controllers or the Sequence Branch Index controller.

Group: XMIDI Services
Related Functions: AIL_end_sequence, AIL_init_sequence, AIL_register_sequence_callback, AIL_sequence_loop_count, AIL_set_sequence_loop_count, AIL_stop_sequence
Related Basic Types: HSEQUENCE, S32, void