AudioPlugin
Defined in: audio/src/AudioPlugin.ts:16
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioPlugin(
config?):AudioPlugin
Defined in: audio/src/AudioPlugin.ts:26
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”AudioPlugin
Properties
Section titled “Properties”
readonlyname:"audio"="audio"
Defined in: audio/src/AudioPlugin.ts:17
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"2.0.0"="2.0.0"
Defined in: audio/src/AudioPlugin.ts:18
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Methods
Section titled “Methods”install()
Section titled “install()”install(
context):Promise<void>
Defined in: audio/src/AudioPlugin.ts:35
Importing @yagejs/audio needs no browser: the audio library it plays
through is loaded here, when the plugin installs. Sounds registered with
registerSound before that are added to the library at the same point.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”Plugin.install
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: audio/src/AudioPlugin.ts:103
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/audio.md.