Interface: SoundOptions

Defined in: src/sound/interfaces/SoundOptions.ts:3

Extends

• Pick<Partial<PlayerOptions>, "loop" | "autostart" | "fadeIn" | "fadeOut" | "mute" | "loopEnd" | "loopStart" | "reverse" | "playbackRate">

Extended by

• SoundPlayOptions

Properties

autostart?

> optional autostart?: boolean

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9

Inherited from

Pick.autostart

fadeIn?

> optional fadeIn?: Time

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13

Inherited from

Pick.fadeIn

fadeOut?

> optional fadeOut?: Time

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14

Inherited from

Pick.fadeOut

filters?

> optional filters?: ToneAudioNode<ToneWithContextOptions>[]

Defined in: src/sound/interfaces/SoundOptions.ts:34

A collection of audio filters/effects to apply to this sound.

Install "tone" for the full list of available filters.

Example

import * as Tone from "tone";

const filters = [new Tone.FeedbackDelay("8n", 0.5)];

loop?

> optional loop?: boolean

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8

Inherited from

Pick.loop

loopEnd?

> optional loopEnd?: Time

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11

Inherited from

Pick.loopEnd

loopStart?

> optional loopStart?: Time

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10

Inherited from

Pick.loopStart

mute?

> optional mute?: boolean

Defined in: node_modules/tone/build/esm/source/Source.d.ts:10

Inherited from

Pick.mute

~~muted?~~

> optional muted?: boolean

Defined in: src/sound/interfaces/SoundOptions.ts:42

Deprecated

Use mute instead.

playbackRate?

> optional playbackRate?: number

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7

Inherited from

Pick.playbackRate

reverse?

> optional reverse?: boolean

Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12

Inherited from

Pick.reverse

~~speed?~~

> optional speed?: number

Defined in: src/sound/interfaces/SoundOptions.ts:38

Deprecated

Use playbackRate instead.

volume?

> optional volume?: number

Defined in: src/sound/interfaces/SoundOptions.ts:21

The volume of this sound in the linear range [0, 1], where 0 is silence and 1 is full volume. This is converted to decibels internally before being passed to the Tone.js Player.