Interface: ChannelOptions

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

Extends

• Pick<SoundPlayOptions, "filters" | "muted" | "volume">

Properties

background?

> optional background?: boolean

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

Whether this channel is a background channel. Background channels are special: media playing on them is not stopped when a scene changes, but continues in the background.

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)];

Inherited from

SoundOptions.filters

~~muted?~~

> optional muted?: boolean

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

Deprecated

Use mute instead.

Inherited from

SoundOptions.muted

pan?

> optional pan?: number

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

The stereo pan position for this channel in the range [-1, 1]. -1 is full left, 0 is centre, 1 is full right. Defaults to 0.

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.

Inherited from

SoundOptions.volume