AIL_end_sample

The function AIL_end_sample terminates playback of a sample, setting its status to SMP_DONE.

void AIL_end_sample(
  HSAMPLE S
);

In Parameters

S

indicates the sample to terminate.

Discussion

After stopping playback of a sample with AIL_end_sample, calls to the AIL_sample_status function will return SMP_DONE, not SMP_STOPPED. 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.

Example files that use this function: SSTEST.C

Group: Digital Audio Services
Related Functions: AIL_allocate_sample_handle, AIL_end_sample, AIL_resume_sample, AIL_sample_buffer_available, AIL_sample_status, AIL_set_sample_loop_count, AIL_start_sample, AIL_stop_sample
Related Basic Types: HSAMPLE, MILES_DIGITAL_STATUS, void
Related FAQs: When can I free the memory I gave to MSS?

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