com.ibm.watson.speech_to_text.v1.model

Class AudioResource

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.AudioResource

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class AudioResource
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Information about an audio resource from a custom acoustic model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioResource.Status The status of the audio resource: * `ok`: The service successfully analyzed the audio data.

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioDetails	details
protected java.lang.Long	duration
protected java.lang.String	name
protected java.lang.String	status

Constructor Summary

Constructors

Constructor and Description
AudioResource()

Method Summary

Methods

Modifier and Type	Method and Description
AudioDetails	getDetails() Gets the details.
java.lang.Long	getDuration() Gets the duration.
java.lang.String	getName() Gets the name.
java.lang.String	getStatus() Gets the status.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

duration

protected java.lang.Long duration

name

protected java.lang.String name

details

protected AudioDetails details

status

protected java.lang.String status

Constructor Detail

AudioResource

public AudioResource()

Method Detail

getDuration

public java.lang.Long getDuration()

Gets the duration.

The total seconds of audio in the audio resource.

Returns:

the duration

getName

public java.lang.String getName()

Gets the name.

**For an archive-type resource,** the user-specified name of the resource.

**For an audio-type resource,** the user-specified name of the resource or the name of the audio file that the user added for the resource. The value depends on the method that is called.

Returns:

the name

getDetails

public AudioDetails getDetails()

Gets the details.

An `AudioDetails` object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio.

Returns:

the details

getStatus

public java.lang.String getStatus()

Gets the status.

The status of the audio resource: * `ok`: The service successfully analyzed the audio data. The data can be used to train the custom model. * `being_processed`: The service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * `invalid`: The audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

Returns:

the status