Packagecom.greensock.loading.data
Classpublic dynamic class VideoLoaderVars
InheritanceVideoLoaderVars Inheritance DisplayObjectLoaderVars Inheritance LoaderItemVars Inheritance LoaderCoreVars

Can be used instead of a generic object to define the vars parameter of a VideoLoader's constructor.

There are 2 primary benefits of using a VideoLoaderVars instance to define your VideoLoader variables:
  1. In most code editors, code hinting will be activated which helps remind you which special properties are available in VideoLoader
  2. It enables strict data typing for improved debugging (ensuring, for example, that you don't define a Boolean value for onComplete where a Function is expected).
USAGE:

Instead of new VideoLoader("video.flv", {name:"video", estimatedBytes:111500, container:this, width:200, height:100, onComplete:completeHandler, onProgress:progressHandler}), you could use this utility like:

var vars:VideoLoaderVars = new VideoLoaderVars();
vars.name = "video";
vars.estimatedBytes = 111500;
vars.container = this;
vars.width = 200;
vars.height = 100;
vars.onComplete = completeHandler;
vars.onProgress = progressHandler;
var loader:VideoLoader = new VideoLoader("video.flv", vars);

Some of the most common properties can be defined directly in the constructor like this:

var loader:VideoLoader = new VideoLoader("video.flv", new VideoLoaderVars("video", 111500, this, 200, 100, completeHandler, progressHandler) );

NOTE: Using VideoLoaderVars is completely optional. If you prefer the shorter synatax with the generic Object, feel free to use it. The purpose of this class is simply to enable code hinting and to allow for strict data typing.

Copyright 2010, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.



Public Properties
 PropertyDefined by
 Inheritedalpha : Number = 1
Sets the ContentDisplay's alpha property.
DisplayObjectLoaderVars
 InheritedalternateURL : String
If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again.
LoaderItemVars
  autoAdjustBuffer : Boolean = true
If the buffer becomes empty during playback and autoAdjustBuffer is true (the default), it will automatically attempt to adjust the NetStream's bufferTime based on the rate at which the video has been loading, estimating what it needs to be in order to play the rest of the video without emptying the buffer again.
VideoLoaderVars
 InheritedautoDispose : Boolean
When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event).
LoaderCoreVars
  autoPlay : Boolean = true
By default, the video will begin playing as soon as it has been adequately buffered, but to prevent it from playing initially, set autoPlay to false.
VideoLoaderVars
 InheritedbgAlpha : Number = 0
Controls the alpha of the rectangle that is drawn when a width and height are defined.
DisplayObjectLoaderVars
 InheritedbgColor : uint = 0
When a width and height are defined, a rectangle will be drawn inside the ContentDisplay Sprite immediately in order to ease the development process.
DisplayObjectLoaderVars
 InheritedblendMode : String = "normal"
Sets the ContentDisplay's blendMode property.
DisplayObjectLoaderVars
  bufferMode : Boolean
When true, the loader will report its progress only in terms of the video's buffer which can be very convenient if, for example, you want to display loading progress for the video's buffer or tuck it into a LoaderMax with other loaders and allow the LoaderMax to dispatch its COMPLETE event when the buffer is full instead of waiting for the whole file to download.
VideoLoaderVars
  bufferTime : Number = 5
The amount of time (in seconds) that should be buffered before the video can begin playing (set autoPlay to false to pause the video initially).
VideoLoaderVars
 InheritedcenterRegistration : Boolean
If true, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.
DisplayObjectLoaderVars
  checkPolicyFile : Boolean
If true, the VideoLoader will check for a crossdomain.xml file on the remote host (only useful when loading videos from other domains - see Adobe's docs for details about NetStream's checkPolicyFile property).
VideoLoaderVars
 Inheritedcontainer : DisplayObjectContainer
A DisplayObjectContainer into which the ContentDisplay Sprite should be added immediately.
DisplayObjectLoaderVars
 Inheritedcrop : Boolean
When a width and height are defined, setting crop to true will cause the image to be cropped within that area (by applying a scrollRect for maximum performance).
DisplayObjectLoaderVars
  deblocking : int = 0
Indicates the type of filter applied to decoded video as part of post-processing.
VideoLoaderVars
 InheritedestimatedBytes : uint
Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined).
LoaderItemVars
  estimatedDuration : Number
