Class Clock<TypeName>

A sample accurate clock which provides a callback at the given rate. While the callback is not sample-accurate (it is still susceptible to loose JS timing), the time passed in as the argument to the callback is precise. For most applications, it is better to use Tone.Transport instead of the Clock by itself since you can synchronize multiple callbacks.

Example

// the callback will be invoked approximately once a second
// and will print the time exactly once a second apart.
const clock = new Tone.Clock(time => {
    console.log(time);
}, 1);
clock.start();

Type Parameters

TypeName extends "bpm" | "hertz" = "hertz"

Hierarchy

ToneWithContext<ClockOptions>
- Clock

Implements

Emitter<ClockEvent>

Index

Constructors

constructor

new Clock<TypeName>(callback?, frequency?): Clock<TypeName>
Type Parameters
- TypeName extends "bpm" | "hertz" = "hertz"
Parameters
- Optional callback: ClockCallback
  The callback to be invoked with the time of the audio event
- Optional frequency: Unit.Frequency
  The rate of the callback
Returns Clock<TypeName>
Overrides ToneWithContext<ClockOptions>.constructor
- Defined in Tone/core/clock/Clock.ts:80
new Clock<TypeName>(options): Clock<TypeName>
Type Parameters
- TypeName extends "bpm" | "hertz" = "hertz"
Parameters
- options: Partial<ClockOptions>
Returns Clock<TypeName>
Overrides ToneWithContext<ClockOptions>.constructor
- Defined in Tone/core/clock/Clock.ts:81

Properties

callback

callback: ClockCallback = noOp

The callback function to invoke at the scheduled tick.

`Readonly` context

context: BaseContext

The context belonging to the node.

debug

debug: boolean = false

Set this debug flag to log all events that happen in this class.

emit

emit: ((event, ...args) => this)

Type declaration

- (event, ...args): this
- Parameters
  - event: any
  - Rest ...args: any[]
  Returns this

frequency

frequency: TickSignal<TypeName>

The rate the callback function should be invoked.

`Readonly` name

name: string = "Clock"

off

off: ((event, callback?) => this)

Type declaration

- (event, callback?): this
- Parameters
  - event: ClockEvent
  - Optional callback: ((...args) => void)
    - (...args): void
      Parameters
      Rest ...args: any[]
      Returns void
  Returns this

on

on: ((event, callback) => this)

Type declaration

- (event, callback): this
- Parameters
  - event: ClockEvent
  - callback: ((...args) => void)
    - (...args): void
      Parameters
      Rest ...args: any[]
      Returns void
  Returns this

once

once: ((event, callback) => this)

Type declaration

- (event, callback): this
- Parameters
  - event: ClockEvent
  - callback: ((...args) => void)
    - (...args): void
      Parameters
      Rest ...args: any[]
      Returns void
  Returns this

`Static` version

version: string = version

The version number semver

Accessors

blockTime

get blockTime(): number
The number of seconds of 1 processing block (128 samples)

Returns number
Example
```
console.log(Tone.Destination.blockTime);
```
Inherited from ToneWithContext.blockTime
- Defined in Tone/core/context/ToneWithContext.ts:108

disposed

get disposed(): boolean
Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

Returns boolean
Implementation of Emitter.disposed
Inherited from ToneWithContext.disposed
- Defined in Tone/core/Tone.ts:96

sampleTime

get sampleTime(): number
The duration in seconds of one sample.

Returns number
Inherited from ToneWithContext.sampleTime
- Defined in Tone/core/context/ToneWithContext.ts:99

seconds

get seconds(): number
The time since ticks=0 that the Clock has been running. Accounts for tempo curves

Returns number
- Defined in Tone/core/clock/Clock.ts:196
set seconds(s): void
Parameters
- s: number
Returns void
- Defined in Tone/core/clock/Clock.ts:199

state

get state(): PlaybackState
Returns the playback state of the source, either "started", "stopped" or "paused".

Returns PlaybackState
- Defined in Tone/core/clock/Clock.ts:117

ticks

get ticks(): number
The number of times the callback was invoked. Starts counting at 0 and increments after the callback was invoked.

Returns number
- Defined in Tone/core/clock/Clock.ts:186
set ticks(t): void
Parameters
- t: number
Returns void
- Defined in Tone/core/clock/Clock.ts:189

Methods

dispose

dispose(): this
Clean up

Returns this
Implementation of Emitter.dispose
Overrides ToneWithContext.dispose
- Defined in Tone/core/clock/Clock.ts:311

get

get(): ClockOptions
Get the object's attributes.

Returns ClockOptions
Example
```
const osc = new Tone.Oscillator();
console.log(osc.get());
```
Inherited from ToneWithContext.get
- Defined in Tone/core/context/ToneWithContext.ts:170

getSecondsAtTime

getSecondsAtTime(time): number
Return the elapsed seconds at the given time.
Parameters
- time: Unit.Time
  When to get the elapsed seconds
Returns number
The number of elapsed seconds
- Defined in Tone/core/clock/Clock.ts:208

getStateAtTime

getStateAtTime(time): PlaybackState
Returns the scheduled state at the given time.
Parameters
- time: Unit.Time
  The time to query.
Returns PlaybackState
The name of the state input in setStateAtTime.
Example
```
const clock = new Tone.Clock();
clock.start("+0.1");
clock.getStateAtTime("+0.1"); // returns "started"
```
- Defined in Tone/core/clock/Clock.ts:303

getTicksAtTime

getTicksAtTime(time?): number
Get the clock's ticks at the given time.
Parameters
- Optional time: Unit.Time
  When to get the tick value
