tone 14.9.12 → 14.9.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. package/Tone/component/analysis/Analyser.ts +3 -3
  2. package/Tone/component/analysis/DCMeter.ts +2 -1
  3. package/Tone/component/analysis/FFT.ts +3 -3
  4. package/Tone/component/analysis/Meter.ts +6 -5
  5. package/Tone/component/analysis/Waveform.ts +1 -1
  6. package/Tone/component/channel/Channel.ts +6 -6
  7. package/Tone/component/channel/MidSideMerge.ts +2 -2
  8. package/Tone/component/channel/MidSideSplit.ts +1 -1
  9. package/Tone/component/channel/Recorder.ts +1 -1
  10. package/Tone/component/dynamics/Gate.ts +4 -3
  11. package/Tone/component/dynamics/Limiter.ts +1 -1
  12. package/Tone/component/dynamics/MidSideCompressor.ts +3 -2
  13. package/Tone/component/dynamics/MultibandCompressor.ts +2 -1
  14. package/Tone/component/envelope/FrequencyEnvelope.ts +2 -2
  15. package/Tone/component/filter/BiquadFilter.ts +1 -1
  16. package/Tone/component/filter/LowpassCombFilter.ts +1 -1
  17. package/Tone/core/Global.ts +1 -1
  18. package/Tone/core/clock/TickParam.ts +2 -2
  19. package/Tone/core/clock/Transport.ts +1 -1
  20. package/Tone/core/clock/TransportEvent.ts +1 -1
  21. package/Tone/core/context/AbstractParam.ts +4 -4
  22. package/Tone/core/context/Context.ts +11 -10
  23. package/Tone/core/context/Listener.ts +1 -1
  24. package/Tone/core/context/Offline.ts +1 -1
  25. package/Tone/core/context/ToneAudioNode.ts +1 -1
  26. package/Tone/core/context/ToneWithContext.ts +1 -1
  27. package/Tone/core/type/Time.ts +1 -1
  28. package/Tone/core/worklet/ToneAudioWorkletProcessor.worklet.ts +1 -1
  29. package/Tone/effect/AutoPanner.ts +1 -1
  30. package/Tone/effect/AutoWah.ts +1 -1
  31. package/Tone/effect/Chorus.ts +4 -3
  32. package/Tone/effect/Freeverb.ts +1 -1
  33. package/Tone/effect/JCReverb.ts +2 -2
  34. package/Tone/effect/LFOEffect.ts +4 -2
  35. package/Tone/effect/Reverb.ts +3 -3
  36. package/Tone/effect/StereoXFeedbackEffect.ts +1 -1
  37. package/Tone/effect/Tremolo.ts +1 -1
  38. package/Tone/event/Pattern.ts +1 -1
  39. package/Tone/index.ts +15 -14
  40. package/Tone/instrument/DuoSynth.ts +1 -1
  41. package/Tone/instrument/Instrument.ts +1 -1
  42. package/Tone/instrument/MetalSynth.ts +2 -2
  43. package/Tone/instrument/NoiseSynth.ts +1 -1
  44. package/Tone/instrument/PluckSynth.ts +1 -1
  45. package/Tone/instrument/Sampler.ts +1 -1
  46. package/Tone/instrument/Synth.ts +1 -1
  47. package/Tone/signal/Add.ts +1 -1
  48. package/Tone/signal/AudioToGain.ts +1 -1
  49. package/Tone/signal/GainToAudio.ts +1 -1
  50. package/Tone/signal/Multiply.ts +1 -1
  51. package/Tone/signal/ScaleExp.ts +2 -2
  52. package/Tone/signal/Signal.ts +1 -1
  53. package/Tone/signal/SyncedSignal.ts +1 -1
  54. package/Tone/source/Source.ts +2 -1
  55. package/Tone/source/buffer/Player.ts +1 -1
  56. package/Tone/source/buffer/Players.ts +1 -1
  57. package/Tone/source/oscillator/LFO.ts +5 -3
  58. package/Tone/source/oscillator/OmniOscillator.ts +10 -9
  59. package/Tone/source/oscillator/Oscillator.ts +1 -1
  60. package/Tone/source/oscillator/ToneOscillatorNode.ts +1 -1
  61. package/Tone/version.ts +1 -1
  62. package/build/Tone.js +1 -1
  63. package/build/Tone.js.map +1 -1
  64. package/build/esm/component/analysis/Analyser.d.ts +3 -3
  65. package/build/esm/component/analysis/Analyser.js +3 -3
  66. package/build/esm/component/analysis/DCMeter.d.ts +2 -1
  67. package/build/esm/component/analysis/DCMeter.js +2 -1
  68. package/build/esm/component/analysis/DCMeter.js.map +1 -1
  69. package/build/esm/component/analysis/FFT.d.ts +3 -3
  70. package/build/esm/component/analysis/FFT.js +3 -3
  71. package/build/esm/component/analysis/Meter.d.ts +6 -5
  72. package/build/esm/component/analysis/Meter.js +6 -5
  73. package/build/esm/component/analysis/Meter.js.map +1 -1
  74. package/build/esm/component/analysis/Waveform.d.ts +1 -1
  75. package/build/esm/component/analysis/Waveform.js +1 -1
  76. package/build/esm/component/channel/Channel.d.ts +6 -6
  77. package/build/esm/component/channel/Channel.js +6 -6
  78. package/build/esm/component/channel/MidSideMerge.d.ts +2 -2
  79. package/build/esm/component/channel/MidSideMerge.js +1 -1
  80. package/build/esm/component/channel/MidSideSplit.d.ts +1 -1
  81. package/build/esm/component/channel/Recorder.d.ts +1 -1
  82. package/build/esm/component/channel/Recorder.js +1 -1
  83. package/build/esm/component/dynamics/Gate.d.ts +4 -3
  84. package/build/esm/component/dynamics/Gate.js +4 -3
  85. package/build/esm/component/dynamics/Gate.js.map +1 -1
  86. package/build/esm/component/dynamics/Limiter.d.ts +1 -1
  87. package/build/esm/component/dynamics/Limiter.js +1 -1
  88. package/build/esm/component/dynamics/MidSideCompressor.d.ts +3 -2
  89. package/build/esm/component/dynamics/MidSideCompressor.js +3 -2
  90. package/build/esm/component/dynamics/MidSideCompressor.js.map +1 -1
  91. package/build/esm/component/dynamics/MultibandCompressor.d.ts +2 -1
  92. package/build/esm/component/dynamics/MultibandCompressor.js +2 -1
  93. package/build/esm/component/dynamics/MultibandCompressor.js.map +1 -1
  94. package/build/esm/component/envelope/FrequencyEnvelope.d.ts +2 -2
  95. package/build/esm/component/envelope/FrequencyEnvelope.js +2 -2
  96. package/build/esm/component/filter/BiquadFilter.d.ts +1 -1
  97. package/build/esm/component/filter/BiquadFilter.js +1 -1
  98. package/build/esm/component/filter/LowpassCombFilter.d.ts +1 -1
  99. package/build/esm/component/filter/LowpassCombFilter.js +1 -1
  100. package/build/esm/core/Global.d.ts +1 -1
  101. package/build/esm/core/Global.js +1 -1
  102. package/build/esm/core/clock/TickParam.d.ts +2 -2
  103. package/build/esm/core/clock/TickParam.js +2 -2
  104. package/build/esm/core/clock/Transport.d.ts +1 -1
  105. package/build/esm/core/clock/Transport.js +1 -1
  106. package/build/esm/core/clock/TransportEvent.d.ts +1 -1
  107. package/build/esm/core/clock/TransportEvent.js +1 -1
  108. package/build/esm/core/context/AbstractParam.d.ts +4 -4
  109. package/build/esm/core/context/AbstractParam.js +1 -1
  110. package/build/esm/core/context/Context.d.ts +11 -10
  111. package/build/esm/core/context/Context.js +11 -10
  112. package/build/esm/core/context/Context.js.map +1 -1
  113. package/build/esm/core/context/Listener.d.ts +1 -1
  114. package/build/esm/core/context/Listener.js +1 -1
  115. package/build/esm/core/context/Offline.d.ts +1 -1
  116. package/build/esm/core/context/Offline.js +1 -1
  117. package/build/esm/core/context/ToneAudioNode.d.ts +1 -1
  118. package/build/esm/core/context/ToneAudioNode.js +1 -1
  119. package/build/esm/core/context/ToneWithContext.d.ts +1 -1
  120. package/build/esm/core/context/ToneWithContext.js +1 -1
  121. package/build/esm/core/type/Time.d.ts +1 -1
  122. package/build/esm/core/type/Time.js +1 -1
  123. package/build/esm/core/worklet/ToneAudioWorkletProcessor.worklet.js +1 -1
  124. package/build/esm/effect/AutoPanner.d.ts +1 -1
  125. package/build/esm/effect/AutoPanner.js +1 -1
  126. package/build/esm/effect/AutoWah.d.ts +1 -1
  127. package/build/esm/effect/AutoWah.js +1 -1
  128. package/build/esm/effect/Chorus.d.ts +4 -3
  129. package/build/esm/effect/Chorus.js +4 -3
  130. package/build/esm/effect/Chorus.js.map +1 -1
  131. package/build/esm/effect/Freeverb.d.ts +1 -1
  132. package/build/esm/effect/Freeverb.js +1 -1
  133. package/build/esm/effect/JCReverb.d.ts +2 -2
  134. package/build/esm/effect/JCReverb.js +2 -2
  135. package/build/esm/effect/LFOEffect.d.ts +4 -2
  136. package/build/esm/effect/LFOEffect.js +4 -2
  137. package/build/esm/effect/LFOEffect.js.map +1 -1
  138. package/build/esm/effect/Reverb.d.ts +3 -3
  139. package/build/esm/effect/Reverb.js +3 -3
  140. package/build/esm/effect/StereoXFeedbackEffect.d.ts +1 -1
  141. package/build/esm/effect/StereoXFeedbackEffect.js +1 -1
  142. package/build/esm/effect/Tremolo.d.ts +1 -1
  143. package/build/esm/effect/Tremolo.js +1 -1
  144. package/build/esm/event/Pattern.d.ts +1 -1
  145. package/build/esm/event/Pattern.js +1 -1
  146. package/build/esm/index.d.ts +16 -15
  147. package/build/esm/index.js +14 -14
  148. package/build/esm/index.js.map +1 -1
  149. package/build/esm/instrument/DuoSynth.d.ts +1 -1
  150. package/build/esm/instrument/DuoSynth.js +1 -1
  151. package/build/esm/instrument/Instrument.d.ts +1 -1
  152. package/build/esm/instrument/Instrument.js +1 -1
  153. package/build/esm/instrument/MetalSynth.d.ts +2 -2
  154. package/build/esm/instrument/MetalSynth.js +1 -1
  155. package/build/esm/instrument/NoiseSynth.d.ts +1 -1
  156. package/build/esm/instrument/NoiseSynth.js +1 -1
  157. package/build/esm/instrument/PluckSynth.d.ts +1 -1
  158. package/build/esm/instrument/PluckSynth.js +1 -1
  159. package/build/esm/instrument/Sampler.d.ts +1 -1
  160. package/build/esm/instrument/Sampler.js +1 -1
  161. package/build/esm/instrument/Synth.d.ts +1 -1
  162. package/build/esm/instrument/Synth.js +1 -1
  163. package/build/esm/signal/Add.d.ts +1 -1
  164. package/build/esm/signal/AudioToGain.d.ts +1 -1
  165. package/build/esm/signal/AudioToGain.js +1 -1
  166. package/build/esm/signal/GainToAudio.d.ts +1 -1
  167. package/build/esm/signal/GainToAudio.js +1 -1
  168. package/build/esm/signal/Multiply.d.ts +1 -1
  169. package/build/esm/signal/ScaleExp.d.ts +2 -2
  170. package/build/esm/signal/ScaleExp.js +2 -2
  171. package/build/esm/signal/Signal.d.ts +1 -1
  172. package/build/esm/signal/Signal.js +1 -1
  173. package/build/esm/signal/SyncedSignal.d.ts +1 -1
  174. package/build/esm/signal/SyncedSignal.js +1 -1
  175. package/build/esm/source/Source.d.ts +2 -1
  176. package/build/esm/source/Source.js +2 -1
  177. package/build/esm/source/Source.js.map +1 -1
  178. package/build/esm/source/buffer/Player.d.ts +1 -1
  179. package/build/esm/source/buffer/Player.js +1 -1
  180. package/build/esm/source/buffer/Players.d.ts +1 -1
  181. package/build/esm/source/buffer/Players.js +1 -1
  182. package/build/esm/source/oscillator/LFO.d.ts +5 -3
  183. package/build/esm/source/oscillator/LFO.js +5 -3
  184. package/build/esm/source/oscillator/LFO.js.map +1 -1
  185. package/build/esm/source/oscillator/OmniOscillator.d.ts +10 -9
  186. package/build/esm/source/oscillator/OmniOscillator.js +10 -9
  187. package/build/esm/source/oscillator/OmniOscillator.js.map +1 -1
  188. package/build/esm/source/oscillator/Oscillator.d.ts +1 -1
  189. package/build/esm/source/oscillator/Oscillator.js +1 -1
  190. package/build/esm/source/oscillator/ToneOscillatorNode.d.ts +1 -1
  191. package/build/esm/source/oscillator/ToneOscillatorNode.js +1 -1
  192. package/build/esm/version.js +1 -1
  193. package/package.json +1 -1