Estimated duration of the video in seconds.
VideoLoaderVars
 InheritedhAlign : String = "center"
When a width and height is defined, the hAlign determines how the image is horizontally aligned within that area.
DisplayObjectLoaderVars
 Inheritedheight : Number
Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).
DisplayObjectLoaderVars
 Inheritedname : String
A name that is used to identify the loader instance.
LoaderCoreVars
 InheritednoCache : Boolean
If true, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).
LoaderItemVars
 InheritedonCancel : Function
A handler function for LoaderEvent.CANCEL events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or cancel() was manually called.
LoaderCoreVars
 InheritedonComplete : Function
A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully.
LoaderCoreVars
 InheritedonError : Function
A handler function for LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR).
LoaderCoreVars
 InheritedonFail : Function
A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED.
LoaderCoreVars
 InheritedonHTTPStatus : Function
A handler function for LoaderEvent.HTTP_STATUS events.
LoaderCoreVars
 InheritedonIOError : Function
A handler function for LoaderEvent.IO_ERROR events which will also call the onError handler, so you can use that as more of a catch-all whereas onIOError is specifically for LoaderEvent.IO_ERROR events.
LoaderCoreVars
 InheritedonOpen : Function
A handler function for LoaderEvent.OPEN events which are dispatched when the loader begins loading.
LoaderCoreVars
 InheritedonProgress : Function
A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes.
LoaderCoreVars
 InheritedonSecurityError : Function
A handler function for LoaderEvent.SECURITY_ERROR events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events.
DisplayObjectLoaderVars
  repeat : int = 0
Number of times that the video should repeat.
VideoLoaderVars
 InheritedrequireWithRoot : DisplayObject
LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
LoaderCoreVars
 Inheritedrotation : Number = 0
Sets the ContentDisplay's rotation property.
DisplayObjectLoaderVars
 InheritedscaleMode : String
When a width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area.
DisplayObjectLoaderVars
 InheritedscaleX : Number = 1
Sets the ContentDisplay's scaleX property.
DisplayObjectLoaderVars
 InheritedscaleY : Number = 1
Sets the ContentDisplay's scaleY property.
DisplayObjectLoaderVars
  smoothing : Boolean = true
When smoothing is true (the default), smoothing will be enabled for the video which typically leads to better scaling results.
VideoLoaderVars
 InheritedvAlign : String = "center"
When a width and height is defined, the vAlign determines how the image is vertically aligned within that area.
DisplayObjectLoaderVars
 Inheritedvisible : Boolean = true
Sets the ContentDisplay's visible property.
DisplayObjectLoaderVars
  volume : Number = 1
A value between 0 and 1 indicating the volume at which the video should play (default is 1).
VideoLoaderVars
 Inheritedwidth : Number
Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).
DisplayObjectLoaderVars
 Inheritedx : Number = 0
Sets the ContentDisplay's x property (for positioning on the stage).
DisplayObjectLoaderVars
 Inheritedy : Number = 0
Sets the ContentDisplay's y property (for positioning on the stage).
DisplayObjectLoaderVars
Public Methods
 MethodDefined by
  
VideoLoaderVars(name:String = "", estimatedBytes:uint = 0, container:DisplayObjectContainer = null, autoPlay:Boolean = true, width:Number, height:Number, scaleMode:String = "stretch", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)
Constructor
VideoLoaderVars
  
Clones the object.
VideoLoaderVars
Property detail
autoAdjustBufferproperty
public var autoAdjustBuffer:Boolean = true

If the buffer becomes empty during playback and autoAdjustBuffer is true (the default), it will automatically attempt to adjust the NetStream's bufferTime based on the rate at which the video has been loading, estimating what it needs to be in order to play the rest of the video without emptying the buffer again. This can prevent the annoying problem of video playback start/stopping/starting/stopping on a system tht doesn't have enough bandwidth to adequately buffer the video. You may also set the bufferTime in the constructor's vars parameter to set the initial value.

autoPlayproperty 
public var autoPlay:Boolean = true

By default, the video will begin playing as soon as it has been adequately buffered, but to prevent it from playing initially, set autoPlay to false.

