Tone.js/Tone/index.ts

130 lines
3.8 KiB
TypeScript
Raw Permalink Normal View History

export { getContext, setContext } from "./core/Global.js";
import { Context } from "./core/context/Context.js";
export * from "./classes.js";
export * from "./version.js";
import { getContext } from "./core/Global.js";
import { ToneAudioBuffer } from "./core/context/ToneAudioBuffer.js";
export { start } from "./core/Global.js";
import { Seconds } from "./core/type/Units.js";
export { supported } from "./core/context/AudioContext.js";
import type { TransportClass } from "./core/clock/Transport.js";
import type { DestinationClass } from "./core/context/Destination.js";
import type { DrawClass } from "./core/util/Draw.js";
import type { ListenerClass } from "./core/context/Listener.js";
2019-08-30 16:01:51 +00:00
/**
2024-04-30 13:44:57 +00:00
* The current audio context time of the global {@link BaseContext}.
* @see {@link Context.now}
* @category Core
*/
export function now(): Seconds {
return getContext().now();
}
2019-07-25 15:29:36 +00:00
/**
* The current audio context time of the global {@link Context} without the {@link Context.lookAhead}
* @see {@link Context.immediate}
* @category Core
2019-10-29 18:30:12 +00:00
*/
export function immediate(): Seconds {
return getContext().immediate();
}
2019-10-29 18:30:12 +00:00
/**
* The Transport object belonging to the global Tone.js Context.
2024-04-29 16:59:49 +00:00
* @see {@link TransportClass}
* @category Core
* @deprecated Use {@link getTransport} instead
*/
2019-07-25 15:29:36 +00:00
export const Transport = getContext().transport;
/**
* The Transport object belonging to the global Tone.js Context.
2024-04-29 16:59:49 +00:00
* @see {@link TransportClass}
* @category Core
*/
2024-04-30 13:44:57 +00:00
export function getTransport(): TransportClass {
return getContext().transport;
}
/**
2019-10-29 18:30:12 +00:00
* The Destination (output) belonging to the global Tone.js Context.
2024-04-29 16:59:49 +00:00
* @see {@link DestinationClass}
* @category Core
* @deprecated Use {@link getDestination} instead
*/
2019-07-25 15:29:36 +00:00
export const Destination = getContext().destination;
/**
* @deprecated Use {@link getDestination} instead
*/
export const Master = getContext().destination;
/**
* The Destination (output) belonging to the global Tone.js Context.
2024-04-29 16:59:49 +00:00
* @see {@link DestinationClass}
* @category Core
*/
2024-04-30 13:44:57 +00:00
export function getDestination(): DestinationClass {
return getContext().destination;
}
/**
2024-04-29 14:48:37 +00:00
* The {@link ListenerClass} belonging to the global Tone.js Context.
* @category Core
* @deprecated Use {@link getListener} instead
*/
export const Listener = getContext().listener;
/**
2024-04-29 14:48:37 +00:00
* The {@link ListenerClass} belonging to the global Tone.js Context.
* @category Core
*/
2024-04-30 13:44:57 +00:00
export function getListener(): ListenerClass {
return getContext().listener;
}
/**
2024-04-30 13:44:57 +00:00
* Draw is used to synchronize the draw frame with the Transport's callbacks.
2024-04-29 16:59:49 +00:00
* @see {@link DrawClass}
* @category Core
* @deprecated Use {@link getDraw} instead
*/
export const Draw = getContext().draw;
2019-10-30 18:48:41 +00:00
/**
2024-04-30 13:44:57 +00:00
* Get the singleton attached to the global context.
* Draw is used to synchronize the draw frame with the Transport's callbacks.
2024-04-29 16:59:49 +00:00
* @see {@link DrawClass}
* @category Core
*/
2024-04-30 13:44:57 +00:00
export function getDraw(): DrawClass {
return getContext().draw;
}
2019-10-30 18:48:41 +00:00
/**
* A reference to the global context
* @see {@link Context}
* @deprecated Use {@link getContext} instead
2019-10-30 18:48:41 +00:00
*/
export const context = getContext();
/**
2024-04-30 13:44:57 +00:00
* Promise which resolves when all of the loading promises are resolved.
2024-04-29 14:48:37 +00:00
* Alias for static {@link ToneAudioBuffer.loaded} method.
* @category Core
*/
export function loaded() {
return ToneAudioBuffer.loaded();
}
// this fills in name changes from 13.x to 14.x
import { ToneAudioBuffers } from "./core/context/ToneAudioBuffers.js";
import { ToneBufferSource } from "./source/buffer/ToneBufferSource.js";
/** @deprecated Use {@link ToneAudioBuffer} */
export const Buffer: typeof ToneAudioBuffer = ToneAudioBuffer;
/** @deprecated Use {@link ToneAudioBuffers} */
export const Buffers: typeof ToneAudioBuffers = ToneAudioBuffers;
/** @deprecated Use {@link ToneBufferSource} */
export const BufferSource: typeof ToneBufferSource = ToneBufferSource;