SpeechSynthesizer::SelectVoiceByHints Method (VoiceGender, VoiceAge, Int32)

.NET Framework (current version)
 

Selects a voice with a specific gender and age, based on the position in which the voices are ordered.

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

C#
C++
F#
VB
Copy 
public:
void SelectVoiceByHints(
	VoiceGender gender,
	VoiceAge age,
	int voiceAlternate
)

Parameters

gender
Type: System.Speech.Synthesis::VoiceGender

The gender of the voice to select.

age
Type: System.Speech.Synthesis::VoiceAge

The age of the voice to select.

voiceAlternate
Type: System::Int32

The position of the voice to select.

Use the GetInstalledVoices method and VoiceInfo class to obtain the names of installed text-to-speech (TTS) voices that you can select. The SpeechSynthesizer object finds installed voices whose Gender and Age properties match the gender and age parameters. The SpeechSynthesizer counts the matches it finds, and returns the voice when the count equals the voiceAlternate parameter.

When an application calls GetInstalledVoices, the method verifies that each of the voices it finds in the registry meets certain minimum criteria. For any voice that fails verification, GetInstalledVoices sets its Enabled property to False. An application cannot select a voice whose Enabled property is False. Typically, applications will not set a voice’s Enabled property.

To select a voice based on other characteristics, see the other SelectVoiceByHints overloads.

To select a voice by name, use the SelectVoice method.

.NET Framework
Available since 3.0
Return to top
Show: