Share via

XSpeechSynthesizerVoiceInformation

  • Article

Provides information about a voice: an installed speech synthesis engine.

Syntax

typedef struct XSpeechSynthesizerVoiceInformation {  
    const char* Description;  
    const char* DisplayName;  
    XSpeechSynthesizerVoiceGender Gender;  
    const char* VoiceId;  
    const char* Language;  
} XSpeechSynthesizerVoiceInformation

Members

Description
Type: const char*

The voice's description that's based on a combination of DisplayName and Language.

DisplayName
Type: const char*

The display name of the voice.

Gender
Type: XSpeechSynthesizerVoiceGender

The gender of the voice.

VoiceId
Type: const char*

The unique ID of the voice.

Language
Type: const char*

The voice's language, represented by a normalized BCP-47 language tag.

Remarks

The XSpeechSynthesierVoiceInformation structure represents information about an installed speech synthesis engine, or voice; the information includes the voice's gender and language. Use the value of VoiceId to identify an installed voice when calling the XSpeechSynthesizerSetCustomVoice function.

For an example that demonstrates how to use the XSpeechSynthesizerVoiceInformation structure, see XSpeechSynthesizerEnumerateInstalledVoices.

Requirements

Header: XSpeechSynthesizer.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XAccessibility
XSpeechSynthesizerCreateStreamFromText
XSpeechSynthesizer