# Interface: SoundOptions (/pixi-vn/index/interfaces/SoundOptions)



Defined in: [src/sound/interfaces/SoundOptions.ts:3](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L3)

## Extends [#extends]

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

## Extended by [#extended-by]

* [`SoundPlayOptions`](/pixi-vn/index/interfaces/SoundPlayOptions)

## Properties [#properties]

### autostart? [#autostart]

\> `optional` **autostart?**: `boolean`

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

#### Inherited from [#inherited-from]

`Pick.autostart`

***

### fadeIn? [#fadein]

\> `optional` **fadeIn?**: `Time`

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

#### Inherited from [#inherited-from-1]

`Pick.fadeIn`

***

### fadeOut? [#fadeout]

\> `optional` **fadeOut?**: `Time`

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

#### Inherited from [#inherited-from-2]

`Pick.fadeOut`

***

### filters? [#filters]

\> `optional` **filters?**: `ToneAudioNode`\<`ToneWithContextOptions`>\[]

Defined in: [src/sound/interfaces/SoundOptions.ts:34](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/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)];
```

***

### loop? [#loop]

\> `optional` **loop?**: `boolean`

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

#### Inherited from [#inherited-from-3]

`Pick.loop`

***

### loopEnd? [#loopend]

\> `optional` **loopEnd?**: `Time`

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

#### Inherited from [#inherited-from-4]

`Pick.loopEnd`

***

### loopStart? [#loopstart]

\> `optional` **loopStart?**: `Time`

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

#### Inherited from [#inherited-from-5]

`Pick.loopStart`

***

### mute? [#mute]

\> `optional` **mute?**: `boolean`

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

#### Inherited from [#inherited-from-6]

`Pick.mute`

***

### ~~muted?~~ [#muted]

\> `optional` **muted?**: `boolean`

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

#### Deprecated [#deprecated]

Use [mute](#mute) instead.

***

### playbackRate? [#playbackrate]

\> `optional` **playbackRate?**: `number`

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

#### Inherited from [#inherited-from-7]

`Pick.playbackRate`

***

### reverse? [#reverse]

\> `optional` **reverse?**: `boolean`

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

#### Inherited from [#inherited-from-8]

`Pick.reverse`

***

### ~~speed?~~ [#speed]

\> `optional` **speed?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:38](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/sound/interfaces/SoundOptions.ts#L38)

#### Deprecated [#deprecated-1]

Use [playbackRate](#playbackrate) instead.

***

### volume? [#volume]

\> `optional` **volume?**: `number`

Defined in: [src/sound/interfaces/SoundOptions.ts:21](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/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.