SelectVoiceByHints Method (VoiceGender, VoiceAge, Int32, CultureInfo)

Microsoft Speech Platform SDK 11

previous page next page
Collapse imageExpand ImageCopy imageCopyHover image

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

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

Syntax

Visual Basic (Declaration)
Public Sub SelectVoiceByHints ( _
	gender As VoiceGender, _
	age As VoiceAge, _
	voiceAlternate As Integer, _
	culture As CultureInfo _
)
Visual Basic (Usage)
Dim instance As SpeechSynthesizer
Dim gender As VoiceGender
Dim age As VoiceAge
Dim voiceAlternate As Integer
Dim culture As CultureInfo

instance.SelectVoiceByHints(gender, age, _
	voiceAlternate, culture)
C#
public void SelectVoiceByHints(
	VoiceGender gender,
	VoiceAge age,
	int voiceAlternate,
	CultureInfo culture
)

Parameters

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

The gender of the voice to select.

age
Type: Microsoft.Speech.Synthesis..::..VoiceAge

The age of the voice to select.

voiceAlternate
Type: System..::..Int32

The position of the voice to select.

culture
Type: System.Globalization..::..CultureInfo

The locale of the voice to select.

Remarks

The SpeechSynthesizer object finds voices whose Gender, Age, and Culture properties match the gender, age, and culture parameters. The SpeechSynthesizer counts the matches it finds, and returns the voice when the count equals the voiceAlternate parameter.

For a given language code specified in the culture parameter, a speech synthesis engine that supports that language code must be installed to correctly pronounce words in the specified language.

The Microsoft Speech Platform SDK 11 and Microsoft Speech Platform SDK 11 do not include any engines for speech synthesis in a specific language. You must download a language pack (an engine for speech synthesis in a specific language) for each language in which you want to generate synthesized speech. See InstalledVoice for more information.

The Speech Platform SDK 11 accepts all valid language-country codes as values for culture. See Language Identifier Constants and Strings for a comprehensive list of language codes.

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(String) method.

See Also

previous page start next page