Class: AudioSystem

Binds AudioComponent._audio to the engine's IAudio on add, plays-on-awake once the entity is active, holds playback while the entity is inactive, and stops the primary handle + outstanding one-shots on remove.

Extends

• System

Constructors

Constructor

new AudioSystem(): AudioSystem;

Returns

AudioSystem

Inherited from

System.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
enabled	public	boolean	true	System.enabled
parallel	public	boolean	false	System.parallel

Methods

GetName()

GetName(): string;

Returns

string

Overrides

System.GetName

---

GetPhase()

GetPhase(): SystemPhase;

Returns

SystemPhase

Overrides

System.GetPhase

---

OnClose()

OnClose(): void;

Returns

void

Inherited from

System.OnClose

---

OnInit()

OnInit(engine): void;

Parameters

Parameter	Type
engine	IEngine

Returns

void

Overrides

System.OnInit

---

OnRender()

OnRender(_scene, _renderer): void | Promise<void>;

Parameters

Parameter	Type
_scene	Scene
_renderer	IRenderer

Returns

void | Promise<void>

Inherited from

System.OnRender

---

OnRendererChanged()

OnRendererChanged(_renderer): void;

Parameters

Parameter	Type
_renderer	IRenderer

Returns

void

Inherited from

System.OnRendererChanged

---

OnStart()

OnStart(scene, _renderer): void;

Parameters

Parameter	Type
scene	Scene
_renderer	IRenderer

Returns

void

Overrides

System.OnStart

---

OnStop()

OnStop(scene): void;

Parameters

Parameter	Type
scene	Scene

Returns

void

Overrides

System.OnStop

---

OnUpdate()

OnUpdate(scene, _dt): void;

A disabled source or an inactive entity's audio holds (Unity / Cocos): what's playing pauses on the way out and resumes on the way back; playOnAwake waits until it's enabled and active.

Parameters

Parameter	Type
scene	Scene
_dt	number

Returns

void

Overrides

System.OnUpdate