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



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

## Extends [#extends]

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

## Extended by [#extended-by]

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

## Properties [#properties]

### autostart? [#autostart]

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

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

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

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

***

### delay? [#delay]

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

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

The delay in seconds before playback starts. If specified, playback is
scheduled to begin after the delay has elapsed rather than starting
immediately in a paused state.

***

### elapsed? [#elapsed]

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

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

The offset in seconds from the start of the sound at which to begin playback.

***

### fadeIn? [#fadein]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`fadeIn`](/pixi-vn/index/interfaces/SoundOptions#fadein)

***

### fadeOut? [#fadeout]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`fadeOut`](/pixi-vn/index/interfaces/SoundOptions#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)];
```

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

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

***

### loop? [#loop]

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

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

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

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

***

### loopEnd? [#loopend]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`loopEnd`](/pixi-vn/index/interfaces/SoundOptions#loopend)

***

### loopStart? [#loopstart]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`loopStart`](/pixi-vn/index/interfaces/SoundOptions#loopstart)

***

### mute? [#mute]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`mute`](/pixi-vn/index/interfaces/SoundOptions#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](/pixi-vn/index/interfaces/SoundOptions#mute) instead.

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

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

***

### playbackRate? [#playbackrate]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`playbackRate`](/pixi-vn/index/interfaces/SoundOptions#playbackrate)

***

### reverse? [#reverse]

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

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

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

[`SoundOptions`](/pixi-vn/index/interfaces/SoundOptions).[`reverse`](/pixi-vn/index/interfaces/SoundOptions#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](/pixi-vn/index/interfaces/SoundOptions#playbackrate) instead.

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

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

***

### 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.

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

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