dojox/av/FLVideo.js

• Provides:

  • dojox.av.FLVideo

• Requires:

  • dijit._Widget in common
  • dojox.embed.Flash in common
  • dojox.av._Media in common

• dojox.av.FLVideo

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dojox.av._Media.prototype: (prototype)
    • dijit._Widget: (call)
    • dojox.av._Media: (call)
  • parameters:
    • options: (typeof Object)
  • summary

    Inserts a Flash FLV video into the HTML page and provides methods
    and events for controlling the video. Also plays the H264/M4V codec
    with a little trickery: change the '.M4V' extension to '.flv'.

  • example

    markup:
    	<div id="vid" initialVolume=".7",
    		mediaUrl="../resources/Grog.flv"
    		dojoType="dojox.av.FLVideo"></div>
    programmatic:
    	new dojox.av.FLVideo({
    		initialVolume:.7,
    		mediaUrl:"../resources/Grog.flv"
    	}, "vid");
    
    mediaUrl: String
    REQUIRED: The Url of the video file that will be played.
    NOTE: Must be either an absolute URL or relative to the HTML file.
    Relative paths will be converted to abslute paths

• dojox.av.FLVideo._swfPath

  • type

    Uri

  • summary

    The path to the video player SWF resource

• dojox.av.FLVideo.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • options: (typeof Object)

• dojox.av.FLVideo.postCreate

  • summary

    Initialize the media.

  • type

    Function

• dojox.av.FLVideo._subs

  • type

    Array

• dojox.av.FLVideo._cons

  • type

    Array

• dojox.av.FLVideo.mediaUrl

  • type

    Object

• dojox.av.FLVideo.initialVolume

  • type

    Object

• dojox.av.FLVideo._flashObject

  • type

    Object

• dojox.av.FLVideo._flashObject.onError

  • parameters:
    • err
  • type

    Function

• dojox.av.FLVideo._flashObject.onLoad

  • type

    Object

• dojox.av.FLVideo.play

  • parameters:
    • newUrl: (typeof String)
  • summary

    Plays the video. If an url is passed in, plays the new link.

  • type

    Function

• dojox.av.FLVideo.isPlaying

  • type

    bool

• dojox.av.FLVideo.isStopped

  • type

    bool

• dojox.av.FLVideo.pause

  • summary

    Pauses the video

  • type

    Function

• dojox.av.FLVideo.seek

  • parameters:
    • time: (typeof Float)
  • summary

    Goes to the time passed in the argument

  • type

    Function

• dojox.av.FLVideo.volume

  • parameters:
    • vol: (typeof Float)
  • returns

    Float

  • summary

    Sets the volume of the video to the time in the
    argument - between 0 - 1.

  • type

    Function

• dojox.av.FLVideo.onLoad

  • parameters:
    • mov
  • summary

    Fired when the SWF player has loaded
    NOT when the video has loaded

  • type

    Function

• dojox.av.FLVideo.onDownloaded

  • parameters:
    • percent
  • summary

    Fires the amount of that the media has been
    downloaded. Number, 0-100

  • type

    Function

• dojox.av.FLVideo.onClick

  • parameters:
    • evt
  • summary

    Fires when the player is clicked
    Could be used to toggle play/pause, or
    do an external activity, like opening a new
    window.

  • type

    Function

• dojox.av.FLVideo.onSwfSized

  • parameters:
    • data
  • summary

    Fired on SWF resize, or when its
    toggled between fullscreen.

  • type

    Function

• dojox.av.FLVideo.onMetaData

  • parameters:
    • data
    • evt
  • summary

    The video properties. Width, height, duration, etc.
    NOTE: 	if data is empty, this is an older FLV with no meta data.
    Duration cannot be determined. In original FLVs, duration
    could only be obtained with Flash Media Server.
    NOTE: 	Older FLVs can still return width and height
    and will do so on a second event call

  • type

    Function

• dojox.av.FLVideo.onPosition

  • parameters:
    • time
  • summary

    The position of the playhead in seconds

  • type

    Function

• dojox.av.FLVideo.onStart

  • parameters:
    • data
  • summary

    Fires when video starts
    Good for setting the play button to pause
    during an autoPlay for example

  • type

    Function

• dojox.av.FLVideo.onPlay

  • parameters:
    • data
  • summary

    Fires when video starts and resumes

  • type

    Function

• dojox.av.FLVideo.onPause

  • parameters:
    • data
  • summary

    Fires when the pause button is clicked

  • type

    Function

• dojox.av.FLVideo.onEnd

  • parameters:
    • data
  • summary

    Fires when video ends
    Could be used to change pause button to play
    or show a post video graphic, like YouTube

  • type

    Function

• dojox.av.FLVideo.onStop

  • summary

    Fire when the Stop button is clicked
    TODO: 	This is not hooked up yet and shouldn't
    fire.

  • type

    Function

• dojox.av.FLVideo.onBuffer

  • parameters:
    • isBuffering
  • summary

    Fires a boolean to tell if media
    is paused for buffering or if buffering
    has finished

  • type

    Function

• dojox.av.FLVideo.isBuffering

• dojox.av.FLVideo.onError

  • parameters:
    • data
    • url
  • summary

    Fired when the player encounters an error

  • example

     console.warn("ERROR-"+data.type.toUpperCase()+":",
    		data.info.code, " - URL:", url);

  • type

    Function

• dojox.av.FLVideo.onStatus

  • parameters:
    • data
  • summary

    Simple status

  • type

    Function

• dojox.av.FLVideo.onPlayerStatus

  • parameters:
    • data
  • summary

    The status of the video from the SWF
    playing, stopped, bufering, etc.

  • type

    Function

• dojox.av.FLVideo.onResize

  • summary

    Fired on page resize

  • type

    Function

• dojox.av.FLVideo._checkBuffer

  • parameters:
    • time: (typeof Float)
    • bufferLength: (typeof Float)
  • summary

    Checks that there is a proper buffer time between
    current playhead time and the amount of data loaded.
    Works only on FLVs with a duration (not older). Pauses
    the video while continuing download.

  • type

    Function

• dojox.av.FLVideo._update

  • summary

    Helper function to fire onPosition, check download progress,
    and check buffer.

  • type

    Function

• dojox.av.FLVideo.percentDownloaded

  • type

    Object

• dojox.av.FLVideo._updateHandle

  • type

    Object

• dojox.av.FLVideo.destroy

  • type

    Function

• dojo.global.swfIsInHTML

  • type

    Function

• dojox.av

  • type

    Object

• dojox

  • type

    Object