springroll.SoundTask Class

Extends springroll.Task
Defined in: springroll.SoundTask:11
Module: Sound

Internal task for preloading a list of sounds. When the result of the load is destroyed (destroy()), then the list of sounds are unloaded.

Constructor

springroll.SoundTask

(
  • asset
)
private

Defined in springroll.SoundTask:11

Parameters:

  • asset Object

    The data properties

    • sounds Array

      The list of Sound aliases

    • [cache=false] Boolean optional

      If we should cache the result

    • [id] String optional

      Id of asset

    • [complete] Function optional

      The event to call when done

destroy

()

Inherited from springroll.Task but overwritten in destroy:74

Destroy and don't use after this

filter

(
  • url
)
protected

Inherited from springroll.Task: filter:151

Add the sizing to each filter

Parameters:

  • url String

    The url to filter

load

(
  • source
  • [options]
)
protected

Inherited from springroll.Task: load:176

Pass-through to the Application load method

Parameters:

simpleLoad

(
  • url
  • complete
  • [progress]
  • [data]
)
protected

Inherited from springroll.Task: simpleLoad:188

Pass-through to the Application Loader.load

Parameters:

  • url String

    Path to file to load

  • complete Function

    The callback

  • [progress] Function optional

    The load progress

  • [data] Object optional

    Additiona data

start

(
  • callback
)

Inherited from springroll.Task but overwritten in start:51

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean
static

Defined in test:39

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset

cache

Boolean

Inherited from springroll.Task: cache:46

If we should cache the load and use later

Default: false

complete

Function

Inherited from springroll.Task: complete:37

The user call to fire when completed, returns the arguments result, original, and additionalAssets

Default: null

id

String

Inherited from springroll.Task: id:54

The task id

original

Object

Inherited from springroll.Task: original:66

Reference to the original asset data

sounds

Array

Defined in sounds:28

The path to the list of sound aliases

status

Int

Inherited from springroll.Task: status:30

The current status of the task (waiting, running, etc)

Default: 0

type

String

Inherited from springroll.Task: type:60

The task type for display filter