# Interface: SoundPlayOptionsWithChannel (/pixi-vn-json/docs-entry/interfaces/SoundPlayOptionsWithChannel)



Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:70

Documentation-only entry point.

These types are used internally by the schema (e.g. `PixiVNJsonSoundPlayProps`)
but are otherwise never exported from the package's public API. TypeDoc only
expands the full member list of an external type when it is reachable from one
of its `entryPoints`, so this file exists purely to give the generated wiki
something to expand into — it is not part of `src/index.ts` and is not bundled
into `dist`.

## Extends [#extends]

* `SoundPlayOptions`

## Extended by [#extended-by]

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

## Properties [#properties]

### autostart? [#autostart]

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

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

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

`SoundPlayOptions.autostart`

***

### channel? [#channel]

\> `optional` **channel?**: `string`

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:76

The alias of the audio channel to play the sound on. If the channel does
not exist it will be created automatically.
Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").

***

### delay? [#delay]

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:64

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.

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

`SoundPlayOptions.delay`

***

### elapsed? [#elapsed]

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:68

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

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

`SoundPlayOptions.elapsed`

***

### fadeIn? [#fadein]

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

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

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

`SoundPlayOptions.fadeIn`

***

### fadeOut? [#fadeout]

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

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

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

`SoundPlayOptions.fadeOut`

***

### filters? [#filters]

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:48

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

`SoundPlayOptions.filters`

***

### loop? [#loop]

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

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

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

`SoundPlayOptions.loop`

***

### loopEnd? [#loopend]

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

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

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

`SoundPlayOptions.loopEnd`

***

### loopStart? [#loopstart]

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

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

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

`SoundPlayOptions.loopStart`

***

### mute? [#mute]

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

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

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

`SoundPlayOptions.mute`

***

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

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:56

#### Deprecated [#deprecated]

Use [mute](/pixi-vn-json/index/interfaces/PixiVNJsonSoundPlayProps#mute) instead.

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

`SoundPlayOptions.muted`

***

### playbackRate? [#playbackrate]

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

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

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

`SoundPlayOptions.playbackRate`

***

### reverse? [#reverse]

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

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

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

`SoundPlayOptions.reverse`

***

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

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:52

#### Deprecated [#deprecated-1]

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

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

`SoundPlayOptions.speed`

***

### volume? [#volume]

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

Defined in: node_modules/@drincs/pixi-vn/dist/SoundGameState-C_6ZsQX6.d.ts:35

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

`SoundPlayOptions.volume`