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:
- In most code editors, code hinting will be activated which helps remind you which special properties are available in VideoLoader
- 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).
The down side, of course, is that the code is more verbose and the VideoLoaderVars class adds slightly more kb to your swf.
USAGE:
Note that each method returns the VideoLoaderVars instance, so you can reduce the lines of code by method chaining (see example below).
Without VideoLoaderVars:
new VideoLoader("video.flv", {name:"video", estimatedBytes:111500, container:this, width:200, height:100, onComplete:completeHandler, onProgress:progressHandler})
With VideoLoaderVars
new VideoLoader("video.flv", new VideoLoaderVars().name("video").estimatedBytes(111500).container(this).width(200).height(100).onComplete(completeHandler).onProgress(progressHandler))
NOTES:
- To get the generic vars object that VideoLoaderVars builds internally, simply access its "vars" property.
In fact, if you want maximum backwards compatibility, you can tack ".vars" onto the end of your chain like this:
new VideoLoader("video.flv", new VideoLoaderVars().name("video").estimatedBytes(111500).vars);
- 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 2011, 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.
vars:Object [read-only]
The generic Object populated by all of the method calls in the VideoLoaderVars instance. This is the raw data that gets passed to the loader.
Implementation
public function get vars():Object
public function VideoLoaderVars(vars:Object = null)
Constructor
Parameters
| vars:Object (default = null) |
public function allowMalformedURL(value:Boolean):VideoLoaderVars Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. This avoids a few bugs in Flash, but if you need to keep the entire URL intact (no parsing into URLVariables), set allowMalformedURL:true. For example, if your URL has duplicate variables in the query string like http://www.greensock.com/?c=S&c=SE&c=SW, it is technically considered a malformed URL and a URLVariables object can't properly contain all the duplicates, so in this case you'd want to set allowMalformedURL to true.
Parameters
Returns
public function alpha(value:Number):VideoLoaderVars Sets the ContentDisplay's alpha property.
Parameters
Returns
public function alternateURL(value:String):VideoLoaderVars 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 ImageLoaders for example).
Parameters
Returns
public function autoAdjustBuffer(value:Boolean):VideoLoaderVars 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.
Parameters
Returns
public function autoDetachNetStream(value:Boolean):VideoLoaderVars If true (the default), the NetStream will only be attached to the Video object (the rawContent) when it is in the display list (on the stage). This conserves memory but it can cause a very brief rendering delay when the content is initially added to the stage (often imperceptible). Also, if you add it to the stage when the videoTime is after its last encoded keyframe, it will render at that last keyframe.
Parameters
Returns
public function autoDispose(value:Boolean):VideoLoaderVars When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with LoaderMax.getLoader() or LoaderMax.getContent() - it is essentially destroyed but its content is not unloaded (you must call unload() or dispose(true) to unload its content). The default autoDispose value is false.
Parameters
Returns
public function autoPlay(value:Boolean):VideoLoaderVars 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.
Parameters
Returns
public function bgAlpha(value:Number):VideoLoaderVars Controls the alpha of the rectangle that is drawn when a width and height are defined.
Parameters
Returns
public function bgColor(value:uint):VideoLoaderVars When a width and height are defined, a rectangle will be drawn inside the ContentDisplay Sprite immediately in order to ease the development process. It is transparent by default, but you may define a bgColor if you prefer.
Parameters
Returns
public function blendMode(value:String):VideoLoaderVars Sets the ContentDisplay's blendMode property.
Parameters
Returns
public function bufferMode(value:Boolean):VideoLoaderVars 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.
Parameters
Returns
public function bufferTime(value:Number):VideoLoaderVars 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).
Parameters
Returns
public function centerRegistration(value:Boolean):VideoLoaderVars 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.
Parameters
Returns
public function checkPolicyFile(value:Boolean):VideoLoaderVars 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).
Parameters
Returns
public function container(value:DisplayObjectContainer):VideoLoaderVars A DisplayObjectContainer into which the ContentDisplay Sprite should be added immediately.
Parameters
| value:DisplayObjectContainer |
Returns
public function crop(value:Boolean):VideoLoaderVars 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). This is typically useful when the scaleMode is "proportionalOutside" or "none" so that any parts of the image that exceed the dimensions defined by width and height are visually chopped off. Use the hAlign and vAlign special properties to control the vertical and horizontal alignment within the cropped area.
Parameters
Returns
public function deblocking(value:int):VideoLoaderVars 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.
Parameters
Returns
public function estimatedBytes(value:uint):VideoLoaderVars 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).
Parameters
Returns
public function estimatedDuration(value:Number):VideoLoaderVars 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.
Parameters
Returns
public function hAlign(value:String):VideoLoaderVars
When a width and height is defined, the hAlign determines how the image is horizontally aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode constants if you prefer):
"center" (the default) - The image will be centered horizontally in the area"left" - The image will be aligned with the left side of the area"right" - The image will be aligned with the right side of the area
Parameters
Returns
public function height(value:Number):VideoLoaderVars Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).
Parameters
Returns
public function name(value:String):VideoLoaderVars 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".
Parameters
Returns
public function noCache(value:Boolean):VideoLoaderVars If true, a "gsCacheBusterID" 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).
Parameters
Returns
public function onCancel(value:Function):VideoLoaderVars 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. Make sure your onCancel function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function onComplete(value:Function):VideoLoaderVars 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).
Parameters
Returns
public function onError(value:Function):VideoLoaderVars A handler function for LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the onFail special property. Make sure your onError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function onFail(value:Function):VideoLoaderVars 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).
Parameters
Returns
public function onHTTPStatus(value:Function):VideoLoaderVars A handler function for LoaderEvent.HTTP_STATUS events. Make sure your onHTTPStatus function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent). You can determine the httpStatus code using the LoaderEvent's target.httpStatus (LoaderItems keep track of their httpStatus when possible, although certain environments prevent Flash from getting httpStatus information).
Parameters
Returns
public function onInit(value:Function):VideoLoaderVars A handler function for LoaderEvent.INIT events which will be called when the video's metaData has been received and the video is placed into the ContentDisplay. Make sure your onInit function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function onIOError(value:Function):VideoLoaderVars 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. Make sure your onIOError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function onOpen(value:Function):VideoLoaderVars A handler function for LoaderEvent.OPEN events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function onProgress(value:Function):VideoLoaderVars 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.
Parameters
Returns
public function onSecurityError(value:Function):VideoLoaderVars 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. Make sure your onSecurityError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
Parameters
Returns
public function prop(property:String, value:*):VideoLoaderVars
Adds a dynamic property to the vars object containing any value you want. This can be useful
in situations where you need to associate certain data with a particular loader. Just make sure
that the property name is a valid variable name (starts with a letter or underscore, no special characters, etc.)
and that it doesn't use a reserved property name like "name" or "onComplete", etc.
For example, to set an "index" property to 5, do:
prop("index", 5);
Parameters
| property:String — Property name
|
| |
| value:* — Value
|
Returns
public function repeat(value:int):VideoLoaderVars Number of times that the video should repeat. To repeat indefinitely, use -1. Default is 0.
Parameters
Returns
public function requireWithRoot(value:DisplayObject):VideoLoaderVars 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;.
Parameters
Returns
public function rotation(value:Number):VideoLoaderVars Sets the ContentDisplay's rotation property.
Parameters
Returns
public function rotationX(value:Number):VideoLoaderVars Sets the ContentDisplay's rotationX property.
Parameters
Returns
public function rotationY(value:Number):VideoLoaderVars Sets the ContentDisplay's rotationY property.
Parameters
Returns
public function rotationZ(value:Number):VideoLoaderVars Sets the ContentDisplay's rotationZ property.
Parameters
Returns
public function scaleMode(value:String):VideoLoaderVars
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" (the default) - The image will fill the width/height exactly. "proportionalInside" - The image will be scaled proportionally to fit inside the area defined by the width/height"proportionalOutside" - The image will be scaled proportionally to completely fill the area, allowing portions of it to exceed the bounds defined by the width/height. "widthOnly" - Only the width of the image will be adjusted to fit."heightOnly" - Only the height of the image will be adjusted to fit."none" - No scaling of the image will occur.
Parameters
Returns
public function scaleX(value:Number):VideoLoaderVars Sets the ContentDisplay's scaleX property.
Parameters
Returns
public function scaleY(value:Number):VideoLoaderVars Sets the ContentDisplay's scaleY property.
Parameters
Returns
public function smoothing(value:Boolean):VideoLoaderVars When smoothing is true (the default), smoothing will be enabled for the video which typically leads to better scaling results.
Parameters
Returns
public function vAlign(value:String):VideoLoaderVars
When a width and height is defined, the vAlign determines how the image is vertically aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode constants if you prefer):
"center" (the default) - The image will be centered vertically in the area"top" - The image will be aligned with the top of the area"bottom" - The image will be aligned with the bottom of the area
Parameters
Returns
public function visible(value:Boolean):VideoLoaderVars Sets the ContentDisplay's visible property.
Parameters
Returns
public function volume(value:Number):VideoLoaderVars A value between 0 and 1 indicating the volume at which the video should play (default is 1).
Parameters
Returns
public function width(value:Number):VideoLoaderVars Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).
Parameters
Returns
public function x(value:Number):VideoLoaderVars Sets the ContentDisplay's x property (for positioning on the stage).
Parameters
Returns
public function y(value:Number):VideoLoaderVars Sets the ContentDisplay's y property (for positioning on the stage).
Parameters
Returns
public function z(value:Number):VideoLoaderVars Sets the ContentDisplay's z property (for positioning on the stage).
Parameters
Returns
