Prosody speech processing: API: sm_add_output_tone

Prototype Definition

int sm_add_output_tone(struct sm_output_tone_parms *tonep)

Parameters

*tonep

a structure of the following type:

typedef struct sm_output_tone_parms {
	tSMModuleId module;					/* in */
	tSM_INT component1_id;					/* in */
	tSM_INT component2_id;					/* in */
	tSM_INT id;						/* out */
} SM_OUTPUT_TONE_PARMS;

Description

This call may be used to add a new output tone to the repertoire of those supported by the given module. The new tone will be a dual tone having two components identified by component1_id and component2_id where these each refer to either a predefined component frequency or one defined by the application through a call to sm_add_output_freq(). On return id will be set to an identifier for the new tone. This identifier may be used in calls to sm_play_tone() and sm_play_cptone() to refer to the newly defined output tone.

See Prosody speech processing: pre-loaded output tones, for list of predefined component frequencies, and for list of predetermined simple output tones.

Fields

module

The module whose tone set if to be modified.

component1_id

The identifier of the first component of the tone.

component2_id

The identifier of the second component of the tone.

id

The identifier returned if the tone pair is added.

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_NO_RESOURCES - if no resources to store new output tone
• ERR_SM_BAD_PARAMETER - if component id parameter out of range
• ERR_SM_CHANNEL_ALLOCATED - channel still allocated

This function is part of the Prosody speech processing API.