dojox/av/FLAudio.js

• Provides:

  • dojox.av.FLAudio

• Requires:

  • dojox.embed.Flash in common
  • dojox.timing.doLater in common

• dojox.av.FLAudio

  • type

    Function

  • parameters:
    • options: (typeof Object)
  • summary

    Play MP3 files through the Flash SWF built in the
    DEFT project.

  • description

    This class is brand new, so there is a lot of
    functionality not yet available. The initial
    purpose is for playing "event" sounds like button
    clicks, and for loading and controlling multiple
    sounds at once. As of yet, streaming is not supported
    and polling the sounds for events during playback
    may still be missing information. Markup is not
    supported, as it may not be needed.
    
    TODO:
    Streaming, playback events, crossdomain, CDN support,
    (alternate SWF location), global volume, ID3 tag,
    factor out doLater, onLoadStatus needs work,
    play(position) / seek()

  • example

    	new dojox.av.FLAudio({
    		initialVolume:.7,
    		initialPan:0,
    		autoPlay:false
    	});

• dojox.av.FLAudio.id

  • optional
  • type

    String

  • summary

    The id of this widget and the id of the SWF movie.

• dojox.av.FLAudio.initialVolume

  • type

    Number

  • summary

    From 0-1
    Sets volume for all files unless changed with doPlay
    or setVolume

• dojox.av.FLAudio.initialPan

  • type

    Number

  • summary

    From -1 to 1 (-1 is left, 1 is right, 0 is middle)
    Sets pan for all files unless changed with play
    or setPan
    
    
    
    autoPlay: Boolean
    If true, all files will play upon load. If false,
    they load and wait for doPlay() command.

• dojox.av.FLAudio.isDebug

  • optional
  • type

    Boolean

  • summary

    Setting to true tells the SWF to output log messages to Firebug.

• dojox.av.FLAudio.statusInterval

  • type

    Number

  • summary

    How often in milliseconds that the status of the
    player is checked - both load and play

• dojox.av.FLAudio._swfPath

  • type

    Uri

  • summary

    The path to the video player SWF resource

• dojox.av.FLAudio.allowScriptAccess

  • type

    String

  • summary

    Whether the SWF can access the container JS

• dojox.av.FLAudio.allowNetworking

  • type

    String

  • summary

    Whether SWF is restricted to a domain

• dojox.av.FLAudio.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • options: (typeof Object)

• dojox.av.FLAudio.init

  • summary

    Initialize the media.

  • type

    Function

• dojox.av.FLAudio._subs

  • type

    Array

• dojox.av.FLAudio._flashObject

  • type

    Object

• dojox.av.FLAudio._flashObject.onError

  • parameters:
    • err
  • type

    Function

• dojox.av.FLAudio._flashObject.onLoad

  • type

    Object

• dojox.av.FLAudio.load

  • parameters:
    • options: (typeof Object)

      url: String
      (required) path to MP3 media
      url must be absolute or relative to SWF,
      not dojo or the html. An effort will be made
      to fix incorrect paths.
      id: String
      (optional) an identifier to later determine
      which media to control.

  • returns

    String

  • summary

    Adds a media object to the playlist
    ***This can be called repeatedly to add multiple items.

  • return_summary

    The normalized url, which can be used to identify the
    audio.

  • type

    Function

• dojox.av.FLAudio.doPlay

  • parameters:
    • options: (typeof Object)

      volume: Number
      Sets the volume
      pan: Number
      Sets left/right pan
      index:Number OR id:String OR url:String
      Choose one of the above to indentify
      the media you wish to control. id is
      set by you. index is the order in which
      media was added (zero based)
      NOTE: lack of an identifier will default
      to first (or only) item.
      NOTE: Can't name this method "play()" as it causes
      an IE error.

  • summary

    Tell media to play, based on
    the options passed.

  • type

    Function

• dojox.av.FLAudio.pause

  • parameters:
    • options: (typeof Object)

      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Tell media to pause, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.stop

  • parameters:
    • options: (typeof Object)

      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Tell media to stop, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.setVolume

  • parameters:
    • options: (typeof Object)

      volume: Number
      0 to 1
      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Set media volume, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.setPan

  • parameters:
    • options: (typeof Object)

      pan:Number -1 to 1
      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Set media pan, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.getVolume

  • parameters:
    • options: (typeof Object)

      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Get media volume, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.getPan

  • parameters:
    • options: (typeof Object)

      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Set media pan, based on identifier in
    the options passed.

  • type

    Function

• dojox.av.FLAudio.getPosition

  • parameters:
    • options: (typeof Object)

      index:Number OR id:String OR url:String
      See doPlay()

  • summary

    Get the current time.

  • type

    Function

• dojox.av.FLAudio.onError

  • parameters:
    • msg
  • summary

    stub fired when an error occurs

  • type

    Function

• dojox.av.FLAudio.onLoadStatus

  • parameters:
    • events: (typeof Array)
  • type

    Function

• dojox.av.FLAudio.onAllLoaded

  • summary

    stub fired

  • type

    Function

• dojox.av.FLAudio.onPlayStatus

  • parameters:
    • events: (typeof Array)
  • type

    Function

• dojox.av.FLAudio.onComplete

  • parameters:
    • events: (typeof Array)
  • summary

    Fired at the end of a media file.

  • type

    Function

• dojox.av.FLAudio.onLoad

  • summary

    stub fired when SWF is ready

  • type

    Function

• dojox.av.FLAudio.onID3

  • parameters:
    • evt
  • summary

    Fired when the ID3 data is received.

  • type

    Function

• dojox.av.FLAudio.destroy

  • summary

    destroys flash

  • type

    Function

• dojox.av.FLAudio._sub

  • parameters:
    • topic
    • method
  • summary

    helper for subscribing to topics

  • type

    Function

• dojox.av.FLAudio._normalizeVolume

  • parameters:
    • vol
  • summary

    Ensures volume is less than one

  • type

    Function

• dojox.av.FLAudio._normalizeUrl

  • parameters:
    • _url
  • summary

    Checks that path is relative to HTML file or
    convertes it to an absolute path.

  • type

    Function

• dojox.av.FLAudio.domNode

  • type

    Object

• dojo.global.swfIsInHTML

  • type

    Function

• dojox.av

  • type

    Object

• dojox

  • type

    Object