com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.yml

### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult"
fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult"
name: "SpeechSynthesisResult"
nameWithType: "SpeechSynthesisResult"
summary: "Contains detailed information about result of a speech synthesis operation."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **SpeechSynthesisResult**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.SpeechSynthesisResult(com.microsoft.cognitiveservices.speech.util.IntRef)"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.SpeechSynthesisResult(IntRef result)"
  name: "SpeechSynthesisResult(IntRef result)"
  nameWithType: "SpeechSynthesisResult.SpeechSynthesisResult(IntRef result)"
  summary: "PROTECTED"
  modifiers:
  - "protected"
  parameters:
  - description: "PROTECTED"
    name: "result"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.IntRef?alt=com.microsoft.cognitiveservices.speech.util.IntRef&text=IntRef\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected SpeechSynthesisResult(IntRef result)"
  desc: "PROTECTED"
methods:
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.close()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.close()"
  name: "close()"
  nameWithType: "SpeechSynthesisResult.close()"
  summary: "Explicitly frees any external resource attached to the object"
  syntax: "public void close()"
  desc: "Explicitly frees any external resource attached to the object"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioData()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioData()"
  name: "getAudioData()"
  nameWithType: "SpeechSynthesisResult.getAudioData()"
  summary: "Gets the synthesized audio from the result."
  syntax: "public byte[] getAudioData()"
  desc: "Gets the synthesized audio from the result."
  returns:
    description: "Synthesized audio."
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioDuration()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioDuration()"
  name: "getAudioDuration()"
  nameWithType: "SpeechSynthesisResult.getAudioDuration()"
  summary: "Gets the time duration of synthesized audio, by ticks (100ns)."
  syntax: "public long getAudioDuration()"
  desc: "Gets the time duration of synthesized audio, by ticks (100ns). Only valid for completed synthesis."
  returns:
    description: "Time duration of synthesized audio, by ticks (100ns)."
    type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioLength()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getAudioLength()"
  name: "getAudioLength()"
  nameWithType: "SpeechSynthesisResult.getAudioLength()"
  summary: "Gets the size of synthesized audio in bytes."
  syntax: "public long getAudioLength()"
  desc: "Gets the size of synthesized audio in bytes."
  returns:
    description: "Length of synthesized audio."
    type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getImpl()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getImpl()"
  name: "getImpl()"
  nameWithType: "SpeechSynthesisResult.getImpl()"
  summary: "Returns the synthesis result implementation."
  syntax: "public SafeHandle getImpl()"
  desc: "Returns the synthesis result implementation."
  returns:
    description: "The implementation of the result."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getProperties()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getProperties()"
  name: "getProperties()"
  nameWithType: "SpeechSynthesisResult.getProperties()"
  summary: "The set of properties exposed in the result."
  syntax: "public PropertyCollection getProperties()"
  desc: "The set of properties exposed in the result."
  returns:
    description: "The set of properties exposed in the result."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.PropertyCollection?alt=com.microsoft.cognitiveservices.speech.PropertyCollection&text=PropertyCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getReason()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getReason()"
  name: "getReason()"
  nameWithType: "SpeechSynthesisResult.getReason()"
  summary: "Gets the reason the result was created."
  syntax: "public ResultReason getReason()"
  desc: "Gets the reason the result was created."
  returns:
    description: "Specifies reason of the result."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.ResultReason?alt=com.microsoft.cognitiveservices.speech.ResultReason&text=ResultReason\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getResultId()"
  fullName: "com.microsoft.cognitiveservices.speech.SpeechSynthesisResult.getResultId()"
  name: "getResultId()"
  nameWithType: "SpeechSynthesisResult.getResultId()"
  summary: "Gets the unique ID of the result."
  syntax: "public String getResultId()"
  desc: "Gets the unique ID of the result."
  returns:
    description: "Specifies unique ID of the result."
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Contains detailed information about result of a speech synthesis operation. Note: close() must be called in order to release underlying resources held by the object. Added in version 1.7.0"
implements:
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.cognitiveservices.speech"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0