VoiceInformation Class
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.
Provides info about an installed speech synthesis engine (voice).
public ref class VoiceInformation sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class VoiceInformation final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class VoiceInformationPublic NotInheritable Class VoiceInformation- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
Only Microsoft-signed voices installed on the system can be used to generate speech with a SpeechSynthesizer. Each voice generates synthesized speech in a single language, as spoken in a specific country/region.
Here is a list of Microsoft-signed voices provided with Windows.
| Voice | Gender | Windows 8 | Windows 8.1 | Name | Display name |
|---|---|---|---|---|---|
| English US | Female | Y | Y | Zira | Microsoft Zira (en-US, female). |
| English US | Male | Y | Y | David | Microsoft David (en-US, male) |
| English GB | Female | Y | Y | Hazel | Microsoft Hazel (en-GB, female) |
| French FR | Female | Y | Y | Hortense | Microsoft Hortense (fr-FR , female) |
| German DE | Female | Y | Y | Hedda | Microsoft Hedda (de-DE, female) |
| Spanish ES | Female | Y | Y | Helena | Microsoft Helena (es-ES, female) |
| Chinese PRC | Female | Y | Y | Huihui | Microsoft Huihui (zh-CN, female) |
| Chinese TW | Female | Y | Y | Hanhan | Microsoft Hanhan (zh-TW, female) |
| Japanese JA | Female | Y | Y | Haruka | Microsoft Haruka (ja-JP, female) |
| Korean KR | Female | Y | Y | Heami | Microsoft Heami (ko-KR, female) |
| Spanish MX | Female | N | Y | Sabina | Microsoft Sabina (es-MX, female) |
| Italian IT | Female | N | Y | Elsa | Microsoft Elsa (it-IT, female) |
| English IN | Female | N | Y | Heera | Microsoft Heera (en-IN, female) |
| Russian RU | Female | N | Y | Irina | Microsoft Irina (ru-RU, female) |
| Chinese HK | Female | N | Y | Tracy | Microsoft Tracy (zh-HK, female) |
| Polish PL | Female | N | Y | Paulina | Microsoft Paulina (pl-PL, female) |
| Portuguese BR | Female | N | Y | Maria | Microsoft Maria (pt-BR, female) |
By default, a new SpeechSynthesizer object uses the current system voice (call DefaultVoice to find out what the default voice is).
To specify any of the other speech synthesis (text-to-speech) voices installed on the user's system, use the Voice method (to find out which voices are installed on the system, call AllVoices).
If you don't specify a language, the voice that most closely corresponds to the language selected in the Language control panel is loaded.
Properties
| Description |
Gets the description of the speech synthesis engine (voice). |
| DisplayName |
Gets the display name associated with the speech synthesis engine (voice). |
| Gender |
Gets the gender setting of the speech synthesis engine (voice). |
| Id |
Gets the unique ID of the speech synthesis engine (voice). |
| Language |
Gets the normalized BCP-47 language tag of the speech synthesis engine (voice). |