Package ai.djl.modality.audio

Class SampledAudioFactory

java.lang.Object

ai.djl.modality.audio.AudioFactory

ai.djl.modality.audio.SampledAudioFactory

public class SampledAudioFactory
extends AudioFactory

SampledAudioFactory is an implementation of ImageFactory using the Java Sampled Package.

See Also:

https://docs.oracle.com/javase/tutorial/sound/sampled-overview.html

Field Summary

Fields inherited from class ai.djl.modality.audio.AudioFactory

channels, sampleFormat, sampleRate

Constructor Summary

Constructors

Constructor	Description
SampledAudioFactory()

Method Summary

Modifier and Type	Method	Description
Audio	fromFile(java.nio.file.Path path)	Returns Audio from file.
Audio	fromInputStream(java.io.InputStream is)	Returns Audio from InputStream.
AudioFactory	setChannels(int channel)	Sets the number of channels for AudioFactory to use.
AudioFactory	setSampleFormat(int sampleFormat)	Sets the audio sample format for AudioFactory to use.
AudioFactory	setSampleRate(int sampleRate)	Sets the sampleRate for AudioFactory to use.

Methods inherited from class ai.djl.modality.audio.AudioFactory

fromData, fromNDArray, fromUrl, fromUrl, getChannels, getSampleFormat, getSampleRate, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SampledAudioFactory

public SampledAudioFactory()

Method Detail

setChannels

public AudioFactory setChannels(int channel)

Sets the number of channels for AudioFactory to use.

Overrides:

setChannels in class AudioFactory

Parameters:

channel - the number of channels for AudioFactory to use

Returns:

this factory

setSampleRate

public AudioFactory setSampleRate(int sampleRate)

Sets the sampleRate for AudioFactory to use.

Overrides:

setSampleRate in class AudioFactory

Parameters:

sampleRate - the sampleRate for AudioFactory to use

Returns:

this factory

setSampleFormat

public AudioFactory setSampleFormat(int sampleFormat)

Sets the audio sample format for AudioFactory to use.

Overrides:

setSampleFormat in class AudioFactory

Parameters:

sampleFormat - the sample format

Returns:

this factory.

fromFile

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

Returns Audio from file.

Specified by:

fromFile in class AudioFactory

Parameters:

path - the path to the audio

Returns:

Audio

Throws:

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

fromInputStream

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

Returns Audio from InputStream.

Specified by:

fromInputStream in class AudioFactory

Parameters:

is - InputStream

Returns:

Audio

Throws:

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