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



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

Extends [#extends]

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

Extended by [#extended-by]

* [`SoundPlayOptionsWithChannel`](/jsdoc/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`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`autostart`](/jsdoc/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/998c1a75c5978f24c0dc137af5f42b90b2803967/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/998c1a75c5978f24c0dc137af5f42b90b2803967/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`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`fadeIn`](/jsdoc/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`](/jsdoc/pixi-vn/index/interfaces/SoundOptions).[`fadeOut`](/jsdoc/pixi-vn/index/interfaces/SoundOptions#fadeout)

***

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-3]

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

***

loop? [#loop]

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

Defined in: node\_modules/tone/build/esm/source/buffer/Player.d.ts:8

Inherited from [#inherited-from-4]

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

***

loopEnd? [#loopend]

\> `optional` &#x2A;*loopEnd?**: `Time`

Defined in: node\_modules/tone/build/esm/source/buffer/Player.d.ts:11

Inherited from [#inherited-from-5]

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

***

loopStart? [#loopstart]

\> `optional` &#x2A;*loopStart?**: `Time`

Defined in: node\_modules/tone/build/esm/source/buffer/Player.d.ts:10

Inherited from [#inherited-from-6]

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

***

mute? [#mute]

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

Defined in: node\_modules/tone/build/esm/source/Source.d.ts:10

Inherited from [#inherited-from-7]

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

***

~~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-8]

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

***

playbackRate? [#playbackrate]

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

Defined in: node\_modules/tone/build/esm/source/buffer/Player.d.ts:7

Inherited from [#inherited-from-9]

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

***

reverse? [#reverse]

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

Defined in: node\_modules/tone/build/esm/source/buffer/Player.d.ts:12

Inherited from [#inherited-from-10]

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

***

~~speed?~~ [#speed]

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

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

Deprecated [#deprecated-1]

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

Inherited from [#inherited-from-11]

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

***

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-12]

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