Class: SoundSpriteWrapper
Drop-in replacement for PIXI.sound.Sound from an audiosprite.
Constructors
constructor
• new SoundSpriteWrapper(soundsprite
, sprite
, url
): SoundSpriteWrapper
Parameters
Name | Type |
---|---|
soundsprite |
Sound |
sprite |
string |
url |
string |
Returns
Properties
instances
• Private
instances: Instance
[]
soundsprite
• Private
soundsprite: Sound
sprite
• Private
sprite: string
spriteLoop
• Private
spriteLoop: boolean
spriteMuted
• Private
spriteMuted: boolean
spriteVolume
• Private
spriteVolume: number
url
• Private
url: string
Accessors
loop
• get
loop(): boolean
Returns
boolean
• set
loop(loop
): void
Parameters
Name | Type |
---|---|
loop |
boolean |
Returns
void
muted
• get
muted(): boolean
Returns
boolean
• set
muted(muted
): void
Parameters
Name | Type |
---|---|
muted |
boolean |
Returns
void
volume
• get
volume(): number
Returns
number
• set
volume(volume
): void
Parameters
Name | Type |
---|---|
volume |
number |
Returns
void
Methods
destroy
▸ destroy(): void
Returns
void
indexOfInstance
▸ indexOfInstance(instance
): number
Parameters
Name | Type |
---|---|
instance |
IMediaInstance | Promise <IMediaInstance > |
Returns
number
play
▸ play(options?
): IMediaInstance
Parameters
Name | Type |
---|---|
options? |
CompleteCallback | PlayOptions |
Returns
IMediaInstance
stop
▸ stop(): void
Returns
void