Prosody speech processing: API: sm_replay_abort

Prototype Definition

int sm_replay_abort(struct sm_replay_abort_parms *abortp)

Parameters

*abortp
a structure of the following type: 
typedef struct sm_replay_abort_parms {
	tSMChannelId channel;					/* in */
	tSM_UT32 offset;					/* out */
	tSM_UT32 nowait;					/* in */
} SM_REPLAY_ABORT_PARMS;

Description

This call allows an application to abort prematurely a replay job on the output channel specified. After a replay has been aborted, a final replay event will be notified to the application and silence will be output on the channel.

If the call completes successfully, the parameter offset will be set to a value between 0 and the number of octets of data actually played indicating the point at which replay was aborted. This be a value up to the total number of octets already supplied via sm_put_replay_data() and sm_put_last_replay_data().

Fields

channel
The channel which is replaying.
offset
The number of octets which had been played when the abort completed. Not valid if nowait is non-zero.
nowait
Indicates that the function should return instantly without waiting to determine the offset where the play stops. The place where the play stops can always be determined from the offset reported by sm_replay_status() when it reports that the replay has completed.

Returns

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

This function is part of the Prosody speech processing API.