CONNECT Nexus UI/UX to Tone.js

https://tonejs.github.io/docs/r11/GrainPlayer
https://nexus-js.github.io/ui/
https://github.com/nexus-js/ui/

Tone.GrainPlayer implements granular synthesis. Granular Synthesis enables you to adjust pitch and playback rate independently. The grainSize is the amount of time each small chunk of audio is played for and the overlap is the amount of crossfading transition time between successive grains.

CONSTRUCTOR

new Tone.GrainPlayer ( 

url

 , [ 

callback

 ] )

url

The url to load, or the Tone.Buffer to play.

TYPE: String OR Tone.Buffer

callback

The callback to invoke after the url is loaded.

TYPE: Function

OPTIONAL

DEFAULTS

{

onload : Tone.noOp ,

overlap : 0.1 ,

grainSize : 0.2 ,

playbackRate : 1 ,

detune : 0 ,

loop : false ,

loopStart : 0 ,

loopEnd : 0 ,

reverse : false

}

MEMBERS
buffer
detune
grainSize
loopEnd
loopStart
overlap
playbackRate
reverse
context
fadeIn
fadeOut
mute
state
volume
METHODS
dispose
seek
start
connect
disconnect
toMaster
stop
sync
unsync

MEMBERS

.buffer

 ↝ Tone.Buffer #

The audio buffer belonging to the player.

</>

.detune

 ↝ Cents #

Adjust the pitch independently of the playbackRate.

</>

.grainSize

 ↝ Time #

The size of each chunk of audio that the buffer is chopped into and played back at.

</>

.loopEnd

 ↝ Time #

The loop end time.

</>

.loopStart

 ↝ Time #

The loop start time.

</>

.overlap

 ↝ Time #

This is the duration of the cross-fade between sucessive grains.

</>

.playbackRate

 ↝ Positive #

The playback rate of the sample

</>

.reverse

 ↝ Boolean #

The direction the buffer should play in

</>

↳INHERITED FROM Tone.AudioNode

.context

 ↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>

↳INHERITED FROM Tone.Source

.fadeIn

 ↝ Time #

The fadeIn time of the amplitude envelope.

</>

↳INHERITED FROM Tone.Source

.fadeOut

 ↝ Time #

The fadeOut time of the amplitude envelope.

</>

↳INHERITED FROM Tone.Source

.mute

 ↝ Boolean #

Mute the output.

EXAMPLE

//mute the output
source.mute = true;

</>

↳INHERITED FROM Tone.Source

.state

 ↝ Tone.State READONLY #

Returns the playback state of the source, either “started” or “stopped”.

</>

↳INHERITED FROM Tone.Source

∿ 

.volume

 ↝ Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;

</>

METHODS

.dispose ( )

 #

↪ RETURNS Tone.GrainPlayer

this

Clean up

</>

.seek ( )

 #

offset

The offset to jump to.

TYPE: Time

time

When to make the jump.

TYPE: Time

OPTIONAL

↪ RETURNS Tone.GrainPlayer

this

Jump to a specific time and play it.

</>

.start ( )

 #

startTime

When the player should start.

TYPE: Time

DEFAULT: now

offset

The offset from the beginning of the sample to start at.

TYPE: Time

DEFAULT: 0

duration

How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)

TYPE: Time

OPTIONAL

↪ RETURNS Tone.GrainPlayer

this

Play the buffer at the given startTime. Optionally add an offset and/or duration which will play the buffer from a position within the buffer for the given duration.

</>

↳INHERITED FROM Tone.AudioNode

.connect ( )

 #

unit

TYPE: Tone OR AudioParam OR AudioNode

outputNum

optionally which output to connect from

TYPE: Number

DEFAULT: 0

inputNum

optionally which input to connect to

TYPE: Number

DEFAULT: 0

↪ RETURNS Tone.AudioNode

this

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

</>

↳INHERITED FROM Tone.AudioNode

.disconnect ( )

 #

output

Either the output index to disconnect if the output is an array, or the node to disconnect from.

TYPE: Number OR AudioNode

↪ RETURNS Tone.AudioNode

this

disconnect the output

</>

↳INHERITED FROM Tone.AudioNode

.toMaster ( )

 #

↪ RETURNS Tone.AudioNode

this

Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)

EXAMPLE

//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();

</>

↳INHERITED FROM Tone.Source

.stop ( )

 #

time

When the source should be stopped.

TYPE: Time

DEFAULT: now

↪ RETURNS Tone.Source

this

Stop the source at the specified time. If no time is given, stop the source now.

EXAMPLE

source.stop(); // stops the source immediately

</>

↳INHERITED FROM Tone.Source

.sync ( )

 #

↪ RETURNS Tone.Source

this

Sync the source to the Transport so that all subsequent calls to start and stop are synced to the TransportTime instead of the AudioContext time.

EXAMPLE

//sync the source so that it plays between 0 and 0.3 on the Transport's timeline
source.sync().start(0).stop(0.3);
//start the transport.
Tone.Transport.start();

 

EXAMPLE

//start the transport with an offset and the sync'ed sources
//will start in the correct position
source.sync().start(0.1);
//the source will be invoked with an offset of 0.4
Tone.Transport.start("+0.5", 0.5);

</>

