Options
Menu

Class WaveAudioParser

Hierarchy

Index

Constructors

constructor

Properties

_iFileName

_iFileName: string

_isParsing

_isParsing: boolean

_pContent

_pContent: IAsset

Static MORE_TO_PARSE

MORE_TO_PARSE: boolean

Returned by proceedParsing to indicate more parsing is needed, allowing asynchronous parsing.

Static PARSING_DONE

PARSING_DONE: boolean

Returned by proceedParsing to indicate no more parsing is needed.

Accessors

content

data

  • get (): any
  • Returns any

dataFormat

  • get (): string
  • The data format of the file data to be parsed. Options are URLLoaderDataFormat.BINARY, URLLoaderDataFormat.ARRAY_BUFFER, URLLoaderDataFormat.BLOB, URLLoaderDataFormat.VARIABLES or URLLoaderDataFormat.TEXT.

    Returns string

dependencies

materialMode

  • get (): number
  • set (newMaterialMode: number): void

parsingComplete

  • get (): boolean

parsingFailure

  • get (): boolean
  • set (b: boolean): void

parsingPaused

  • get (): boolean

Methods

_iResolveDependency

  • Resolve a dependency when it's loaded. For example, a dependency containing an ImageResource would be assigned to a Mesh instance as a BitmapMaterial, a scene graph object would be added to its intended parent. The dependency should be a member of the dependencies property.

    Parameters

    Returns void

_iResolveDependencyFailure

  • Resolve a dependency loading failure. Used by parser to eventually provide a default map

    Parameters

    Returns void

_iResolveDependencyName

_iResumeParsing

  • _iResumeParsing(): void

_pAddDependency

  • _pAddDependency(id: string, req: URLRequest, retrieveAsRawData?: boolean, data?: any, suppressErrorEvents?: boolean, sub_id?: number): ResourceDependency
  • Parameters

    • id: string
    • req: URLRequest
    • Default value retrieveAsRawData: boolean = false
    • Default value data: any = null
    • Default value suppressErrorEvents: boolean = false
    • Default value sub_id: number = 0

    Returns ResourceDependency

_pDieWithError

  • _pDieWithError(message?: string): void
  • Parameters

    • Default value message: string = "Unknown parsing error"

    Returns void

_pFinalizeAsset

  • _pFinalizeAsset(asset: IAsset, name?: string): void

_pFinishParsing

  • _pFinishParsing(): void

Private _pGetByteData

Private _pGetData

  • _pGetData(): any

Private _pGetTextData

  • _pGetTextData(): string

_pHasTime

  • _pHasTime(): boolean
  • Tests whether or not there is still time left for parsing within the maximum allowed time frame per session.

    Returns boolean

    True if there is still time left, false if the maximum allotted time was exceeded and parsing should be interrupted.

_pOnInterval

  • Called when the parsing pause interval has passed and parsing can proceed.

    Parameters

    Returns void

_pPauseAndRetrieveDependencies

  • _pPauseAndRetrieveDependencies(): void

_pPauseParsing

  • _pPauseParsing(): void

_pProceedParsing

  • _pProceedParsing(): boolean

_pStartParsing

  • _pStartParsing(frameLimit: number): void
  • Parameters

    • frameLimit: number

    Returns void

addEventListener

  • addEventListener(type: string, listener: function): void
  • Add an event listener

    method

    addEventListener

    Parameters

    • type: string
    • listener: function

    Returns void

dispatchEvent

hasEventListener

  • hasEventListener(type: string, listener?: function): boolean
  • check if an object has an event listener assigned to it

    method

    hasListener

    Parameters

    • type: string
    • Optional listener: function

    Returns boolean

parseAsync

  • parseAsync(data: any, frameLimit?: number): void
  • Parse data (possibly containing bytearry, plain text or BitmapAsset) asynchronously, meaning that the parser will periodically stop parsing so that the AVM may proceed to the next frame.

    Parameters

    • data: any

      The untyped data object in which the loaded data resides.

    • Default value frameLimit: number = 30

      number of milliseconds of parsing allowed per frame. The actual time spent on a frame can exceed this number since time-checks can only be performed between logical sections of the parsing procedure.

    Returns void

removeEventListener

  • removeEventListener(type: string, listener: function): void
  • Remove an event listener

    method

    removeEventListener

    Parameters

    • type: string
    • listener: function

    Returns void

Static processFilename

  • processFilename(filename: any): string
  • Parameters

    • filename: any

    Returns string

Static supportsData

  • supportsData(data: any): boolean
  • Parameters

    • data: any

    Returns boolean

Static supportsType

  • supportsType(extension: string): boolean
  • Parameters

    • extension: string

    Returns boolean

Generated using TypeDoc