phaser - v4.0.0-rc.4
    Preparing search index...

    An Audio Sprite File suitable for loading by the Loader.

    These are created when you use the Phaser.Loader.LoaderPlugin#audioSprite method and are not typically created directly.

    For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audioSprite.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • loader: LoaderPlugin

        A reference to the Loader that is responsible for this file.

      • key: string | AudioSpriteFileConfig

        The key to use for this file, or a file configuration object.

      • jsonURL: string

        The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.

      • OptionalaudioURL: Object

        The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.

      • OptionalaudioConfig: any

        The audio configuration options.

      • OptionalaudioXhrSettings: XHRSettingsObject

        An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.

      • OptionaljsonXhrSettings: XHRSettingsObject

        An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.

      Returns AudioSpriteFile

    Properties

    baseURL: string

    A reference to the Loaders baseURL at the time this MultiFile was created. Used to populate child-files.

    complete: boolean

    The completion status of this MultiFile.

    config: any

    A storage container for transient data that the loading files need.

    failed: number

    The number of files that failed to load.

    files: File[]

    Array of files that make up this MultiFile.

    key: string

    Unique cache key (unique within its file type)

    loader: LoaderPlugin

    A reference to the Loader that is going to load this file.

    path: string

    A reference to the Loaders path at the time this MultiFile was created. Used to populate child-files.

    pending: number

    The number of files to load.

    prefix: string

    A reference to the Loaders prefix at the time this MultiFile was created. Used to populate child-files.

    state: number

    The current state of the file. One of the FILE_CONST values.

    type: string

    The file type string for sorting within the Loader.

    Methods

    • Adds this file to its target cache upon successful loading and processing.

      Returns void

    • Called once all children of this multi file have been added to their caches and is now ready for deletion from the Loader.

      It will emit a filecomplete event from the LoaderPlugin.

      Returns void