Returns number
The tick value at the given time.
- Defined in Tone/core/clock/Clock.ts:239

getTimeOfTick

getTimeOfTick(tick, before?): number
Get the time of the given tick. The second argument is when to test before. Since ticks can be set (with setTicksAtTime) there may be multiple times for a given tick value.
Parameters
- tick: number
  The tick number.
- before: number = ...
  When to measure the tick value from.
Returns number
The time of the tick
- Defined in Tone/core/clock/Clock.ts:230

immediate

immediate(): number
Return the current time of the Context clock without any lookAhead.

Returns number
Example
```
setInterval(() => {
    console.log(Tone.immediate());
}, 100);
```
Inherited from ToneWithContext.immediate
- Defined in Tone/core/context/ToneWithContext.ts:92

nextTickTime

nextTickTime(offset, when): number
Get the time of the next tick
Parameters
- offset: number
  The tick number.
- when: Unit.Time
Returns number
- Defined in Tone/core/clock/Clock.ts:247

now

now(): number
Return the current time of the Context clock plus the lookAhead.

Returns number
Example
```
setInterval(() => {
    console.log(Tone.now());
}, 100);
```
Inherited from ToneWithContext.now
- Defined in Tone/core/context/ToneWithContext.ts:81

pause

pause(time?): this
Pause the clock. Pausing does not reset the tick counter.
Parameters
- Optional time: Unit.Time
  The time when the clock should stop.
Returns this
- Defined in Tone/core/clock/Clock.ts:170

set

set(props): this

Set multiple properties at once with an object.

Parameters

props: RecursivePartial<ClockOptions>

Returns this

Example

const filter = new Tone.Filter().toDestination();
// set values using an object
filter.set({
    frequency: "C6",
    type: "highpass"
});
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
player.autostart = true;

setTicksAtTime

setTicksAtTime(ticks, time): this
Set the clock's ticks at the given time.
Parameters
- ticks: number
  The tick value to set
- time: Unit.Time
  When to set the tick value
Returns this
- Defined in Tone/core/clock/Clock.ts:217

start

start(time?, offset?): this
Start the clock at the given time. Optionally pass in an offset of where to start the tick counter from.
Parameters
- Optional time: Unit.Time
  The time the clock should start
- Optional offset: number
  Where the tick counter starts counting from.
Returns this
- Defined in Tone/core/clock/Clock.ts:127

stop

stop(time?): this
Stop the clock. Stopping the clock resets the tick counter to 0.
Parameters
- Optional time: Unit.Time
  The time when the clock should stop.
Returns this
Example
```
const clock = new Tone.Clock(time => {
    console.log(time);
}, 1);
clock.start();
// stop the clock after 10 seconds
clock.stop("+10");
```
- Defined in Tone/core/clock/Clock.ts:154

toFrequency

toFrequency(freq): number
Convert the input to a frequency number
Parameters
- freq: Unit.Frequency
Returns number
Example
```
const gain = new Tone.Gain();
console.log(gain.toFrequency("4n"));
```
Inherited from ToneWithContext.toFrequency
- Defined in Tone/core/context/ToneWithContext.ts:132

toSeconds

toSeconds(time?): number
Convert the incoming time to seconds. This is calculated against the current TransportClass bpm
Parameters
- Optional time: Unit.Time
Returns number
Example
```
const gain = new Tone.Gain();
setInterval(() => console.log(gain.toSeconds("4n")), 100);
// ramp the tempo to 60 bpm over 30 seconds
Tone.getTransport().bpm.rampTo(60, 30);
```
Inherited from ToneWithContext.toSeconds
- Defined in Tone/core/context/ToneWithContext.ts:121

toString

toString(): string
Convert the class to a string

Returns string
Example
```
const osc = new Tone.Oscillator();
console.log(osc.toString());
```
Implementation of Emitter.toString
Inherited from ToneWithContext.toString
- Defined in Tone/core/Tone.ts:106

toTicks

toTicks(time?): number
Convert the input time into ticks
Parameters
- Optional time: Unit.Time | TimeClass<number, TimeBaseUnit>
Returns number
Example
```
const gain = new Tone.Gain();
console.log(gain.toTicks("4n"));
```
Inherited from ToneWithContext.toTicks
- Defined in Tone/core/context/ToneWithContext.ts:142

`Static` getDefaults

getDefaults(): ClockOptions
Returns all of the default options belonging to the class.

Returns ClockOptions
Overrides ToneWithContext.getDefaults
- Defined in Tone/core/clock/Clock.ts:106

Class Clock<TypeName>

Example

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Clock<TypeName>

Type Parameters

Parameters

Returns Clock<TypeName>

Properties

callback

Readonly context

debug

emit

Type declaration

Parameters

Returns this

frequency

Readonly name

off

Type declaration

Parameters

Parameters

Returns void

Returns this

on

Type declaration

Parameters

Parameters

Returns void

Returns this

once

Type declaration

Parameters

Parameters

Returns void

Returns this

Static version

Accessors

blockTime

Returns number

Example

disposed

Returns boolean

sampleTime

Returns number

seconds

Returns number

Parameters

Returns void

state

Returns PlaybackState

ticks

Returns number

Parameters

Returns void

Methods

dispose

Returns this

get

Returns ClockOptions

Example

getSecondsAtTime

Parameters

Returns number

getStateAtTime

Parameters

Returns PlaybackState

Example

getTicksAtTime

Parameters

`Readonly` context

`Readonly` name

`Static` version

`Static` getDefaults