Prosody speech processing: API: sm_play_tone_status

Prototype Definition

int sm_play_tone_status(struct sm_play_tone_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_play_tone_status_parms {
	tSMChannelId channel;					/* inout */
	enum kSMPlayToneStatus {
		kSMPlayToneStatusComplete,
		kSMPlayToneStatusOngoing,
	} status;						/* out */
} SM_PLAY_TONE_STATUS_PARMS;

Description

This call, typically invoked in response to a write event being signalled, allows an application to determine the status of a specific on-going tone generation job.

This function can also be used for 'any channel' operation. This mode of operation is a legacy feature and is not recommended for new applications. See Prosody TiNG: any channel operation for more details.

When this function reports that the channel status is kSMPlayToneStatusComplete, this also marks the end of the use of the channel for playing a tone, returning the channel output to an idle state ready to start a new replay or other output operation. Note that this means that if sm_play_tone_status() is used again on the channel before starting a new tone, then it will report the error ERR_SM_WRONG_CHANNEL_STATE.

Fields

channel

The channel which is playing a tone.

status

The status of the tone generation. One of these values:

kSMPlayToneStatusComplete

The tone generation job has completed.

kSMPlayToneStatusOngoing

The tone generation job is still ongoing.

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody speech processing API.