Cancels the asynchronous synthesis operation for a queued prompt.
Namespace:
Microsoft.Speech.Synthesis
Assembly:
Microsoft.Speech (in Microsoft.Speech.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Sub SpeakAsyncCancel ( _ prompt As Prompt _ ) |
| Visual Basic (Usage) |
|---|
Dim instance As SpeechSynthesizer Dim prompt As Prompt instance.SpeakAsyncCancel(prompt) |
| C# |
|---|
public void SpeakAsyncCancel( Prompt prompt ) |
Parameters
- prompt
- Type: Microsoft.Speech.Synthesis..::..Prompt
The content for which to cancel a speak operation.
Remarks
You can also use this method to cancel an asynchronous speak operation for the following:
The contents of a String specified by a SpeechSynthesizer..::..SpeakAsync(String) method.
The contents of a PromptBuilder specified by a SpeechSynthesizer..::..SpeakAsync(PromptBuilder) method.
The contents of a String containing SSML specified by a SpeakSsmlAsync(String) method.
When you call SpeechSynthesizer..::..SpeakAsync(String), SpeechSynthesizer..::..SpeakAsync(PromptBuilder), or SpeakSsmlAsync(String), the method creates a Prompt object and populates it with the contents of the method's parameter, and returns the Prompt object. If you retain a copy of the returned Prompt, you can pass it into SpeakAsyncCancel(Prompt) to cancel speaking content specified in a String or a PromptBuilder object.
See Also