bufferModeproperty 
public var bufferMode:Boolean

When true, the loader will report its progress only in terms of the video's buffer which can be very convenient if, for example, you want to display loading progress for the video's buffer or tuck it into a LoaderMax with other loaders and allow the LoaderMax to dispatch its COMPLETE event when the buffer is full instead of waiting for the whole file to download. When bufferMode is true, the VideoLoader will dispatch its COMPLETE event when the buffer is full as opposed to waiting for the entire video to load. You can toggle the bufferMode anytime. Please read the full bufferMode property ASDoc description below for details about how it affects things like bytesTotal.

bufferTimeproperty 
public var bufferTime:Number = 5

The amount of time (in seconds) that should be buffered before the video can begin playing (set autoPlay to false to pause the video initially).

checkPolicyFileproperty 
public var checkPolicyFile:Boolean

If true, the VideoLoader will check for a crossdomain.xml file on the remote host (only useful when loading videos from other domains - see Adobe's docs for details about NetStream's checkPolicyFile property).

deblockingproperty 
public var deblocking:int = 0

Indicates the type of filter applied to decoded video as part of post-processing. The default value is 0, which lets the video compressor apply a deblocking filter as needed. See Adobe's flash.media.Video class docs for details.

estimatedDurationproperty 
public var estimatedDuration:Number

Estimated duration of the video in seconds. VideoLoader will only use this value until it receives the necessary metaData from the video in order to accurately determine the video's duration. You do not need to specify an estimatedDuration, but doing so can help make the playProgress and some other values more accurate (until the metaData has loaded). It can also make the progress/bytesLoaded/bytesTotal more accurate when a estimatedDuration is defined, particularly in bufferMode.

repeatproperty 
public var repeat:int = 0

Number of times that the video should repeat. To repeat indefinitely, use -1. Default is 0.

smoothingproperty 
public var smoothing:Boolean = true

When smoothing is true (the default), smoothing will be enabled for the video which typically leads to better scaling results.

volumeproperty 
public var volume:Number = 1

A value between 0 and 1 indicating the volume at which the video should play (default is 1).

Constructor detail
VideoLoaderVars()constructor
public function VideoLoaderVars(name:String = "", estimatedBytes:uint = 0, container:DisplayObjectContainer = null, autoPlay:Boolean = true, width:Number, height:Number, scaleMode:String = "stretch", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)

Constructor

Parameters
name:String (default = "") — A name that is used to identify the loader instance. This name can be fed to the LoaderMax.getLoader() or LoaderMax.getContent() methods or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".
 
estimatedBytes:uint (default = 0) — Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting estimatedBytes is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader is inserted into a LoaderMax instance (for queue management), its auditSize feature can attempt to automatically determine the bytesTotal at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).
 
container:DisplayObjectContainer (default = null) — A DisplayObjectContainer into which the ContentDisplay Sprite should be added immediately.
 
autoPlay:Boolean (default = true) — By default, the video will begin playing as soon as it has been adequately buffered, but to prevent it from playing initially, set autoPlay to false.
 
width:Number — Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).
 
height:Number — Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).
 
scaleMode:String (default = "stretch") — When a width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area. The following values are recognized (you may use the com.greensock.layout.ScaleMode constants if you prefer):"stretch" | "proportionalInside" | "proportionalOutside" | "widthOnly" | "heightOnly" | "none"
 
onComplete:Function (default = null) — A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
 
onProgress:Function (default = null) — A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. Make sure your onProgress function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent). You can use the LoaderEvent's target.progress to get the loader's progress value or use its target.bytesLoaded and target.bytesTotal.
 
onFail:Function (default = null) — A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED. Make sure your onFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
 
noCache:Boolean (default = false) — If true, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).
 
alternateURL:String (default = "") — If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again. Think of it as a fallback or backup url. It is perfectly acceptable to use the same alternateURL for multiple loaders (maybe a default image for various VideoLoaders for example).
 
requireWithRoot:DisplayObject (default = null) — LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this loader as part of its parent SWFLoader's progress, you must set the requireWithRoot property to your swf's root. For example, vars.requireWithRoot = this.root;.
Method detail
clone()method
public function clone():VideoLoaderVars

Clones the object.

Returns
VideoLoaderVars