Interface: IAudio
Core interface types.
Methods
GetMasterVolume()
ts
GetMasterVolume(): number;Returns
number
Init()
ts
Init(assetLoader): Promise<void>;Parameters
| Parameter | Type |
|---|---|
assetLoader | IAssetLoader |
Returns
Promise<void>
IsMuted()
ts
IsMuted(): boolean;Returns
boolean
IsPlaying()
ts
IsPlaying(handle): boolean;Parameters
| Parameter | Type |
|---|---|
handle | number |
Returns
boolean
Pause()
ts
Pause(handle): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
Returns
void
PauseAll()
ts
PauseAll(): void;Returns
void
Play()
ts
Play(assetId, options?): number;Parameters
| Parameter | Type |
|---|---|
assetId | string |
options? | AudioPlayOptions |
Returns
number
Resume()
ts
Resume(handle): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
Returns
void
ResumeAll()
ts
ResumeAll(): void;Returns
void
SetLoop()
ts
SetLoop(handle, loop): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
loop | boolean |
Returns
void
SetMasterVolume()
ts
SetMasterVolume(volume): void;Parameters
| Parameter | Type |
|---|---|
volume | number |
Returns
void
SetMuted()
ts
SetMuted(muted): void;Parameters
| Parameter | Type |
|---|---|
muted | boolean |
Returns
void
SetPitch()
ts
SetPitch(handle, pitch): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
pitch | number |
Returns
void
SetVolume()
ts
SetVolume(handle, volume): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
volume | number |
Returns
void
Shutdown()
ts
Shutdown(): Promise<void>;Returns
Promise<void>
Stop()
ts
Stop(handle): void;Parameters
| Parameter | Type |
|---|---|
handle | number |
Returns
void
StopAll()
ts
StopAll(): void;Returns
void
Unlock()
ts
Unlock(): Promise<void>;Idempotent. Call from inside a user-gesture handler to satisfy mobile autoplay rules.
Returns
Promise<void>