Package com.ibm.watson.speech_to_text.v1.model

Class AudioListing

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.AudioListing

All Implemented Interfaces:

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

public class AudioListing
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	Description
static interface	AudioListing.Status	_For an audio-type resource_, the status of the resource: * `ok`: The service successfully analyzed the audio data.

Constructor Summary

Constructors

Constructor	Description
AudioListing()

Method Summary

Modifier and Type	Method	Description
List<AudioResource>	getAudio()	Gets the audio.
AudioResource	getContainer()	Gets the container.
AudioDetails	getDetails()	Gets the details.
Long	getDuration()	Gets the duration.
String	getName()	Gets the name.
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

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AudioListing

public AudioListing()

Method Details

getDuration

public Long getDuration()

Gets the duration.

_For an audio-type resource_, the total seconds of audio in the resource. Omitted for an archive-type resource.

Returns:

the duration

getName

public String getName()

Gets the name.

_For an audio-type resource_, the user-specified name of the resource. Omitted for an archive-type resource.

Returns:

the name

getDetails

public AudioDetails getDetails()

Gets the details.

_For an audio-type resource_, an `AudioDetails` object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

Returns:

the details

getStatus

public String getStatus()

Gets the status.

_For an audio-type resource_, the status of the 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).

Omitted for an archive-type resource.

Returns:

the status

getContainer

public AudioResource getContainer()

Gets the container.

_For an archive-type resource_, an object of type `AudioResource` that provides information about the resource. Omitted for an audio-type resource.

Returns:

the container

getAudio

public List<AudioResource> getAudio()

Gets the audio.

_For an archive-type resource_, an array of `AudioResource` objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource.

Returns:

the audio