@@ -12,7 +12,7 @@ import { assertRange } from "../core/util/Debug";
12
12
  * Generates an Impulse Response Buffer
13
13
  * with Tone.Offline then feeds the IR into ConvolverNode.
14
14
  * The impulse response generation is async, so you have
15
- * to wait until [[ready]] resolves before it will make a sound.
15
+ * to wait until {@link ready} resolves before it will make a sound.
16
16
  *
17
17
  * Inspiration from [ReverbGen](https://github.com/adelespinasse/reverbGen).
18
18
  * Copyright (c) 2014 Alan deLespinasse Apache 2.0 License.
@@ -28,8 +28,8 @@ export class Reverb extends Effect {
28
28
  */
29
29
  this._convolver = this.context.createConvolver();
30
30
  /**
31
- * Resolves when the reverb buffer is generated. Whenever either [[decay]]
32
- * or [[preDelay]] are set, you have to wait until [[ready]] resolves
31
+ * Resolves when the reverb buffer is generated. Whenever either {@link decay}
32
+ * or {@link preDelay} are set, you have to wait until {@link ready} resolves
33
33
  * before the IR is generated with the latest values.
34
34
  */
35
35
  this.ready = Promise.resolve();
@@ -4,7 +4,7 @@ export interface StereoXFeedbackEffectOptions extends StereoFeedbackEffectOption
4
4
  feedback: NormalRange;
5
5
  }
6
6
  /**
7
- * Just like a [[StereoFeedbackEffect]], but the feedback is routed from left to right
7
+ * Just like a {@link StereoFeedbackEffect}, but the feedback is routed from left to right
8
8
  * and right to left instead of on the same channel.
9
9
  * ```
10
10
  * +--------------------------------+ feedbackL <-----------------------------------+
@@ -1,7 +1,7 @@
1
1
  import { StereoFeedbackEffect } from "./StereoFeedbackEffect";
2
2
  import { readOnly } from "../core/util/Interface";
3
3
  /**
4
- * Just like a [[StereoFeedbackEffect]], but the feedback is routed from left to right
4
+ * Just like a {@link StereoFeedbackEffect}, but the feedback is routed from left to right
5
5
  * and right to left instead of on the same channel.
6
6
  * ```
7
7
  * +--------------------------------+ feedbackL <-----------------------------------+
@@ -9,7 +9,7 @@ export interface TremoloOptions extends StereoEffectOptions {
9
9
  spread: Degrees;
10
10
  }
11
11
  /**
12
- * Tremolo modulates the amplitude of an incoming signal using an [[LFO]].
12
+ * Tremolo modulates the amplitude of an incoming signal using an {@link LFO}.
13
13
  * The effect is a stereo effect where the modulation phase is inverted in each channel.
14
14
  *
15
15
  * @example
@@ -5,7 +5,7 @@ import { Signal } from "../signal/Signal";
5
5
  import { optionsFromArguments } from "../core/util/Defaults";
6
6
  import { readOnly } from "../core/util/Interface";
7
7
  /**
8
- * Tremolo modulates the amplitude of an incoming signal using an [[LFO]].
8
+ * Tremolo modulates the amplitude of an incoming signal using an {@link LFO}.
9
9
  * The effect is a stereo effect where the modulation phase is inverted in each channel.
10
10
  *
11
11
  * @example
@@ -68,7 +68,7 @@ export declare class Pattern<ValueType> extends Loop<PatternOptions<ValueType>>
68
68
  */
69
69
  get index(): number | undefined;
70
70
  /**
71
- * The pattern type. See Tone.CtrlPattern for the full list of patterns.
71
+ * The pattern type.
72
72
  */
73
73
  get pattern(): PatternName;
74
74
  set pattern(pattern: PatternName);
@@ -61,7 +61,7 @@ export class Pattern extends Loop {
61
61
  return this._index;
62
62
  }
63
63
  /**
64
- * The pattern type. See Tone.CtrlPattern for the full list of patterns.
64
+ * The pattern type.
65
65
  */
66
66
  get pattern() {
67
67
  return this._type;
@@ -1,4 +1,5 @@
1
1
  export { getContext, setContext } from "./core/Global";
2
+ import { BaseContext } from "./core/context/BaseContext";
2
3
  export * from "./classes";
3
4
  export * from "./version";
4
5
  import { ToneAudioBuffer } from "./core/context/ToneAudioBuffer";
@@ -6,33 +7,33 @@ export { start } from "./core/Global";
6
7
  import { Seconds } from "./core/type/Units";
7
8
  export { supported } from "./core/context/AudioContext";
8
9
  /**
9
- * The current audio context time of the global [[Context]].
10
- * See [[Context.now]]
10
+ * The current audio context time of the global {@link BaseContext}.
11
+ * @see {@link BaseContext.now}
11
12
  * @category Core
12
13
  */
13
14
  export declare function now(): Seconds;
14
15
  /**
15
- * The current audio context time of the global [[Context]] without the [[Context.lookAhead]]
16
- * See [[Context.immediate]]
16
+ * The current audio context time of the global {@link BaseContext} without the {@link BaseContext.lookAhead}
17
+ * @see {@link BaseContext.immediate}
17
18
  * @category Core
18
19
  */
19
20
  export declare function immediate(): Seconds;
20
21
  /**
21
22
  * The Transport object belonging to the global Tone.js Context.
22
- * See [[TransportClass]]
23
+ * @see {@link TransportClass}
23
24
  * @category Core
24
25
  * @deprecated Use {@link getTransport} instead
25
26
  */
26
27
  export declare const Transport: import("./core/clock/Transport").TransportClass;
27
28
  /**
28
29
  * The Transport object belonging to the global Tone.js Context.
29
- * See [[TransportClass]]
30
+ * @see {@link TransportClass}
30
31
  * @category Core
31
32
  */
32
33
  export declare function getTransport(): import("./core/clock/Transport").TransportClass;
33
34
  /**
34
35
  * The Destination (output) belonging to the global Tone.js Context.
35
- * See [[DestinationClass]]
36
+ * @see {@link DestinationClass}
36
37
  * @category Core
37
38
  * @deprecated Use {@link getDestination} instead
38
39
  */
@@ -43,24 +44,24 @@ export declare const Destination: import("./core/context/Destination").Destinati
43
44
  export declare const Master: import("./core/context/Destination").DestinationClass;
44
45
  /**
45
46
  * The Destination (output) belonging to the global Tone.js Context.
46
- * See [[DestinationClass]]
47
+ * @see {@link DestinationClass}
47
48
  * @category Core
48
49
  */
49
50
  export declare function getDestination(): import("./core/context/Destination").DestinationClass;
50
51
  /**
51
- * The [[ListenerClass]] belonging to the global Tone.js Context.
52
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
52
53
  * @category Core
53
54
  * @deprecated Use {@link getListener} instead
54
55
  */
55
56
  export declare const Listener: import("./core/context/Listener").ListenerClass;
56
57
  /**
57
- * The [[ListenerClass]] belonging to the global Tone.js Context.
58
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
58
59
  * @category Core
59
60
  */
60
61
  export declare function getListener(): import("./core/context/Listener").ListenerClass;
61
62
  /**
62
63
  * Draw is used to synchronize the draw frame with the Transport's callbacks.
63
- * See [[DrawClass]]
64
+ * @see {@link DrawClass}
64
65
  * @category Core
65
66
  * @deprecated Use {@link getDraw} instead
66
67
  */
@@ -68,19 +69,19 @@ export declare const Draw: import("./core/util/Draw").DrawClass;
68
69
  /**
69
70
  * Get the singleton attached to the global context.
70
71
  * Draw is used to synchronize the draw frame with the Transport's callbacks.
71
- * See [[DrawClass]]
72
+ * @see {@link DrawClass}
72
73
  * @category Core
73
74
  */
74
75
  export declare function getDraw(): import("./core/util/Draw").DrawClass;
75
76
  /**
76
77
  * A reference to the global context
77
- * See [[Context]]
78
+ * @see {@link BaseContext}
78
79
  * @deprecated Use {@link getContext} instead
79
80
  */
80
- export declare const context: import("./classes").BaseContext;
81
+ export declare const context: BaseContext;
81
82
  /**
82
83
  * Promise which resolves when all of the loading promises are resolved.
83
- * Alias for static [[ToneAudioBuffer.loaded]] method.
84
+ * Alias for static {@link ToneAudioBuffer.loaded} method.
84
85
  * @category Core
85
86
  */
86
87
  export declare function loaded(): Promise<void>;
@@ -6,16 +6,16 @@ import { ToneAudioBuffer } from "./core/context/ToneAudioBuffer";
6
6
  export { start } from "./core/Global";
7
7
  export { supported } from "./core/context/AudioContext";
8
8
  /**
9
- * The current audio context time of the global [[Context]].
10
- * See [[Context.now]]
9
+ * The current audio context time of the global {@link BaseContext}.
10
+ * @see {@link BaseContext.now}
11
11
  * @category Core
12
12
  */
13
13
  export function now() {
14
14
  return getContext().now();
15
15
  }
16
16
  /**
17
- * The current audio context time of the global [[Context]] without the [[Context.lookAhead]]
18
- * See [[Context.immediate]]
17
+ * The current audio context time of the global {@link BaseContext} without the {@link BaseContext.lookAhead}
18
+ * @see {@link BaseContext.immediate}
19
19
  * @category Core
20
20
  */
21
21
  export function immediate() {
@@ -23,14 +23,14 @@ export function immediate() {
23
23
  }
24
24
  /**
25
25
  * The Transport object belonging to the global Tone.js Context.
26
- * See [[TransportClass]]
26
+ * @see {@link TransportClass}
27
27
  * @category Core
28
28
  * @deprecated Use {@link getTransport} instead
29
29
  */
30
30
  export const Transport = getContext().transport;
31
31
  /**
32
32
  * The Transport object belonging to the global Tone.js Context.
33
- * See [[TransportClass]]
33
+ * @see {@link TransportClass}
34
34
  * @category Core
35
35
  */
36
36
  export function getTransport() {
@@ -38,7 +38,7 @@ export function getTransport() {
38
38
  }
39
39
  /**
40
40
  * The Destination (output) belonging to the global Tone.js Context.
41
- * See [[DestinationClass]]
41
+ * @see {@link DestinationClass}
42
42
  * @category Core
43
43
  * @deprecated Use {@link getDestination} instead
44
44
  */
@@ -49,20 +49,20 @@ export const Destination = getContext().destination;
49
49
  export const Master = getContext().destination;
50
50
  /**
51
51
  * The Destination (output) belonging to the global Tone.js Context.
52
- * See [[DestinationClass]]
52
+ * @see {@link DestinationClass}
53
53
  * @category Core
54
54
  */
55
55
  export function getDestination() {
56
56
  return getContext().destination;
57
57
  }
58
58
  /**
59
- * The [[ListenerClass]] belonging to the global Tone.js Context.
59
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
60
60
  * @category Core
61
61
  * @deprecated Use {@link getListener} instead
62
62
  */
63
63
  export const Listener = getContext().listener;
64
64
  /**
65
- * The [[ListenerClass]] belonging to the global Tone.js Context.
65
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
66
66
  * @category Core
67
67
  */
68
68
  export function getListener() {
@@ -70,7 +70,7 @@ export function getListener() {
70
70
  }
71
71
  /**
72
72
  * Draw is used to synchronize the draw frame with the Transport's callbacks.
73
- * See [[DrawClass]]
73
+ * @see {@link DrawClass}
74
74
  * @category Core
75
75
  * @deprecated Use {@link getDraw} instead
76
76
  */
@@ -78,7 +78,7 @@ export const Draw = getContext().draw;
78
78
  /**
79
79
  * Get the singleton attached to the global context.
80
80
  * Draw is used to synchronize the draw frame with the Transport's callbacks.
81
- * See [[DrawClass]]
81
+ * @see {@link DrawClass}
82
82
  * @category Core
83
83
  */
84
84
  export function getDraw() {
@@ -86,13 +86,13 @@ export function getDraw() {
86
86
  }
87
87
  /**
88
88
  * A reference to the global context
89
- * See [[Context]]
89
+ * @see {@link BaseContext}
90
90
  * @deprecated Use {@link getContext} instead
91
91
  */
92
92
  export const context = getContext();
93
93
  /**
94
94
  * Promise which resolves when all of the loading promises are resolved.
95
- * Alias for static [[ToneAudioBuffer.loaded]] method.
95
+ * Alias for static {@link ToneAudioBuffer.loaded} method.
96
96
  * @category Core
97
97
  */
98
98
  export function loaded() {
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../Tone/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACvD,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,GAAG;IAClB,OAAO,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACxB,OAAO,UAAU,EAAE,CAAC,SAAS,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC,SAAS,CAAC;AAEhD;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC3B,OAAO,UAAU,EAAE,CAAC,SAAS,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC,WAAW,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC,WAAW,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC7B,OAAO,UAAU,EAAE,CAAC,WAAW,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,EAAE,CAAC,QAAQ,CAAC;AAE9C;;;GAGG;AACH,MAAM,UAAU,WAAW;IAC1B,OAAO,UAAU,EAAE,CAAC,QAAQ,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC,IAAI,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,OAAO;IACtB,OAAO,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;AAEpC;;;;GAIG;AACH,MAAM,UAAU,MAAM;IACrB,OAAO,eAAe,CAAC,MAAM,EAAE,CAAC;AACjC,CAAC;AAED,+CAA+C;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,8CAA8C;AAC9C,MAAM,CAAC,MAAM,MAAM,GAA2B,eAAe,CAAC;AAC9D,+CAA+C;AAC/C,MAAM,CAAC,MAAM,OAAO,GAA4B,gBAAgB,CAAC;AACjE,+CAA+C;AAC/C,MAAM,CAAC,MAAM,YAAY,GAA4B,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../Tone/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEvD,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,GAAG;IAClB,OAAO,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACxB,OAAO,UAAU,EAAE,CAAC,SAAS,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC,SAAS,CAAC;AAEhD;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC3B,OAAO,UAAU,EAAE,CAAC,SAAS,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC,WAAW,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC,WAAW,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC7B,OAAO,UAAU,EAAE,CAAC,WAAW,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,EAAE,CAAC,QAAQ,CAAC;AAE9C;;;GAGG;AACH,MAAM,UAAU,WAAW;IAC1B,OAAO,UAAU,EAAE,CAAC,QAAQ,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC,IAAI,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,OAAO;IACtB,OAAO,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;AAEpC;;;;GAIG;AACH,MAAM,UAAU,MAAM;IACrB,OAAO,eAAe,CAAC,MAAM,EAAE,CAAC;AACjC,CAAC;AAED,+CAA+C;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,8CAA8C;AAC9C,MAAM,CAAC,MAAM,MAAM,GAA2B,eAAe,CAAC;AAC9D,+CAA+C;AAC/C,MAAM,CAAC,MAAM,OAAO,GAA4B,gBAAgB,CAAC;AACjE,+CAA+C;AAC/C,MAAM,CAAC,MAAM,YAAY,GAA4B,gBAAgB,CAAC"}
@@ -12,7 +12,7 @@ export interface DuoSynthOptions extends MonophonicOptions {
12
12
  vibratoAmount: Positive;
13
13
  }
14
14
  /**
15
- * DuoSynth is a monophonic synth composed of two [[MonoSynth]]s run in parallel with control over the
15
+ * DuoSynth is a monophonic synth composed of two {@link MonoSynth}s run in parallel with control over the
16
16
  * frequency ratio between the two voices and vibrato effect.
17
17
  * @example
18
18
  * const duoSynth = new Tone.DuoSynth().toDestination();
@@ -7,7 +7,7 @@ import { Gain, } from "../core/context/Gain";
7
7
  import { Multiply } from "../signal/Multiply";
8
8
  import { deepMerge, omitFromObject, optionsFromArguments } from "../core/util/Defaults";
9
9
  /**
10
- * DuoSynth is a monophonic synth composed of two [[MonoSynth]]s run in parallel with control over the
10
+ * DuoSynth is a monophonic synth composed of two {@link MonoSynth}s run in parallel with control over the
11
11
  * frequency ratio between the two voices and vibrato effect.
12
12
  * @example
13
13
  * const duoSynth = new Tone.DuoSynth().toDestination();
@@ -38,7 +38,7 @@ export declare abstract class Instrument<Options extends InstrumentOptions> exte
38
38
  static getDefaults(): InstrumentOptions;
39
39
  /**
40
40
  * Sync the instrument to the Transport. All subsequent calls of
41
- * [[triggerAttack]] and [[triggerRelease]] will be scheduled along the transport.
41
+ * {@link triggerAttack} and {@link triggerRelease} will be scheduled along the transport.
42
42
  * @example
43
43
  * const fmSynth = new Tone.FMSynth().toDestination();
44
44
  * fmSynth.volume.value = -6;
@@ -38,7 +38,7 @@ export class Instrument extends ToneAudioNode {
38
38
  }
39
39
  /**
40
40
  * Sync the instrument to the Transport. All subsequent calls of
41
- * [[triggerAttack]] and [[triggerRelease]] will be scheduled along the transport.
41
+ * {@link triggerAttack} and {@link triggerRelease} will be scheduled along the transport.
42
42
  * @example
43
43
  * const fmSynth = new Tone.FMSynth().toDestination();
44
44
  * fmSynth.volume.value = -6;
@@ -55,7 +55,7 @@ export declare class MetalSynth extends Monophonic<MetalSynthOptions> {
55
55
  /**
56
56
  * The envelope which is connected both to the
57
57
  * amplitude and a highpass filter's cutoff frequency.
58
- * The lower-limit of the filter is controlled by the [[resonance]]
58
+ * The lower-limit of the filter is controlled by the {@link resonance}
59
59
  */
60
60
  readonly envelope: Envelope;
61
61
  constructor(options?: RecursivePartial<MetalSynthOptions>);
@@ -74,7 +74,7 @@ export declare class MetalSynth extends Monophonic<MetalSynthOptions> {
74
74
  getLevelAtTime(time: Time): NormalRange;
75
75
  /**
76
76
  * The modulationIndex of the oscillators which make up the source.
77
- * see [[FMOscillator.modulationIndex]]
77
+ * see {@link FMOscillator.modulationIndex}
78
78
  * @min 1
79
79
  * @max 100
80
80
  */
@@ -135,7 +135,7 @@ export class MetalSynth extends Monophonic {
135
135
  }
136
136
  /**
137
137
  * The modulationIndex of the oscillators which make up the source.
138
- * see [[FMOscillator.modulationIndex]]
138
+ * see {@link FMOscillator.modulationIndex}
139
139
  * @min 1
140
140
  * @max 100
141
141
  */
@@ -10,7 +10,7 @@ export interface NoiseSynthOptions extends InstrumentOptions {
10
10
  noise: Omit<NoiseOptions, keyof ToneAudioNodeOptions>;
11
11
  }
12
12
  /**
13
- * Tone.NoiseSynth is composed of [[Noise]] through an [[AmplitudeEnvelope]].
13
+ * Tone.NoiseSynth is composed of {@link Noise} through an {@link AmplitudeEnvelope}.
14
14
  * ```
15
15
  * +-------+ +-------------------+
16
16
  * | Noise +>--> AmplitudeEnvelope +>--> Output
@@ -6,7 +6,7 @@ import { ToneAudioNode, } from "../core/context/ToneAudioNode";
6
6
  import { Envelope } from "../component/envelope/Envelope";
7
7
  import { Source } from "../source/Source";
8
8
  /**
9
- * Tone.NoiseSynth is composed of [[Noise]] through an [[AmplitudeEnvelope]].
9
+ * Tone.NoiseSynth is composed of {@link Noise} through an {@link AmplitudeEnvelope}.
10
10
  * ```
11
11
  * +-------+ +-------------------+
12
12
  * | Noise +>--> AmplitudeEnvelope +>--> Output
@@ -50,7 +50,7 @@ export declare class PluckSynth extends Instrument<PluckSynthOptions> {
50
50
  set dampening(fq: Frequency);
51
51
  triggerAttack(note: Frequency, time?: Time): this;
52
52
  /**
53
- * Ramp down the [[resonance]] to 0 over the duration of the release time.
53
+ * Ramp down the {@link resonance} to 0 over the duration of the release time.
54
54
  */
55
55
  triggerRelease(time?: Time): this;
56
56
  dispose(): this;
@@ -64,7 +64,7 @@ export class PluckSynth extends Instrument {
64
64
  return this;
65
65
  }
66
66
  /**
67
- * Ramp down the [[resonance]] to 0 over the duration of the release time.
67
+ * Ramp down the {@link resonance} to 0 over the duration of the release time.
68
68
  */
69
69
  triggerRelease(time) {
70
70
  this._lfcf.resonance.linearRampTo(0, this.release, time);
@@ -22,7 +22,7 @@ export interface SamplerOptions extends InstrumentOptions {
22
22
  * were not explicitly included which can save loading time.
23
23
  *
24
24
  * For sample or buffer playback where repitching is not necessary,
25
- * use [[Player]].
25
+ * use {@link Player}.
26
26
  * @example
27
27
  * const sampler = new Tone.Sampler({
28
28
  * urls: {
@@ -16,7 +16,7 @@ import { assert } from "../core/util/Debug";
16
16
  * were not explicitly included which can save loading time.
17
17
  *
18
18
  * For sample or buffer playback where repitching is not necessary,
19
- * use [[Player]].
19
+ * use {@link Player}.
20
20
  * @example
21
21
  * const sampler = new Tone.Sampler({
22
22
  * urls: {
@@ -12,7 +12,7 @@ export interface SynthOptions extends MonophonicOptions {
12
12
  envelope: Omit<EnvelopeOptions, keyof ToneAudioNodeOptions>;
13
13
  }
14
14
  /**
15
- * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]].
15
+ * Synth is composed simply of a {@link OmniOscillator} routed through an {@link AmplitudeEnvelope}.
16
16
  * ```
17
17
  * +----------------+ +-------------------+
18
18
  * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output
@@ -7,7 +7,7 @@ import { OmniOscillator } from "../source/oscillator/OmniOscillator";
7
7
  import { Source } from "../source/Source";
8
8
  import { Monophonic } from "./Monophonic";
9
9
  /**
10
- * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]].
10
+ * Synth is composed simply of a {@link OmniOscillator} routed through an {@link AmplitudeEnvelope}.
11
11
  * ```
12
12
  * +----------------+ +-------------------+
13
13
  * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output
@@ -31,7 +31,7 @@ export declare class Add extends Signal {
31
31
  */
32
32
  readonly addend: Param<"number">;
33
33
  /**
34
- * @param value If no value is provided, will sum the input and [[addend]].
34
+ * @param value If no value is provided, will sum the input and {@link addend}.
35
35
  */
36
36
  constructor(value?: number);
37
37
  constructor(options?: Partial<SignalOptions<"number">>);
@@ -3,7 +3,7 @@ import { SignalOperator } from "./SignalOperator";
3
3
  import { WaveShaper } from "./WaveShaper";
4
4
  /**
5
5
  * AudioToGain converts an input in AudioRange [-1,1] to NormalRange [0,1].
6
- * See [[GainToAudio]].
6
+ * @see {@link GainToAudio}.
7
7
  * @category Signal
8
8
  */
9
9
  export declare class AudioToGain extends SignalOperator<ToneAudioNodeOptions> {
@@ -2,7 +2,7 @@ import { SignalOperator } from "./SignalOperator";
2
2
  import { WaveShaper } from "./WaveShaper";
3
3
  /**
4
4
  * AudioToGain converts an input in AudioRange [-1,1] to NormalRange [0,1].
5
- * See [[GainToAudio]].
5
+ * @see {@link GainToAudio}.
6
6
  * @category Signal
7
7
  */
8
8
  export class AudioToGain extends SignalOperator {
@@ -3,7 +3,7 @@ import { SignalOperator } from "./SignalOperator";
3
3
  import { WaveShaper } from "./WaveShaper";
4
4
  /**
5
5
  * GainToAudio converts an input in NormalRange [0,1] to AudioRange [-1,1].
6
- * See [[AudioToGain]].
6
+ * @see {@link AudioToGain}.
7
7
  * @category Signal
8
8
  */
9
9
  export declare class GainToAudio extends SignalOperator<ToneAudioNodeOptions> {
@@ -2,7 +2,7 @@ import { SignalOperator } from "./SignalOperator";
2
2
  import { WaveShaper } from "./WaveShaper";
3
3
  /**
4
4
  * GainToAudio converts an input in NormalRange [0,1] to AudioRange [-1,1].
5
- * See [[AudioToGain]].
5
+ * @see {@link AudioToGain}.
6
6
  * @category Signal
7
7
  */
8
8
  export class GainToAudio extends SignalOperator {
@@ -35,7 +35,7 @@ export declare class Multiply<TypeName extends "number" | "positive" = "number">
35
35
  */
36
36
  input: InputNode;
37
37
  /**
38
- * The product of the input and [[factor]]
38
+ * The product of the input and {@link factor}
39
39
  */
40
40
  output: OutputNode;
41
41
  /**
@@ -27,8 +27,8 @@ export declare class ScaleExp extends Scale<ScaleExpOptions> {
27
27
  constructor(options?: Partial<ScaleExpOptions>);
28
28
  static getDefaults(): ScaleExpOptions;
29
29
  /**
30
- * Instead of interpolating linearly between the [[min]] and
31
- * [[max]] values, setting the exponent will interpolate between
30
+ * Instead of interpolating linearly between the {@link min} and
31
+ * {@link max} values, setting the exponent will interpolate between
32
32
  * the two values with an exponential curve.
33
33
  */
34
34
  get exponent(): Positive;
@@ -27,8 +27,8 @@ export class ScaleExp extends Scale {
27
27
  });
28
28
  }
29
29
  /**
30
- * Instead of interpolating linearly between the [[min]] and
31
- * [[max]] values, setting the exponent will interpolate between
30
+ * Instead of interpolating linearly between the {@link min} and
31
+ * {@link max} values, setting the exponent will interpolate between
32
32
  * the two values with an exponential curve.
33
33
  */
34
34
  get exponent() {
@@ -75,7 +75,7 @@ export declare class Signal<TypeName extends UnitName = "number"> extends ToneAu
75
75
  get maxValue(): number;
76
76
  get minValue(): number;
77
77
  /**
78
- * See [[Param.apply]].
78
+ * @see {@link Param.apply}.
79
79
  */
80
80
  apply(param: Param | AudioParam): this;
81
81
  }
@@ -149,7 +149,7 @@ export class Signal extends ToneAudioNode {
149
149
  return this._param.minValue;
150
150
  }
151
151
  /**
152
- * See [[Param.apply]].
152
+ * @see {@link Param.apply}.
153
153
  */
154
154
  apply(param) {
155
155
  this._param.apply(param);
@@ -2,7 +2,7 @@ import { Signal, SignalOptions } from "./Signal";
2
2
  import { NormalRange, Time, TransportTime, UnitMap, UnitName } from "../core/type/Units";
3
3
  import { OutputNode } from "../core/context/ToneAudioNode";
4
4
  /**
5
- * Adds the ability to synchronize the signal to the [[TransportClass]]
5
+ * Adds the ability to synchronize the signal to the {@link TransportClass}
6
6
  * @category Signal
7
7
  */
8
8
  export declare class SyncedSignal<TypeName extends UnitName = "number"> extends Signal<TypeName> {
@@ -3,7 +3,7 @@ import { optionsFromArguments } from "../core/util/Defaults";
3
3
  import { TransportTimeClass } from "../core/type/TransportTime";
4
4
  import { ToneConstantSource } from "./ToneConstantSource";
5
5
  /**
6
- * Adds the ability to synchronize the signal to the [[TransportClass]]
6
+ * Adds the ability to synchronize the signal to the {@link TransportClass}
7
7
  * @category Signal
8
8
  */
9
9
  export class SyncedSignal extends Signal {
@@ -144,7 +144,8 @@ export declare abstract class Source<Options extends SourceOptions> extends Tone
144
144
  */
145
145
  sync(): this;
146
146
  /**
147
- * Unsync the source to the Transport. See Source.sync
147
+ * Unsync the source to the Transport.
148
+ * @see {@link sync}
148
149
  */
149
150
  unsync(): this;
150
151
  /**
@@ -260,7 +260,8 @@ export class Source extends ToneAudioNode {
260
260
  return this;
261
261
  }
262
262
  /**
263
- * Unsync the source to the Transport. See Source.sync
263
+ * Unsync the source to the Transport.
264
+ * @see {@link sync}
264
265
  */
265
266
  unsync() {
266
267
  if (this._synced) {