SpeechSynthesizer.CancelAll method

  • Article

Cancels all asynchronous text-to-speech calls that are in the active queue.

Syntax

public void CancelAll()

Public Sub CancelAll()

public:
void CancelAll()

Parameters

This method has no parameters.

Remarks

If speech synthesis is occurring and a user triggers another speech synthesis attempt, you might choose to cancel the current attempt and start over with the newest attempt by calling the CancelAll method. OperationCanceledException is raised when the CancelAll method is called, so you can choose to handle the exception by adding a try-catch statement to your code wherever SpeakTextAsync, SpeakSsmlAsync or SpeakSsmlFromUriAsync is called.

Requirements

Minimum supported client

None supported

Minimum supported server

None supported

Minimum supported phone

Windows Phone 8

Namespace

Windows.Phone.Speech.Synthesis Windows::Phone::Speech::Synthesis [C++]

Metadata

 Windows.WinMD

Capabilities

 ID_CAP_SPEECH_RECOGNITION [Windows Phone]

See also

SpeechSynthesizer