Howl
@zylem/game-lib / audio / Howl
Class: Howl
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:163
Constructors
Constructor
new Howl(
options):Howl
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:164
Parameters
options
HowlOptions
Returns
Howl
Methods
duration()
duration(
id?):number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:189
Parameters
id?
number
Returns
number
fade()
fade(
from,to,duration,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:177
Parameters
from
number
to
number
duration
number
id?
number
Returns
this
load()
load():
this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:191
Returns
this
loop()
Call Signature
loop(
id?):boolean
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:185
Parameters
id?
number
Returns
boolean
Call Signature
loop(
loop,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:186
Parameters
loop
boolean
id?
number
Returns
this
mute()
Call Signature
mute():
boolean
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:170
Returns
boolean
Call Signature
mute(
muted,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:171
Parameters
muted
boolean
id?
number
Returns
this
off()
Call Signature
off(
event,callback?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:212
Parameters
event
"load"
callback?
() => void
id?
number
Returns
this
Call Signature
off(
event,callback?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:213
Parameters
event
"loaderror" | "playerror"
callback?
HowlErrorCallback
id?
number
Returns
this
Call Signature
off(
event,callback?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:214
Parameters
event
"volume" | "mute" | "end" | "fade" | "stop" | "pause" | "play" | "rate" | "seek" | "unlock"
callback?
HowlCallback
id?
number
Returns
this
Call Signature
off(
event,id):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:220
Parameters
event
"volume" | "mute" | "end" | "fade" | "stop" | "pause" | "load" | "play" | "loaderror" | "playerror" | "rate" | "seek" | "unlock"
id
number
Returns
this
Call Signature
off(
event?,callback?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:237
Parameters
event?
string
callback?
HowlErrorCallback | HowlCallback
id?
number
Returns
this
on()
Call Signature
on(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:194
Parameters
event
"load"
callback
() => void
id?
number
Returns
this
Call Signature
on(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:195
Parameters
event
"loaderror" | "playerror"
callback
HowlErrorCallback
id?
number
Returns
this
Call Signature
on(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:196
Parameters
event
"volume" | "mute" | "end" | "fade" | "stop" | "pause" | "play" | "rate" | "seek" | "unlock"
callback
HowlCallback
id?
number
Returns
this
Call Signature
on(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:201
Parameters
event
string
callback
HowlErrorCallback | HowlCallback
id?
number
Returns
this
once()
Call Signature
once(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:203
Parameters
event
"load"
callback
() => void
id?
number
Returns
this
Call Signature
once(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:204
Parameters
event
"loaderror" | "playerror"
callback
HowlErrorCallback
id?
number
Returns
this
Call Signature
once(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:205
Parameters
event
"volume" | "mute" | "end" | "fade" | "stop" | "pause" | "play" | "rate" | "seek" | "unlock"
callback
HowlCallback
id?
number
Returns
this
Call Signature
once(
event,callback,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:210
Parameters
event
string
callback
HowlErrorCallback | HowlCallback
id?
number
Returns
this
orientation()
Call Signature
orientation():
SpatialOrientation
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:245
Returns
SpatialOrientation
Call Signature
orientation(
x,y?,z?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:246
Parameters
x
number
y?
number
z?
number
id?
number
Returns
this
pannerAttr()
Call Signature
pannerAttr(
id?):PannerAttributes
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:248
Parameters
id?
number
Returns
PannerAttributes
Call Signature
pannerAttr(
options,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:249
Parameters
options
PannerAttributes
id?
number
Returns
this
pause()
pause(
id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:167
Parameters
id?
number
Returns
this
play()
play(
spriteOrId?):number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:166
Parameters
spriteOrId?
string | number
Returns
number
playing()
playing(
id?):boolean
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:188
Parameters
id?
number
Returns
boolean
pos()
Call Signature
pos():
SpatialPosition
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:242
Returns
SpatialPosition
Call Signature
pos(
x,y?,z?,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:243
Parameters
x
number
y?
number
z?
number
id?
number
Returns
this
rate()
Call Signature
rate(
id?):number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:179
Parameters
id?
number
Returns
number
Call Signature
rate(
rate,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:180
Parameters
rate
number
id?
number
Returns
this
seek()
Call Signature
seek(
id?):number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:182
Parameters
id?
number
Returns
number
Call Signature
seek(
seek,id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:183
Parameters
seek
number
id?
number
Returns
this
state()
state():
"loaded"|"loading"|"unloaded"
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:190
Returns
"loaded" | "loading" | "unloaded"
stereo()
Call Signature
stereo():
number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:239
Returns
number
Call Signature
stereo(
pan,id?):number|Howl
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:240
Parameters
pan
number
id?
number
Returns
number | Howl
stop()
stop(
id?):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:168
Parameters
id?
number
Returns
this
unload()
unload():
null
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:192
Returns
null
volume()
Call Signature
volume():
number
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:173
Returns
number
Call Signature
volume(
idOrSetVolume):number|Howl
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:174
Parameters
idOrSetVolume
number
Returns
number | Howl
Call Signature
volume(
volume,id):this
Defined in: node_modules/.pnpm/@types+howler@2.2.13/node_modules/@types/howler/index.d.ts:175
Parameters
volume
number
id
number
Returns
this