Prosody speech processing: API: sm_reset_input_cptones

Prototype Definition

int sm_reset_input_cptones(struct sm_reset_input_cptones_parms *resetp)

Parameters

*resetp

a structure of the following type:

typedef struct sm_reset_input_cptones_parms {
	tSMModuleId module;					/* in */
	tSM_INT tone_set_id;					/* in */
} SM_RESET_INPUT_CPTONES_PARMS;

Description

Initially, each module has predefined a default set of recognisable call-progress tones. If additional recognisable progress tones are to be defined, it may be necessary to discard the default set first. This may be the case because, for example, the default predefined set assigns the same identifier to two variants of a call-progress tone which actually need to be distinguished by the application.

This call resets to empty the set of all call-progress tones recognised by the designated module module. When new input call-progress tones to be recognised for the module are defined through calls to sm_add_input_cptone(), frequency identifiers specified will be with respect to the set of input tones referenced by tone_set_id.

See Prosody speech processing: pre-loaded input tones for predefined sets of input tones, and see sm_add_input_tone_set() on how to define new ones.

This call can only be made when no channel is allocated on the given module.

Fields

module

The module whose call-progress tone set is to be cleared.

tone_set_id

The id of the input tone set in which future call-progress tones are defined.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_SUCH_MODULE - if no such module exists
• ERR_SM_CHANNEL_ALLOCATED - channel still allocated

This function is part of the Prosody speech processing API.