Prosody speech processing: API: sm_besp_write_status

This function is only in Prosody version 1 (see also the conversion guide for further details).

Prototype Definition

int sm_besp_write_status(struct sm_besp_status_parms *statusp)

Parameters

a structure of the following type:

typedef struct sm_besp_status_parms {
	tSMChannelId channel;					/* out */
	tSM_INT status;						/* out */
} SM_BESP_STATUS_PARMS;

Description

This function allows an application to determine which out of all the channels with ongoing speech processing "write" type jobs would most benefit from some application action. On return from the call, channel will be set to the channel identifier for the selected channel, and status will be set to the current status of the write type job. The following write type jobs are taken into consideration:

Write Job	Status value returned
Replay	As status parameter returned by sm_replay_status() in any channel mode
Dial	As status parameter returned by sm_play_digits_status() in any channel mode
Play tone	As status parameter returned by sm_play_tone_status() in any channel mode
Play call-progress tone	As status parameter returned by sm_play_cptone_status() in any channel mode

If no such write job exists which could benefit from application activity, then channel will be set to kSMNullChannelId and the call will return an error code of ERR_SM_NO_SUCH_CHANNEL.

Fields

channel (Only in Prosody version 1): The channel whose status is being reported.
status (Only in Prosody version 1): The status of a channel.

Returns

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

ERR_SM_DEVERR - device error
ERR_SM_NO_SUCH_CHANNEL - if call when no speech processing firmware hosted channels allocated or when no work to be done

This function is part of the Prosody speech processing API.