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

lookAhead -> latencyHint

Browse source 
more consistent with WAA spec
This commit is contained in:
Yotam Mann 2016-12-20 22:47:37 -05:00
parent 11e3504cab
commit 5d15ee324f
2 changed files with 23 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
Tone/core/Transport.js
View file

@ -641,41 +641,23 @@ function(Tone){
});
/**
* The amount of time that events are scheduled in advance.
* This value is the latency between when a callback is
* invoked and the AudioContext time that the event is scheduled for.
* This value also affects the size of the blocks that events are processed
* in. So if the lookAhead is set to 1 (second), the events are processed
* in 0.5 second blocks, that are at least 0.5 seconds in advance.
*
* In addition to setting the value in seconds, the lookAhead also
* accepts the strings "interactive" (prioritizes low latency),
* "playback" (prioritizes sustained playback), and "balanced" (balances
* latency and performance).
* @memberOf Tone.Transport#
* @type {Seconds|String}
* @name lookAhead
* The hint to the type of playback. Affects tradeoffs between audio
* output latency and responsiveness.
*
* In addition to setting the value in seconds, the latencyHint also
* accepts the strings "interactive" (prioritizes low latency),
* "playback" (prioritizes sustained playback), "balanced" (balances
* latency and performance), and "fastest" (lowest latency, might glitch more often).
* @memberOf Tone.Transport#
* @type {Seconds|String}
* @name latencyHint
*/
Object.defineProperty(Tone.Transport.prototype, "lookAhead", {
Object.defineProperty(Tone.Transport.prototype, "latencyHint", {
get : function(){
return Tone.Clock.lookAhead;
return Tone.Clock.latencyHint;
},
set : function(lA){
if (this.isString(lA)){
switch(lA){
case "interactive" :
this.lookAhead = 0.032;
break;
case "playback" :
this.lookAhead = 0.5;
break;
case "balanced" :
this.lookAhead = 0.1;
break;
}
} else {
Tone.Clock.lookAhead = lA;
}
set : function(hint){
Tone.Clock.latencyHint = hint;
}
});

18
test/core/Transport.js
View file

@ -714,20 +714,20 @@ function (Test, Transport, Tone, Offline, TransportTime) {
});
});
context("lookAhead", function(){
context("latencyHint", function(){
afterEach(resetTransport);
it ("can get/set the lookAhead in seconds", function(){
Tone.Transport.lookAhead = 0.2;
expect(Tone.Transport.lookAhead).to.be.a.number;
Tone.Transport.lookAhead = "interactive";
it ("can get/set the latencyHint in seconds", function(){
Tone.Transport.latencyHint = 0.2;
expect(Tone.Transport.latencyHint).to.be.a.number;
Tone.Transport.latencyHint = "interactive";
});
it ("can set the lookAhead to 'performance', 'interactive' and 'balanced'", function(){
Tone.Transport.lookAhead = "performance";
Tone.Transport.lookAhead = "balanced";
Tone.Transport.lookAhead = "interactive";
it ("can set the latencyHint to 'performance', 'interactive' and 'balanced'", function(){
Tone.Transport.latencyHint = "performance";
Tone.Transport.latencyHint = "balanced";
Tone.Transport.latencyHint = "interactive";
});
});