Prosody speech processing: API: sm_play_tone_list_abort

Prototype Definition

int sm_play_tone_list_abort(tSMChannelId channel)

Parameters

channel
The channel which is playing a tone.

Description

This call enables an application to abort the previously initiated playing of a list of tones. The channel stops generating tones as soon as possible, causing the status kSMPlayToneListStatusComplete to be reported by sm_play_tone_list_status() when the tone generation has stopped.

Returns

0 if call completed successfully, otherwise a standard error such as:


This function is part of the Prosody speech processing API.