Class Sound

ReadonlyautoPlay

false
@readonly
Copy

isLoaded

false
Copy

ReadonlyisPlaying

false
@readonly
Copy

media

Readonlyoptions

Readonlypreload

false
@readonly
Copy

singleInstance

false
Copy

Readonlyurl

context

• get context(): IMediaContext

  Instance of the media context.

  Returns IMediaContext

duration

• get duration(): number

  Get the duration of the audio in seconds.

  Returns number

filters

• get filters(): PixiSound.Filter[]

  Set the filters. Only supported with WebAudio.

  Returns PixiSound.Filter[]

• set filters(filters: PixiSound.Filter[]): void

  Parameters

  • filters: PixiSound.Filter[]

  Returns void

instances

• get instances(): IMediaInstance[]

  Gets the list of instances that are currently being played of this sound.

  Returns IMediaInstance[]

isPlayable

• get isPlayable(): boolean

  If the current sound is playable (loaded).

  Returns boolean

loop

• get loop(): boolean

  Gets and sets the looping.

  Returns boolean

• set loop(loop: boolean): void

  Parameters

  • loop: boolean

  Returns void

muted

• get muted(): boolean

  Gets and sets the muted flag.

  Returns boolean

• set muted(muted: boolean): void

  Parameters

  • muted: boolean

  Returns void

paused

• get paused(): boolean

  Stops all the instances of this sound from playing.

  Returns boolean

• set paused(paused: boolean): void

  Parameters

  • paused: boolean

  Returns void

speed

• get speed(): number

  The playback rate.

  Returns number

• set speed(speed: number): void

  Parameters

  • speed: number

  Returns void

sprites

• get sprites(): SoundSprites

  Get the map of sprites.

  Returns SoundSprites

volume

• get volume(): number

  Gets and sets the volume.

  Returns number

• set volume(volume: number): void

  Parameters

  • volume: number

  Returns void

addSprites

• addSprites(alias: string, data: SoundSpriteData): SoundSprite

  Add a sound sprite, which is a saved instance of a longer sound. Similar to an image spritesheet.

  Parameters

  • alias: string

    The unique name of the sound sprite.

  • data: SoundSpriteData

    Either completed function or play options.

  Returns SoundSprite

• addSprites(data: SoundSpriteDataMap): SoundSprites

  Convenience method to add more than one sprite add a time.

  Parameters

  • data: SoundSpriteDataMap

    Map of sounds to add where the key is the alias, and the data are configuration options.

  Returns SoundSprites

  The map of sound sprites added.

autoPlayStart

• autoPlayStart(): IMediaInstance

  Auto play the first instance.

  Returns IMediaInstance

destroy

• destroy(): void

  Destructor, safer to use SoundLibrary.remove(alias) to remove this sound.

  Returns void

pause

• pause(): this

  Stops all the instances of this sound from playing.

  Returns this

play

• play(
      alias: string,
      callback?: CompleteCallback,
  ): IMediaInstance | Promise<IMediaInstance>

  Play a sound sprite, which is a saved instance of a longer sound. Similar to an image spritesheet.

  Parameters

  • alias: string

    The unique name of the sound sprite.

  • Optionalcallback: CompleteCallback

    Callback when completed.

  Returns IMediaInstance | Promise<IMediaInstance>

  The sound instance, this cannot be reused after it is done playing. Returns a Promise if the sound has not yet loaded.

  Method

  play

  Instance

• play(
      source?: string | CompleteCallback | PlayOptions,
      callback?: CompleteCallback,
  ): IMediaInstance | Promise<IMediaInstance>

  Plays the sound.

  Parameters

  • Optionalsource: string | CompleteCallback | PlayOptions

    Either completed function or play options.

  • Optionalcallback: CompleteCallback

    Callback when completed.

  Returns IMediaInstance | Promise<IMediaInstance>

  The sound instance, this cannot be reused after it is done playing. Returns a Promise if the sound has not yet loaded.

  Method

  play

  Instance

refresh

• refresh(): void

  Internal only, speed, loop, volume change occured.

  Returns void

refreshPaused

• refreshPaused(): void

  Handle changes in paused state. Internal only.

  Returns void

removeSprites

• removeSprites(alias?: string): Sound

  Remove a sound sprite.

  Parameters

  • Optionalalias: string

    The unique name of the sound sprite, if alias is omitted, removes all sprites.

  Returns Sound

resume

• resume(): this

  Resuming all the instances of this sound from playing

  Returns this

stop

• stop(): this

  Stops all the instances of this sound from playing.

  Returns this

Staticfrom

• from(
      source:
          | string
          | ArrayBuffer
          | string[]
          | Options
          | HTMLAudioElement
          | AudioBuffer,
  ): Sound

  Create a new sound instance from source.

  Parameters

  • source: string | ArrayBuffer | string[] | Options | HTMLAudioElement | AudioBuffer

    Either the path or url to the source file. or the object of options to use.

  Returns Sound

  Created sound instance.