↳INHERITED FROM Tone.Source

.unsync ( )

 #

↪ RETURNS Tone.Source

this

Unsync the source to the Transport. See Tone.Source.sync

Tone JS UI/UX Project Buffer Shuffler

https://tonejs.github.io/docs/

Tone.Buffer

↳ EXTENDS Tone

Buffer loading and storage. Tone.Buffer is used internally by all classes that make requests for audio files such as Tone.Player, Tone.Sampler and Tone.Convolver. Aside from load callbacks from individual buffers, Tone.Buffer provides events which keep track of the loading progress of all of the buffers. These are Tone.Buffer.on(“load” / “progress” / “error”)

CONSTRUCTOR

new Tone.Buffer ( 

url

 , [ 

onload

 ] , [ 

onerror

 ] )

url

The url to load, or the audio buffer to set.

TYPE: AudioBuffer OR String

onload

A callback which is invoked after the buffer is loaded. It’s recommended to use Tone.Buffer.on('load', callback) instead since it will give you a callback when all buffers are loaded.

TYPE: Function

OPTIONAL

onerror

The callback to invoke if there is an error

TYPE: Function

OPTIONAL

DEFAULTS

{

url : undefined ,

reverse : false

}

EXAMPLE

var buffer = new Tone.Buffer("path/to/sound.mp3", function(){
 //the buffer is now available.
 var buff = buffer.get();
});
 

EXAMPLE

//can load provide fallback extension types if the first type is not supported.
var buffer = new Tone.Buffer("path/to/sound.[mp3|ogg|wav]");

MEMBERS
duration
length
loaded
numberOfChannels
reverse
METHODS
dispose
fromArray
get
getChannelData
load
set
slice
toArray
toMono
STATIC METHODS
cancelDownloads
fromArray
load
supportsType

MEMBERS

.duration

 ↝ Number READONLY #

The duration of the buffer.

</>

.length

 ↝ Number READONLY #

The length of the buffer in samples

</>

.loaded

 ↝ Boolean READONLY #

If the buffer is loaded or not

</>

.numberOfChannels

 ↝ Number READONLY #

The number of discrete audio channels. Returns 0 if no buffer is loaded.

</>

.reverse

 ↝ Boolean #

Reverse the buffer.

</>

METHODS

.dispose ( )

 #

↪ RETURNS Tone.Buffer

this

dispose and disconnect

</>

.fromArray ( )

 #

array

The array to fill the audio buffer

TYPE: Float32Array

↪ RETURNS Tone.Buffer

this

Set the audio buffer from the array. To create a multichannel AudioBuffer, pass in a multidimensional array.

</>

.get ( )

 #

↪ RETURNS AudioBuffer

The audio buffer stored in the object.

</>

.getChannelData ( )

 #

channel

The channel number to return

TYPE: Number

↪ RETURNS Float32Array

The audio as a TypedArray

Returns the Float32Array representing the PCM audio data for the specific channel.

</>

.load ( )

 #

url

The url of the buffer to load. filetype support depends on the browser.

TYPE: String

↪ RETURNS Promise

returns a Promise which resolves with the Tone.Buffer

Makes an xhr reqest for the selected url then decodes the file as an audio buffer. Invokes the callback once the audio buffer loads.

</>

.set ( )

 #

buffer

the buffer

TYPE: AudioBuffer OR Tone.Buffer

↪ RETURNS Tone.Buffer

this

Pass in an AudioBuffer or Tone.Buffer to set the value of this buffer.

</>

.slice ( )

 #

start

The time to start the slice

TYPE: Time

end

The end time to slice. If none is given will default to the end of the buffer

TYPE: Time

OPTIONAL

↪ RETURNS Tone.Buffer

this

Cut a subsection of the array and return a buffer of the subsection. Does not modify the original buffer

</>

.toArray ( )

 #

channel

Optionally only copy a single channel from the array.

TYPE: Number

OPTIONAL

↪ RETURNS Array

Get the buffer as an array. Single channel buffers will return a 1-dimensional Float32Array, and multichannel buffers will return multidimensional arrays.

</>

.toMono ( )

 #

channel

Optionally only copy a single channel from the array.

TYPE: Number

OPTIONAL

↪ RETURNS Array

Sums muliple channels into 1 channel

</>

STATIC METHODS

.cancelDownloads ( )

 #

↪ RETURNS Tone.Buffer

Stop all of the downloads in progress

</>

.fromArray ( )

 #

array

The array to fill the audio buffer

TYPE: Float32Array

↪ RETURNS Tone.Buffer

A Tone.Buffer created from the array

Create a Tone.Buffer from the array. To create a multichannel AudioBuffer, pass in a multidimensional array.

</>

.load ( )

 #

url

TYPE: String

onload

TYPE: Function

onerror

TYPE: Function

onprogress

TYPE: Function

↪ RETURNS XMLHttpRequest

Loads a url using XMLHttpRequest.

</>

.supportsType ( )

 #

url

The url/extension to test

TYPE: String

↪ RETURNS Boolean

If the file extension can be played

Checks a url’s extension to see if the current browser can play that file type.

EXAMPLE

Tone.Buffer.supportsType("wav"); //returns true
Tone.Buffer.supportsType("path/to/file.wav"); //returns true