Module org.refcodes.audio

Package org.refcodes.audio

Interface SoundSampleReader

All Superinterfaces:

AutoCloseable, org.refcodes.mixin.IndexAccessor, org.refcodes.io.RowReader<SoundSample>, SampleReader<SoundSample>, SamplingRateAccessor

All Known Implementing Classes:

CsvSoundSampleReader

public interface SoundSampleReader
extends SampleReader<SoundSample>

The SoundSampleReader reads sound samples from a stream or a file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.IndexAccessor

org.refcodes.mixin.IndexAccessor.IndexBuilder<B extends org.refcodes.mixin.IndexAccessor.IndexBuilder<B>>, org.refcodes.mixin.IndexAccessor.IndexMutator, org.refcodes.mixin.IndexAccessor.IndexProperty

Nested classes/interfaces inherited from interface org.refcodes.audio.SamplingRateAccessor

SamplingRateAccessor.SamplingRateBuilder<B extends SamplingRateAccessor.SamplingRateBuilder<B>>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty

Method Summary

Modifier and Type	Method	Description
double[]	nextSampleData()	Reads the next samples, one sample for each channel.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.refcodes.mixin.IndexAccessor

getIndex

Methods inherited from interface org.refcodes.io.RowReader

hasNext, nextRaw, nextRow

Methods inherited from interface org.refcodes.audio.SampleReader

nextSample

Methods inherited from interface org.refcodes.audio.SamplingRateAccessor

getSamplingRate

Method Details

nextSampleData

double[] nextSampleData()
                 throws IOException

Reads the next samples, one sample for each channel. Provide one sample for mono audio, two samples for stereo audio and so on. In case you provide more or less samples than channels being supported by the writer, then it is up to the writer whether to duplicate the samples or calculate an average or the like.

Returns:

The samples, one for each channel.

Throws:

IOException - thrown in case there was an I/O related problem.