Methods > Init and info > SpeechVoiceAttributeGet method

Remarks

Obtains a specific attribute of the given voice.

For further details about sound generation see the SoundGeneratorMan object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.

For further details about sound composing see the SoundComposerMan object and the How to compose a sound tutorial.

Syntax

[Visual Basic]

Public Function SpeechVoiceAttributeGet (

nVoice as Int32,

nAttribute as enumSapiVoiceAttributes

) as String

[C#]

public string SpeechVoiceAttributeGet (

Int32 nVoice,

enumSapiVoiceAttributes nAttribute

);

[C++]

public: string SpeechVoiceAttributeGet (

Int32 nVoice,

enumSapiVoiceAttributes nAttribute

);

Parameter

Description

nVoice

Zero-based index of the speaking voice. The total number of voices installed inside the system can be obtained through the SoundGenerator.SpeechVoicesNumGet method.

nAttribute

Identifier of the attribute to get.

Supported values are the following:

Mnemonic Value	Value	Meaning
SAPI_VOICE_ATTRIBUTE_NAME	0	Name
SAPI_VOICE_ATTRIBUTE_AGE	1	Age
SAPI_VOICE_ATTRIBUTE_GENDER	2	Gender
SAPI_VOICE_ATTRIBUTE_LANGUAGE	3	Language
SAPI_VOICE_ATTRIBUTE_VENDOR	4	Vendor
SAPI_VOICE_ATTRIBUTE_VERSION	5	Version

Return value

Value	Meaning

Empty string	The information is not available or an error occurred (see the LastError property for further error details)
Valid string	String containing the specific attribute