SpeechSynthesisRequest Class

Package:
com.microsoft.cognitiveservices.speech
Maven Artifact:
com.microsoft.cognitiveservices.speech:client-sdk:1.53.0
  • java.lang.Object
    • com.microsoft.cognitiveservices.speech.SpeechSynthesisRequest

Implements

java.lang.AutoCloseable

public class SpeechSynthesisRequest
implements java.lang.AutoCloseable

Constructor Summary

Constructor Description
SpeechSynthesisRequest(SpeechSynthesisRequest.SpeechSynthesisRequestInputType inputType)

Method Summary

Modifier and Type Method and Description
synchronized void close()

Releases the resources held by the request.
synchronized void finishInput()
SpeechSynthesisInputStream getInputStream()

Gets the input stream for the speech synthesis request.
SafeHandle getRequestHandle()
void sendTextPiece(String text)
void setPitch(String pitch)

Sets the pitch of the voice.
void setRate(String rate)

Sets the speaking rate of the voice.
void setStyle(String style)

Sets the style of the voice.
void setTemperature(double temperature)

Sets the temperature for voice synthesis.
void setVolume(String volume)

Sets the volume of the voice.

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

SpeechSynthesisRequest

public SpeechSynthesisRequest(SpeechSynthesisRequest.SpeechSynthesisRequestInputType inputType)

Parameters:

inputType

Method Details

close

public synchronized void close()

Releases the resources held by the request. If the input has not been finished yet, it is finished first, so that a synthesis that is waiting for more input can complete. Calling close() more than once is allowed.

finishInput

public synchronized void finishInput()

getInputStream

public SpeechSynthesisRequest.SpeechSynthesisInputStream getInputStream()

Gets the input stream for the speech synthesis request.

Returns:

The input stream.

getRequestHandle

public SafeHandle getRequestHandle()

sendTextPiece

public void sendTextPiece(String text)

Parameters:

text

setPitch

public void setPitch(String pitch)

Sets the pitch of the voice.

Parameters:

pitch - The pitch value (e.g., "high", "low", "+10%", "-10Hz").

setRate

public void setRate(String rate)

Sets the speaking rate of the voice.

Parameters:

rate - The rate value (e.g., "fast", "slow", "50%", "1.5").

setStyle

public void setStyle(String style)

Sets the style of the voice.

Parameters:

style - The style value.

setTemperature

public void setTemperature(double temperature)

Sets the temperature for voice synthesis.

Parameters:

temperature - The temperature value (0.0 to 2.0).

setVolume

public void setVolume(String volume)

Sets the volume of the voice.

Parameters:

volume - The volume value (e.g., "loud", "soft", "0.8", "80%").

Applies to