PixiJS Sound

Interface: PlayOptions

PlayOptions

Options used for sound playback.

Properties:
Name Type Default Description
complete Function

When completed.
end number

End time in seconds.
filters filters.Filter[]

Filters that apply to play. Only supported with WebAudio.
loaded Function

If not already preloaded, callback when finishes load.
loop boolean

Override default loop, default to the Sound's loop setting.
muted boolean false

If sound instance is muted by default.
singleInstance boolean

Setting true will stop any playing instances. This is the same as the singleInstance property on Sound, but is play-specific.
speed number

Override default speed, default to the Sound's speed setting.
sprite string

The sprite to play.
start number 0

Start time offset in seconds.
volume number

Override default volume, default to the Sound's volume setting.

Members

complete Function

When completed.

end number

End time in seconds.

filters filters.Filter[]

Filters that apply to play. Only supported with WebAudio.

loaded Function

If not already preloaded, callback when finishes load.

loop boolean

Override default loop, default to the Sound's loop setting.

muted boolean

If sound instance is muted by default.

Default Value:
  • false

singleInstance boolean

Setting true will stop any playing instances. This is the same as the singleInstance property on Sound, but is play-specific.

speed number

Override default speed, default to the Sound's speed setting.

sprite string

The sprite to play.

start number

Start time offset in seconds.

Default Value:
  • 0

volume number

Override default volume, default to the Sound's volume setting.