Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-11-16 16:48:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc'ing

Browse source
This commit is contained in:
Yotam Mann 2015-12-08 00:07:16 -05:00
parent ea70dde445
commit cfc33cf39c
7 changed files with 34 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Tone/core/Transport.js
View file

@ -241,8 +241,8 @@ function(Tone){
/**
* Schedule an event along the timeline.
* @param {TimelineEvent} event
* @param {Time} time
* @param {Function} callback The callback to be invoked at the time.
* @param {Time} time The time to invoke the callback at.
* @return {Number} The id of the event which can be used for canceling the event.
* @example
* //trigger the callback when the Transport reaches the desired time
@ -748,6 +748,7 @@ function(Tone){
* Tone.Transport.setInterval(function(time){
* envelope.triggerAttack(time);
* }, "8n");
* @private
*/
Tone.Transport.prototype.setInterval = function(callback, interval){
console.warn("This method is deprecated. Use Tone.Transport.scheduleRepeat instead.");
@ -760,6 +761,7 @@ function(Tone){
* @param {number} intervalID The ID of interval to remove. The interval
* ID is given as the return value in Tone.Transport.setInterval.
* @return {boolean} true if the event was removed
* @private
*/
Tone.Transport.prototype.clearInterval = function(id){
console.warn("This method is deprecated. Use Tone.Transport.clear instead.");
@ -780,6 +782,7 @@ function(Tone){
* Tone.Transport.setTimeout(function(time){
* player.start(time);
* }, 1)
* @private
*/
Tone.Transport.prototype.setTimeout = function(callback, timeout){
console.warn("This method is deprecated. Use Tone.Transport.scheduleOnce instead.");
@ -792,6 +795,7 @@ function(Tone){
* @param {number} intervalID The ID of timeout to remove. The timeout
* ID is given as the return value in Tone.Transport.setTimeout.
* @return {boolean} true if the timeout was removed
* @private
*/
Tone.Transport.prototype.clearTimeout = function(id){
console.warn("This method is deprecated. Use Tone.Transport.clear instead.");
@ -812,6 +816,7 @@ function(Tone){
* Tone.Transport.setTimeline(function(time){
* part.start(time);
* }, "16m");
* @private
*/
Tone.Transport.prototype.setTimeline = function(callback, time){
console.warn("This method is deprecated. Use Tone.Transport.schedule instead.");
@ -823,6 +828,7 @@ function(Tone){
* Clear the timeline event.
* @param {number} id
* @return {boolean} true if it was removed
* @private
*/
Tone.Transport.prototype.clearTimeline = function(id){
console.warn("This method is deprecated. Use Tone.Transport.clear instead.");

2
Tone/core/Type.js
View file

@ -74,7 +74,7 @@ define(["Tone/core/Tone"], function (Tone) {
*/
BPM : "bpm",
/**
* The value must be greater than 0.
* The value must be greater than or equal to 0.
* @typedef {Positive}
*/
Positive : "positive",

6
Tone/effect/Tremolo.js
View file

@ -8,8 +8,8 @@ define(["Tone/core/Tone", "Tone/component/LFO", "Tone/effect/StereoEffect"], fun
*
* @extends {Tone.StereoEffect}
* @constructor
* @param {Frequency|Object} [frequency] The rate of the effect.
* @param {NormalRange} [depth] The depth of the wavering.
* @param {Frequency} [frequency] The rate of the effect.
* @param {NormalRange} [depth] The depth of the effect.
* @example
* //create a tremolo and start it's LFO
* var tremolo = new Tone.Tremolo(9, 0.75).toMaster().start();
@ -143,7 +143,7 @@ define(["Tone/core/Tone", "Tone/component/LFO", "Tone/effect/StereoEffect"], fun
};
/**
* Type of oscillator attached to the Tremolo.
* The Tremolo's oscillator type.
* @memberOf Tone.Tremolo#
* @type {string}
* @name type

7
Tone/event/Event.js
View file

@ -86,6 +86,9 @@ define(["Tone/core/Tone", "Tone/core/Transport", "Tone/core/Type", "Tone/core/Ti
* The probability that the callback will be invoked
* at the scheduled time.
* @type {NormalRange}
* @example
* //the callback will be invoked 50% of the time
* event.probability = 0.5;
*/
this.probability = options.probability;
@ -361,8 +364,8 @@ define(["Tone/core/Tone", "Tone/core/Transport", "Tone/core/Type", "Tone/core/Ti
/**
* The current progress of the loop interval.
* Returns 0 if the atom is not started yet or the
* atom is not set to loop.
* Returns 0 if the event is not started yet or
* it is not set to loop.
* @memberOf Tone.Event#
* @type {NormalRange}
* @name progress

2
Tone/event/Loop.js
View file

@ -69,7 +69,7 @@ define(["Tone/core/Tone", "Tone/event/Event"], function (Tone) {
};
/**
* Stop the arpeggio at the given time.
* Stop the loop at the given time.
* @param {Time=} time When to stop the Arpeggio
* @return {Tone.Loop} this
*/

9
Tone/event/Part.js
View file

@ -16,9 +16,9 @@ define(["Tone/core/Tone", "Tone/event/Event", "Tone/core/Type", "Tone/core/Trans
* synth.triggerAttackRelease(note, "8n", time);
* }, [[0, "C2"], ["0:2", "C3"], ["0:3:2", "G2"]]);
* @example
* //use JSON as long as the object has a "time" attribute
* //use an array of objects as long as the object has a "time" attribute
* var part = new Tone.Part(function(time, value){
* //the value is an object which contains both the ntoe and the velocity
* //the value is an object which contains both the note and the velocity
* synth.triggerAttackRelease(value.note, "8n", time, value.velocity);
* }, [{"time" : 0, "note" : "C3", "velocity": 0.9},
* {"time" : "0:2", "note" : "C4", "velocity": 0.5}
@ -259,7 +259,7 @@ define(["Tone/core/Tone", "Tone/event/Event", "Tone/core/Type", "Tone/core/Trans
};
/**
* Add a note or part to the part.
* Add a an event to the part.
* @param {Time} time The time the note should start.
* If an object is passed in, it should
* have a 'time' attribute and the rest
@ -321,7 +321,7 @@ define(["Tone/core/Tone", "Tone/event/Event", "Tone/core/Type", "Tone/core/Trans
/**
* Remove an event from the part. Will recursively iterate
* into the sub-parts to find the event
* into nested parts to find the event.
* @param {Time} time The time of the event
* @param {*} value Optionally select only a specific event value
*/
@ -455,6 +455,7 @@ define(["Tone/core/Tone", "Tone/event/Event", "Tone/core/Type", "Tone/core/Trans
* @example
* event.humanize = true;
* @type {Boolean|Time}
* @name humanize
*/
Object.defineProperty(Tone.Part.prototype, "humanize", {
get : function(){

14
Tone/event/Sequence.js
View file

@ -6,11 +6,12 @@ define(["Tone/core/Tone", "Tone/event/Part", "Tone/core/Transport"], function (T
* @class A sequence is an alternate notation of a part. Instead
* of passing in an array of [time, event] pairs, pass
* in an array of events which will be spaced at the
* given subdivision. Subdivisions are given
* as sub arrays and will be devided according to how many items are in the array.
* given subdivision. Sub-arrays will subdivide that beat
* by the number of items are in the array.
* Sequence notation inspiration from [Tidal](http://yaxu.org/tidal/)
* @param {Function} callback The callback to invoke with every note
* @param {Array} events The sequence
* @param {Time} subdivision The subdivision between which events are placed.
* @extends {Tone.Part}
* @example
* var seq = new Tone.Sequence(function(time, note){
@ -81,12 +82,17 @@ define(["Tone/core/Tone", "Tone/event/Part", "Tone/core/Transport"], function (T
});
/**
* Get/Set an index of the sequence
* Get/Set an index of the sequence. If the index contains a subarray,
* a Tone.Sequence representing that sub-array will be returned.
* @example
* var sequence = new Tone.Sequence(playNote, ["E4", "C4", "F#4", "A4"])
* var sequence = new Tone.Sequence(playNote, ["E4", "C4", "F#4", ["A4", "Bb3"]])
* sequence.at(0)// => returns "E4"
* //set a value
* sequence.at(0, "G3");
* //get a nested sequence
* sequence.at(3).at(1)// => returns "Bb3"
* @param {Positive} index The index to get or set
* @param {*} value Optionally pass in the value to set at the given index.
*/
Tone.Sequence.prototype.at = function(index, value){
//if the value is an array,