Module org.refcodes.audio

Package org.refcodes.audio

Interface SampleReader<S extends SoundSample>

Type Parameters:

S - The type of the sample to be used.

All Superinterfaces:

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

All Known Subinterfaces:

MonoSampleReader, SoundSampleReader

All Known Implementing Classes:

AbstractCsvSampleReader, CsvMonoSampleReader, CsvSoundSampleReader

public interface SampleReader<S extends SoundSample>
extends AutoCloseable, org.refcodes.io.RowReader<S>, SamplingRateAccessor, org.refcodes.mixin.IndexAccessor

The SampleReader 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
default S	nextSample()	Reads the next SoundSample, equivalent to RowReader.nextRow() with a semantically stronger method name..

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.SamplingRateAccessor

getSamplingRate

Method Details

nextSample

default S nextSample()
              throws IOException

Reads the next SoundSample, equivalent to RowReader.nextRow() with a semantically stronger method name..

Returns:

The accordingly read SoundSample.

Throws:

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