SpeechSynthesizer.SpeakAsyncCancel(Prompt) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Cancels the asynchronous synthesis operation for a queued prompt.
public:
void SpeakAsyncCancel(System::Speech::Synthesis::Prompt ^ prompt);public void SpeakAsyncCancel (System.Speech.Synthesis.Prompt prompt);member this.SpeakAsyncCancel : System.Speech.Synthesis.Prompt -> unitPublic Sub SpeakAsyncCancel (prompt As Prompt)Parameters
- prompt
- 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 method.
The contents of a PromptBuilder specified by a SpeechSynthesizer.SpeakAsync method.
The contents of a String containing SSML specified by a SpeakSsmlAsync method.
When you call SpeechSynthesizer.SpeakAsync, SpeechSynthesizer.SpeakAsync, or SpeakSsmlAsync, System.Speech 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 to cancel speaking content specified in a String or a PromptBuilder object.
