| Package | com.greensock.loading.data |
| Class | public dynamic class VideoLoaderVars |
| Inheritance | VideoLoaderVars  DisplayObjectLoaderVars LoaderItemVars LoaderCoreVars |
vars parameter of a VideoLoader's constructor. onComplete where a Function is expected).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. | Property | Defined by | ||
|---|---|---|---|
 | alpha : Number = 1 Sets the
ContentDisplay's alpha property. | DisplayObjectLoaderVars | |
| alternateURL : 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 | ||
| autoDispose : 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 | ||
| bgAlpha : Number = 0 Controls the alpha of the rectangle that is drawn when a
width and height are defined. | DisplayObjectLoaderVars | |
| bgColor : 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 | |
| blendMode : 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 | ||
| centerRegistration : 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 | ||
| container : DisplayObjectContainer A DisplayObjectContainer into which the
ContentDisplay Sprite should be added immediately. | DisplayObjectLoaderVars | |
| crop : 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 | ||
| estimatedBytes : 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 | ||
| hAlign : String = "center"
When a
width and height is defined, the hAlign determines how the image is horizontally aligned within that area. | DisplayObjectLoaderVars | |
| height : Number Sets the
ContentDisplay's height property (applied before rotation, scaleX, and scaleY). | DisplayObjectLoaderVars | |
| name : String A name that is used to identify the loader instance.
| LoaderCoreVars | |
| noCache : 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 | |
| onCancel : 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 | |
| onComplete : Function A handler function for
LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. | LoaderCoreVars | |
| onError : 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 | |
| onFail : Function A handler function for
LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED. | LoaderCoreVars | |
| onHTTPStatus : Function A handler function for
LoaderEvent.HTTP_STATUS events. | LoaderCoreVars | |
| onIOError : 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 | |
| onOpen : Function A handler function for
LoaderEvent.OPEN events which are dispatched when the loader begins loading. | LoaderCoreVars | |
| onProgress : Function A handler function for
LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. | LoaderCoreVars | |
| onSecurityError : 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 | ||
| requireWithRoot : DisplayObject LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
| LoaderCoreVars | |
| rotation : Number = 0 Sets the
ContentDisplay's rotation property. | DisplayObjectLoaderVars | |
| scaleMode : String
When a
width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area. | DisplayObjectLoaderVars | |
| scaleX : Number = 1 Sets the
ContentDisplay's scaleX property. | DisplayObjectLoaderVars | |
| scaleY : 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 | ||
| vAlign : String = "center"
When a
width and height is defined, the vAlign determines how the image is vertically aligned within that area. | DisplayObjectLoaderVars | |
| visible : 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 | ||
| width : Number Sets the
ContentDisplay's width property (applied before rotation, scaleX, and scaleY). | DisplayObjectLoaderVars | |
| x : Number = 0 Sets the
ContentDisplay's x property (for positioning on the stage). | DisplayObjectLoaderVars | |
| y : Number = 0 Sets the
ContentDisplay's y property (for positioning on the stage). | DisplayObjectLoaderVars | |
| Method | Defined 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 | ||
| autoAdjustBuffer | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic 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.
| autoPlay | property |
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.
| bufferMode | property |
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.
| bufferTime | property |
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).
| checkPolicyFile | property |
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).
| deblocking | property |
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.
| estimatedDuration | property |
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.
| repeat | property |
public var repeat:int = 0Number of times that the video should repeat. To repeat indefinitely, use -1. Default is 0.
| smoothing | property |
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.
| volume | property |
public var volume:Number = 1A value between 0 and 1 indicating the volume at which the video should play (default is 1).
| 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
Parametersname:String (default = "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)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)ContentDisplay Sprite should be added immediately.
|
|
autoPlay:Boolean (default = true)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")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)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)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)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)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 = "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)requireWithRoot property to your swf's root. For example, vars.requireWithRoot = this.root;.
|
| clone | () | method |