Class AudioHandler

Resource handler used for loading Sound resources.

Hierarchy (view full)

ResourceHandler
- AudioHandler

Index

Properties

_app handlerType

Accessors

Methods

_createSound open patch

Properties

_app

The running app instance.

handlerType

handlerType: string = ''

Type of the resource the handler handles.

Accessors

maxRetries

get maxRetries(): number
Returns number
Inherited from ResourceHandler.maxRetries
- Defined in engine/src/framework/handlers/handler.js:48
set maxRetries(value): void
The number of times to retry a failed request for the resource.
Parameters
- value: number
Returns void
Inherited from ResourceHandler.maxRetries
- Defined in engine/src/framework/handlers/handler.js:44

Methods

`Private` _createSound

_createSound(url, success, error): void
Private
Loads an audio asset using an AudioContext by URL and calls success or error with the created resource or error respectively.
Parameters
- url: string
  The url of the audio asset.
- success: Function
  Function to be called if the audio asset was loaded or if we just want to continue without errors even if the audio is not loaded.
- error: Function
  Function to be called if there was an error while loading the audio asset.
Returns void
- Defined in engine/src/framework/handlers/audio.js:116

open

open(url, data, asset?): any
The open function is passed the raw resource data. The handler can then process the data into a format that can be used at runtime. The base implementation simply returns the data.
Parameters
- url: string
  The URL of the resource to open.
- data: any
  The raw resource data passed by callback from ResourceHandler#load.
- Optional asset: Asset
  Optional asset that is passed by ResourceLoader.
Returns any
The parsed resource data.
Inherited from ResourceHandler.open
- Defined in engine/src/framework/handlers/handler.js:79

patch

patch(asset, assets): void
The patch function performs any operations on a resource that requires a dependency on its asset data or any other asset data. The base implementation does nothing.
Parameters
- asset: Asset
  The asset to patch.
- assets: AssetRegistry
  The asset registry.
Returns void
Inherited from ResourceHandler.patch
- Defined in engine/src/framework/handlers/handler.js:90