Package ai.djl.modality.audio

Class AudioFactory

java.lang.Object

ai.djl.modality.audio.AudioFactory

Direct Known Subclasses:

SampledAudioFactory

public abstract class AudioFactory
extends java.lang.Object

AudioFactory contains audio creation mechanism on top of different platforms like PC and Android. System will choose appropriate Factory based on the supported audio type.

Constructor Summary

Constructors

Constructor	Description
AudioFactory()

Method Summary

Modifier and Type	Method	Description
abstract Audio	fromData(float[] data)	Returns Audio from raw data.
abstract Audio	fromFile(java.nio.file.Path path)	Returns Audio from file.
abstract Audio	fromInputStream(java.io.InputStream is)	Returns Audio from InputStream.
abstract Audio	fromNDArray(NDArray array)	Returns Audio from NDArray.
Audio	fromUrl(java.lang.String url)	Returns Audio from URL.
Audio	fromUrl(java.net.URL url)	Returns Audio from URL.
static AudioFactory	getInstance()	Gets new instance of Audio factory from the provided factory implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioFactory

public AudioFactory()

Method Detail

getInstance

public static AudioFactory getInstance()

Gets new instance of Audio factory from the provided factory implementation.

Returns:

AudioFactory

fromFile

public abstract Audio fromFile(java.nio.file.Path path)
                        throws java.io.IOException

Returns Audio from file.

Parameters:

path - the path to the audio

Returns:

Audio

Throws:

java.io.IOException - Audio not found or not readable

fromUrl

public Audio fromUrl(java.net.URL url)
              throws java.io.IOException

Returns Audio from URL.

Parameters:

url - the URL to load from

Returns:

Audio

Throws:

java.io.IOException - URL is not valid.

fromUrl

public Audio fromUrl(java.lang.String url)
              throws java.io.IOException

Returns Audio from URL.

Parameters:

url - the String represent URL to load from

Returns:

Audio

Throws:

java.io.IOException - URL is not valid.

fromInputStream

public abstract Audio fromInputStream(java.io.InputStream is)
                               throws java.io.IOException

Returns Audio from InputStream.

Parameters:

is - InputStream

Returns:

Audio

Throws:

java.io.IOException - image cannot be read from input stream.

fromData

public abstract Audio fromData(float[] data)

Returns Audio from raw data.

Parameters:

data - the raw data in float array form.

Returns:

Audio

fromNDArray

public abstract Audio fromNDArray(NDArray array)

Returns Audio from NDArray.

Parameters:

array - the NDArray with CHW format

Returns:

Audio