ChannelCollection <Channel>

Operations on SoundChannels by name, see SoundManager.channel

Implements

• SoundManagerApi

Index

Constructors

• constructor

Properties

• soundManager

Methods

• get
• getVolume
• isMuted
• mute
• play
• setVolume
• stop
• toggle
• unmute

Constructors

constructor

• ChannelCollection<Channel>(soundManager: SoundManager<Channel, string>): ChannelCollection<Channel>

• Type parameters

  • Channel: string

  Parameters

  • soundManager: SoundManager<Channel, string>

  Returns ChannelCollection<Channel>

Properties

publicsoundManager

soundManager: SoundManager<Channel, string>

Methods

get

• get(name: Channel): SoundChannel

• Get the SoundChannel for direct access to its volume, mute and audio nodes

  ---

  Parameters

  • name: Channel

  Returns SoundChannel

getVolume

• getVolume(name: Channel): number

• Parameters

  • name: Channel

  Returns number

isMuted

• isMuted(name: Channel): boolean

• Parameters

  • name: Channel

  Returns boolean

mute

• mute(name: Channel): void

• Implementation of SoundManagerApi.mute

  Parameters

  • name: Channel

  Returns void

play

• play(name: Channel, options?: number | PlayOptions): Promise<boolean>

• Implementation of SoundManagerApi.play

  Play every sound in the channel, resolves to true if every sound played, false if any was dropped by a concurrency cap.

  ---

  Parameters

  • name: Channel

  • optionaloptions: number | PlayOptions

  Returns Promise<boolean>

setVolume

• setVolume(name: Channel, volume?: number): void

• Implementation of SoundManagerApi.setVolume

  Set the channel volume [0-1]

  ---

  Parameters

  • name: Channel

  • volume: number = 1

  Returns void

stop

• stop(name: Channel): void

• Implementation of SoundManagerApi.stop

  Stop every sound in the channel

  ---

  Parameters

  • name: Channel

  Returns void

toggle

• toggle(name: Channel): void

• Implementation of SoundManagerApi.toggle

  Parameters

  • name: Channel

  Returns void

unmute

• unmute(name: Channel): void

• Implementation of SoundManagerApi.unmute

  Parameters

  • name: Channel

  Returns void