Package com.microsoft.cognitiveservices.speech

Class VoiceInfo

java.lang.Object

com.microsoft.cognitiveservices.speech.VoiceInfo

All Implemented Interfaces:

AutoCloseable

public class VoiceInfo
extends Object
implements AutoCloseable

Contains detailed information about the synthesis voice information. Note: close() must be called in order to release underlying resources held by the object. Updated in version 1.17.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VoiceInfo(IntRef result)	PROTECTED

Method Summary

Modifier and Type	Method	Description
void	close()	Explicitly frees any external resource attached to the object
SynthesisVoiceGender	getGender()	Gets the voice gender.
SafeHandle	getImpl()	Returns the vice info implementation.
String	getLocale()	Gets the locale of the voice.
String	getLocalName()	Gets the local name of the voice.
String	getName()	Gets the voice name.
PropertyCollection	getProperties()	The set of properties exposed in the result.
String	getShortName()	Gets the short name of the voice.
List<String>	getStyleList()	Gets the style list.
String	getVoicePath()	Gets the voice path, only valid for offline voices.
SynthesisVoiceType	getVoiceType()	Gets the voice type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoiceInfo

protected VoiceInfo(IntRef result)

PROTECTED

Parameters:

result - PROTECTED VoiceInfo

Method Detail

getName

public String getName()

Gets the voice name.

Returns:

The voice name.

getLocale

public String getLocale()

Gets the locale of the voice.

Returns:

The locale.

getShortName

public String getShortName()

Gets the short name of the voice.

Returns:

The short name.

getLocalName

public String getLocalName()

Gets the local name of the voice.

Returns:

The local name.

getGender

public SynthesisVoiceGender getGender()

Gets the voice gender. Added in version 1.17.0

Returns:

The voice gender.

getVoiceType

public SynthesisVoiceType getVoiceType()

Gets the voice type.

Returns:

The voice type.

getStyleList

public List<String> getStyleList()

Gets the style list.

Returns:

The style list.

getVoicePath

public String getVoicePath()

Gets the voice path, only valid for offline voices.

Returns:

The voice path.

getProperties

public PropertyCollection getProperties()

The set of properties exposed in the result.

Returns:

The set of properties exposed in the result.

close

public void close()

Explicitly frees any external resource attached to the object

Specified by:

close in interface AutoCloseable

getImpl

public SafeHandle getImpl()

Returns the vice info implementation.

Returns:

The implementation handle.