Prosody speech processing: API: sm_play_digits_status

Prototype Definition

int sm_play_digits_status(struct sm_play_digits_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_play_digits_status_parms {
	tSMChannelId channel;					/* inout */
	enum kSMPlayDigitsStatus {
		kSMPlayDigitsStatusComplete,
		kSMPlayDigitsStatusOngoing,
	} status;						/* out */
} SM_PLAY_DIGITS_STATUS_PARMS;

Description

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

In order to determine the status of a specific dialling job on a particular output channel, the application should set channel to specify the job concerned. On successful completion, the status parameter indicates the status.

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 kSMPlayDigitsStatusComplete, this also marks the end of the use of the channel for playing digits, 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_digits_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 digits.

status

The channel status. One of these values:

kSMPlayDigitsStatusComplete

The dialling has completed.

kSMPlayDigitsStatusOngoing

The dialling 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.