Pixi’VNInterface: PixiVNJsonSoundPlayProps
Defined in: src/schema/PixiVNJsonSound.ts:6
Playback options such as volume, loop, channel, and start offset.
Extends
Properties
autostart?
> optional autostart?: boolean
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:9
Inherited from
SoundPlayOptionsWithChannel.autostart
channel?
> optional channel?: string
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.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").
Inherited from
SoundPlayOptionsWithChannel.channel
delay?
> optional delay?: number
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.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
SoundPlayOptionsWithChannel.delay
elapsed?
> optional elapsed?: number
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.d.ts:68
The offset in seconds from the start of the sound at which to begin playback.
Inherited from
SoundPlayOptionsWithChannel.elapsed
fadeIn?
> optional fadeIn?: Time
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:13
Inherited from
SoundPlayOptionsWithChannel.fadeIn
fadeOut?
> optional fadeOut?: Time
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:14
Inherited from
SoundPlayOptionsWithChannel.fadeOut
filters?
> optional filters?: ToneAudioNode<ToneWithContextOptions>[]
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.d.ts:48
A collection of audio filters/effects to apply to this sound.
Install "tone" for the full list of available filters.
Example
import * as Tone from "tone";
const filters = [new Tone.FeedbackDelay("8n", 0.5)];Inherited from
SoundPlayOptionsWithChannel.filters
loop?
> optional loop?: boolean
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:8
Inherited from
SoundPlayOptionsWithChannel.loop
loopEnd?
> optional loopEnd?: Time
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:11
Inherited from
SoundPlayOptionsWithChannel.loopEnd
loopStart?
> optional loopStart?: Time
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:10
Inherited from
SoundPlayOptionsWithChannel.loopStart
mute?
> optional mute?: boolean
Defined in: node_modules/tone/build/esm/source/Source.d.ts:10
Inherited from
SoundPlayOptionsWithChannel.mute
muted?
> optional muted?: boolean
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.d.ts:56
Deprecated
Use mute instead.
Inherited from
SoundPlayOptionsWithChannel.muted
playbackRate?
> optional playbackRate?: number
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:7
Inherited from
SoundPlayOptionsWithChannel.playbackRate
reverse?
> optional reverse?: boolean
Defined in: node_modules/tone/build/esm/source/buffer/Player.d.ts:12
Inherited from
SoundPlayOptionsWithChannel.reverse
speed?
> optional speed?: number
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.d.ts:52
Deprecated
Use playbackRate instead.
Inherited from
SoundPlayOptionsWithChannel.speed
volume?
> optional volume?: number
Defined in: node_modules/@drincs/pixi-vn/dist/SoundManagerInterface-Dd0b88_N.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.