# Interface: ChannelOptions (/jsdoc/pixi-vn/index/interfaces/ChannelOptions)



Defined in: [src/sound/interfaces/SoundOptions.ts:67](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L67)

Extends [#extends]

* `Pick`\<[`SoundPlayOptions`](/jsdoc/pixi-vn/index/interfaces/SoundPlayOptions), `"filters"` | `"muted"` | `"volume"`>

Properties [#properties]

background? [#background]

\> `optional` &#x2A;*background?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:73](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L73)

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? [#filters]

\> `optional` &#x2A;*filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L34)

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

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

Example [#example]

```ts
import * as Tone from "tone";

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

Inherited from [#inherited-from]

[`SoundOptions`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`filters`](/jsdoc/pixi-vn/index/interfaces/SoundOptions#filters)

***

~~muted?~~ [#muted]

\> `optional` &#x2A;*muted?**: `boolean`

Defined in: [src/sound/interfaces/SoundOptions.ts:42](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L42)

Deprecated [#deprecated]

Use [mute](/jsdoc/pixi-vn/index/interfaces/SoundOptions#mute) instead.

Inherited from [#inherited-from-1]

[`SoundOptions`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`muted`](/jsdoc/pixi-vn/index/interfaces/SoundOptions#muted)

***

pan? [#pan]

\> `optional` &#x2A;*pan?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:79](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L79)

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? [#volume]

\> `optional` &#x2A;*volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/998c1a75c5978f24c0dc137af5f42b90b2803967/src/sound/interfaces/SoundOptions.ts#L21)

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 [#inherited-from-2]

[`SoundOptions`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`volume`](/jsdoc/pixi-vn/index/interfaces/SoundOptions#volume)
