Prompt Class

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Represents information about what can be rendered, either text or an audio file, by the SpeechSynthesizer.

Inheritance Hierarchy

System..::..Object
  Microsoft.Speech.Synthesis..::..Prompt
    Microsoft.Speech.Synthesis..::..FilePrompt

Namespace:  Microsoft.Speech.Synthesis
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

Visual Basic (Declaration)
Public Class Prompt
Visual Basic (Usage)
Dim instance As Prompt
C#
public class Prompt

Remarks

A Prompt object can contain plain text, text formatted with markup language, or audio files.

An empty Prompt object is created with each new instance of PromptBuilder. The PromptBuilder class provides methods for adding content, including text, SSML markup, bookmarks, and prerecorded audio files (such as .wav files), to the empty Prompt object that it contains. Typically, applications will use PromptBuilder, rather than a Prompt object, to create prompts and populate them with content.

To generate speech from the contents of a Prompt object, use the Speak(Prompt) method.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also