aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/jsyn/data/SequentialData.java
diff options
context:
space:
mode:
authorPhil Burk <[email protected]>2020-07-02 07:15:52 -0700
committerGitHub <[email protected]>2020-07-02 07:15:52 -0700
commit543be58aa9bcb31216a813e9bd602168d7f6bd00 (patch)
treee4c128a4aa824009b149df2e39903fb529116c23 /src/com/jsyn/data/SequentialData.java
parent0eb49ab0342fd0fd0660a845141dbc78508e9cd2 (diff)
parentae8aa40c8a3d432ac55deebfa006107adfaaaef3 (diff)
Merge pull request #78 from philburk/betterdocs
jsyn docs: various small improvements
Diffstat (limited to 'src/com/jsyn/data/SequentialData.java')
-rw-r--r--src/com/jsyn/data/SequentialData.java14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/com/jsyn/data/SequentialData.java b/src/com/jsyn/data/SequentialData.java
index c5ce2f0..0deb5c9 100644
--- a/src/com/jsyn/data/SequentialData.java
+++ b/src/com/jsyn/data/SequentialData.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -26,7 +26,7 @@ import com.jsyn.unitgen.VariableRateStereoReader;
/**
* Interface for objects that can be read and/or written by index. The index is not stored
* internally so they can be shared by multiple readers.
- *
+ *
* @author Phil Burk (C) 2010 Mobileer Inc
* @see FixedRateMonoReader
* @see FixedRateStereoReader
@@ -38,7 +38,7 @@ import com.jsyn.unitgen.VariableRateStereoReader;
public interface SequentialData {
/**
* Write a value at the given index.
- *
+ *
* @param index sample index is ((frameIndex * channelsPerFrame) + channelIndex)
* @param value the value to be written
*/
@@ -46,7 +46,7 @@ public interface SequentialData {
/**
* Read a value from the sample independently from the internal storage format.
- *
+ *
* @param index sample index is ((frameIndex * channelsPerFrame) + channelIndex)
*/
@@ -60,7 +60,7 @@ public interface SequentialData {
/**
* SustainEnd value is the frame index of the frame just past the end of the loop. The number of
* frames included in the loop is (SustainEnd - SustainBegin).
- *
+ *
* @return End of sustain loop or -1 if no loop.
*/
public int getSustainEnd();
@@ -78,7 +78,7 @@ public interface SequentialData {
/**
* Get rate to play the data. In an envelope this correspond to the inverse of the frame
* duration and would vary frame to frame. For an audio sample it is 1.0.
- *
+ *
* @param index
* @param synthesisRate
* @return rate to scale the playback speed.