SoundManager <Channel, SoundName>

Manage Sound volume levels without mutating the original Sound objects

Implements

• SoundManagerApi

Index

Constructors

• constructor

Properties

• _muted
• channel

Accessors

• defaultVolume

Methods

• _getEffectiveVolume
• _isMuted
• addChannel
• getSound
• getSounds
• getSoundsForChannel
• getVolume
• mute
• play
• removeChannel
• setVolume
• stop
• toggle
• track
• unmute
• untrack

Constructors

constructor

• new SoundManager<Channel, SoundName>(options: SoundManagerOptions<Channel, SoundName>): SoundManager<Channel, SoundName>

• Type parameters

  • Channel: string
  • SoundName: string

  Parameters

  • options: SoundManagerOptions<Channel, SoundName>

  Returns SoundManager<Channel, SoundName>

Properties

public_muted

_muted: Set<Sound> = ...

publicchannel

channel: ChannelCollection<Channel>

Accessors

publicdefaultVolume

• get defaultVolume(): number
• set defaultVolume(volume: number): void

• Returns number

• Parameters

  • volume: number

  Returns void

Methods

public_getEffectiveVolume

• _getEffectiveVolume(sound: Sound): number

• Parameters

  • sound: Sound

  Returns number

public_isMuted

• _isMuted(sound: Sound): boolean

• Parameters

  • sound: Sound

  Returns boolean

publicaddChannel

• addChannel(soundName: SoundName | AnyString, channels: Channel[] | AnyString[]): void

• Apply a list of channels to a sound instance

  ---

  Parameters

  • soundName: SoundName | AnyString

  • channels: Channel[] | AnyString[]

  Returns void

publicgetSound

• getSound(soundName: SoundName | AnyString): Sound

• Parameters

  • soundName: SoundName | AnyString

  Returns Sound

publicgetSounds

• getSounds(): readonly Sound[]

• Returns readonly Sound[]

publicgetSoundsForChannel

• getSoundsForChannel(channel: Channel | AnyString): readonly Sound[]

• Parameters

  • channel: Channel | AnyString

  Returns readonly Sound[]

publicgetVolume

• getVolume(soundName: SoundName): number

• Gets the volumn for a sound

  ---

  Parameters

  • soundName: SoundName

  Returns number

publicmute

• mute(name?: SoundName): void

• Implementation of SoundManagerApi.mute

  Parameters

  • optionalname: SoundName

  Returns void

publicplay

• play(soundName: SoundName, volume?: number): Promise<void>

• Implementation of SoundManagerApi.play

  Parameters

  • soundName: SoundName

  • volume: number = ...

  Returns Promise<void>

publicremoveChannel

• removeChannel(soundName: SoundName | AnyString, channels: Channel[] | AnyString[]): void

• Parameters

  • soundName: SoundName | AnyString

  • channels: Channel[] | AnyString[]

  Returns void

publicsetVolume

• setVolume(soundname: SoundName, volume?: number): void

• Implementation of SoundManagerApi.setVolume

  Parameters

  • soundname: SoundName

  • volume: number = ...

  Returns void

publicstop

• stop(name?: SoundName): void

• Implementation of SoundManagerApi.stop

  Parameters

  • optionalname: SoundName

  Returns void

publictoggle

• toggle(name?: SoundName): void

• Implementation of SoundManagerApi.toggle

  Parameters

  • optionalname: SoundName

  Returns void

publictrack

• track(name: SoundName | AnyString, soundOrConfig: Sound | SoundConfig<string>): void

• Parameters

  • name: SoundName | AnyString

  • soundOrConfig: Sound | SoundConfig<string>

  Returns void

publicunmute

• unmute(name?: SoundName): void

• Implementation of SoundManagerApi.unmute

  Parameters

  • optionalname: SoundName

  Returns void

publicuntrack

• untrack(soundName: SoundName): void

• Remove the maximum volume for a sound, will be 100% of the source volume

  Untracks the Sound in the sound manager

  ---

  Parameters

  • soundName: SoundName

  Returns void