Package com.io7m.jsamplebuffer.api

Interface SampleBufferType

All Superinterfaces:

SampleBufferReadableType

All Known Implementing Classes:

SampleBufferDouble, SampleBufferFloat

public interface SampleBufferType
extends SampleBufferReadableType

A readable and writable sample buffer. All methods that take sample/frame indices as arguments throw com.io7m.jranges.RangeCheckException exceptions if the indices are out of range.

Method Summary

Modifier and Type	Method	Description
void	frameSetAll(long index, double value)	Set the value of frame index.
void	frameSetExact(long index, double c0)	Set the value of frame index.
void	frameSetExact(long index, double[] value)	Set the value of frame index.
void	frameSetExact(long index, double c0, double c1)	Set the value of frame index.

Methods inherited from interface com.io7m.jsamplebuffer.api.SampleBufferReadableType

channels, frameGetExact, frameGetExact, frames, sampleRate, samples

Method Detail

frameSetAll

void frameSetAll(long index,
                 double value)

Set the value of frame index. If the underlying buffer contains more than one channel, then the given value is inserted into all channels in the frame.

Parameters:

index - The frame index

value - The input

frameSetExact

void frameSetExact(long index,
                   double c0)
            throws java.lang.IllegalArgumentException

Set the value of frame index.

Parameters:

index - The frame index

c0 - The input for channel 0

Throws:

java.lang.IllegalArgumentException - If channels() != 1

frameSetExact

void frameSetExact(long index,
                   double c0,
                   double c1)
            throws java.lang.IllegalArgumentException

Set the value of frame index.

Parameters:

index - The frame index

c0 - The input for channel 0

c1 - The input for channel 1

Throws:

java.lang.IllegalArgumentException - If channels() != 2

frameSetExact

void frameSetExact(long index,
                   double[] value)
            throws java.lang.IllegalArgumentException

Set the value of frame index. The input value is assumed to contain one sample for each of the channels in the frame.

Parameters:

index - The frame index

value - The input

Throws:

java.lang.IllegalArgumentException - If value.length != channels()