Miles Sound System SDK 7.2a

AIL_stop_sample

The function AIL_stop_sample stops playback of a sample.

void AIL_stop_sample(
  HSAMPLE S
);

In Parameters

S: indicates the sample to stop playing.

Discussion

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

It is not necessary to stop playback of a sample with this function before restarting it with AIL_start_sample, or releasing its handle with AIL_release_sample_handle.

After stopping playback of a sample with AIL_stop_sample, calls to the AIL_sample_status function will return SMP_STOPPED, not SMP_DONE. If the application manages its allocated sample handles by reusing handles whose status is SMP_DONE, as described in the remarks for the AIL_allocate_sample_handle function, AIL_end_sample may be more appropriate than AIL_stop_sample. AIL_end_sample is similar to AIL_stop_sample, but it resets the sample's status to SMP_DONE instead of SMP_STOPPED.

AIL_stop_sample has no effect on samples whose status is not SMP_PLAYING.

Group: Digital Audio Services
Related Functions: AIL_allocate_sample_handle, AIL_end_sample, AIL_release_sample_handle, AIL_resume_sample, AIL_sample_buffer_available, AIL_set_sample_loop_count, AIL_start_sample, AIL_stop_sample
Related Basic Types: HSAMPLE, MILES_DIGITAL_STATUS, void