Class SoundsPluginInstance

Implements

IContainerPlugin

Index

Constructors

Methods

init mute start stop toggleMute unmute volumeDown volumeUp

Constructors

constructor

new SoundsPluginInstance(
container: SoundsContainer,
engine: Engine,
): SoundsPluginInstance
Creates a new SoundsPluginInstance
Parameters
- container: SoundsContainer
  the container using this plugin
- engine: Engine
  the engine instance
Returns SoundsPluginInstance
- Defined in SoundsPluginInstance.ts:129

Methods

init

init(): Promise<void>
Returns Promise<void>
Inherit Doc
Implementation of IContainerPlugin.init
- Defined in SoundsPluginInstance.ts:138

mute

mute(): Promise<void>
Mutes the audio

Returns Promise<void>
- Defined in SoundsPluginInstance.ts:199

start

start(): Promise<void>
Returns Promise<void>
Inherit Doc
Implementation of IContainerPlugin.start
- Defined in SoundsPluginInstance.ts:206

stop

stop(): void
Returns void
Inherit Doc
Implementation of IContainerPlugin.stop
- Defined in SoundsPluginInstance.ts:284

toggleMute

toggleMute(): Promise<void>
Toggles between mute and unmute

Returns Promise<void>
- Defined in SoundsPluginInstance.ts:298

unmute

unmute(): Promise<void>
Unmutes the audio

Returns Promise<void>
- Defined in SoundsPluginInstance.ts:308

volumeDown

volumeDown(): Promise<void>
Decreases the volume by the configured step

Returns Promise<void>
- Defined in SoundsPluginInstance.ts:315

volumeUp

volumeUp(): Promise<void>
Increases the volume by the configured step

Returns Promise<void>
- Defined in SoundsPluginInstance.ts:333