SelectVoiceByHints Method (VoiceGender)

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Selects a voice with a specific gender.

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

Syntax

Visual Basic (Declaration)
Public Sub SelectVoiceByHints ( _
	gender As VoiceGender _
)
Visual Basic (Usage)
Dim instance As SpeechSynthesizer
Dim gender As VoiceGender

instance.SelectVoiceByHints(gender)
C#
public void SelectVoiceByHints(
	VoiceGender gender
)

Parameters

gender
Type: Microsoft.Speech.Synthesis..::..VoiceGender

The gender of the voice to select.

Remarks

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 selects the first installed voice whose Gender property matches the gender 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 methods.

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

See Also