SynthesisVoicesResult Class

Package:

com.microsoft.cognitiveservices.speech

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.34.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.SynthesisVoicesResult

Implements

java.lang.AutoCloseable

public class SynthesisVoicesResult
implements java.lang.AutoCloseable

Contains detailed information about the retrieved synthesis voices list. Note: close() must be called in order to release underlying resources held by the object. Added in version 1.16.0

Constructor Summary

Modifier	Constructor	Description
protected	SynthesisVoicesResult(IntRef result)	PROTECTED

Method Summary

Modifier and Type	Method and Description
void	close() Explicitly frees any external resource attached to the object
java.lang.String	getErrorDetails() Gets the error details of the result.
SafeHandle	getImpl() Returns the synthesis result implementation.
PropertyCollection	getProperties() The set of properties exposed in the result.
ResultReason	getReason() Gets the reason the result was created.
java.lang.String	getResultId() Gets the unique ID of the result.
java.util.List<VoiceInfo>	getVoices() Gets the retrieved voices list

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

SynthesisVoicesResult

protected SynthesisVoicesResult(IntRef result)

PROTECTED

Parameters:

result - PROTECTED

Method Details

close

public void close()

Explicitly frees any external resource attached to the object

getErrorDetails

public String getErrorDetails()

Gets the error details of the result.

Returns:

The error details.

getImpl

public SafeHandle getImpl()

Returns the synthesis result implementation.

Returns:

The implementation of the result.

getProperties

public PropertyCollection getProperties()

The set of properties exposed in the result.

Returns:

The set of properties exposed in the result.

getReason

public ResultReason getReason()

Gets the reason the result was created.

Returns:

The reason of the result.

getResultId

public String getResultId()

Gets the unique ID of the result.

Returns:

The unique ID of the result.

getVoices

public List getVoices()

Gets the retrieved voices list

Returns:

The voices list