saiPauseSynthesizer

Pauses a synthesizer process.

Prototype

DWORD saiPauseSynthesizer ( SAI_SYNTHESIZER_HANDLE synthHd, SAI_REQUEST_ID *requestId )

Argument

Description

synthHd

Handle associated with a synthesizer resource.

requestId

Pointer to a unique identifier associated with the request.


Return values

Return value

Description

SUCCESS

 

SAIERR_ENGINE_NOT_READY

Synthesizer associated with the specified synthHd cannot handle the request.

SAIERR_INVALID_PARAMETER

One of the specified arguments is invalid.


Events

Event

Description

SAIEVN_TTS_PAUSE_DONE

Request was processed. The result of the request is returned in the statusCode field of the SAIEVN_TTS_PAUSE_DONE event buffer.


Details

saiPauseSynthesizer pauses a speech synthesis request that was received by the synthesizer engine.

If the synthesizer is not ready to process the request (that is, it is not in a SPEAK state), the SAI service returns SAI_SC_METHOD_NOT_VALID_IN_THIS_STATE in the statusCode field of the SAIEVN_TTS_PAUSE_DONE event buffer.

See also

saiControlSynthesizer, saiResumeSynthesizer, saiSpeakSynthesizer, saiStopSynthesizer