API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class VideoLoader

Package | com.greensock.loading
Class | public class VideoLoader
Inheritance | VideoLoader LoaderItem LoaderCore flash.events.EventDispatcher

Loads an FLV, F4V, or MP4 video file using a NetStream and also provides convenient playback methods and properties like `pauseVideo(), playVideo(), gotoVideoTime(), bufferProgress, playProgress, volume, duration, videoPaused, metaData,` and `videoTime`. Just like ImageLoader and SWFLoader, VideoLoader's `content` property refers to a `ContentDisplay` object (Sprite) that gets created immediately so that you can position/scale/rotate it or add ROLL_OVER/ROLL_OUT/CLICK listeners before (or while) the video loads. Use the VideoLoader's `content` property to get the ContentDisplay Sprite, or use the `rawContent` property to get the `Video` object that is used inside the ContentDisplay to display the video. If a `container` is defined in the `vars` object, the ContentDisplay will immediately be added to that container).
You don't need to worry about creating a NetConnection, a Video object, attaching the NetStream, or any of the typical hassles. VideoLoader can even scale the video into the area you specify using scaleModes like `"stretch", "proportionalInside", "proportionalOutside",` and more. A VideoLoader will dispatch useful events like `VIDEO_COMPLETE, VIDEO_PAUSE, VIDEO_PLAY, VIDEO_BUFFER_FULL, VIDEO_BUFFER_EMPTY, NET_STATUS, VIDEO_CUE_POINT`, and `PLAY_PROGRESS` in addition to the typical loader events, making it easy to hook up your own control interface. It packs a surprising amount of functionality into a very small amount of kb.
OPTIONAL VARS PROPERTIES
The following special properties can be passed into the VideoLoader constructor via its `vars` parameter which can be either a generic object or a `VideoLoaderVars` object:

- name : String - A name that is used to identify the VideoLoader 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".
- bufferTime : Number - 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).
- autoPlay : Boolean - 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`.
- smoothing : Boolean - When `smoothing` is `true` (the default), smoothing will be enabled for the video which typically leads to better scaling results.
- container : DisplayObjectContainer - A DisplayObjectContainer into which the `ContentDisplay` should be added immediately.
- 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).
- 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.
- scaleMode : String - When a `width` and `height` are defined, the `scaleMode` controls how the video 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 video will fill the width/height exactly.
  - `"proportionalInside"` - The video will be scaled proportionally to fit inside the area defined by the width/height
  - `"proportionalOutside"` - The video 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 video will be adjusted to fit.
  - `"heightOnly"` - Only the height of the video will be adjusted to fit.
  - `"none"` - No scaling of the video will occur.
- hAlign : String - When a `width` and `height` are defined, the `hAlign` determines how the video 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 video will be centered horizontally in the area
  - `"left"` - The video will be aligned with the left side of the area
  - `"right"` - The video will be aligned with the right side of the area
- vAlign : String - When a `width` and `height` are defined, the `vAlign` determines how the video 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 video will be centered vertically in the area
  - `"top"` - The video will be aligned with the top of the area
  - `"bottom"` - The video will be aligned with the bottom of the area
- crop : Boolean - When a `width` and `height` are defined, setting `crop` to `true` will cause the video 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 video 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.
- x : Number - Sets the `ContentDisplay`'s `x` property (for positioning on the stage).
- y : Number - Sets the `ContentDisplay`'s `y` property (for positioning on the stage).
- scaleX : Number - Sets the `ContentDisplay`'s `scaleX` property.
- scaleY : Number - Sets the `ContentDisplay`'s `scaleY` property.
- rotation : Number - Sets the `ContentDisplay`'s `rotation` property.
- alpha : Number - Sets the `ContentDisplay`'s `alpha` property.
- visible : Boolean - Sets the `ContentDisplay`'s `visible` property.
- blendMode : String - Sets the `ContentDisplay`'s `blendMode` property.
- bgColor : uint - When a `width` and `height` are defined, a rectangle will be drawn inside the `ContentDisplay` immediately in order to ease the development process. It is transparent by default, but you may define a `bgAlpha` if you prefer.
- bgAlpha : Number - Controls the alpha of the rectangle that is drawn when a `width` and `height` are defined.
- volume : Number - A value between 0 and 1 indicating the volume at which the video should play (default is 1).
- repeat : int - Number of times that the video should repeat. To repeat indefinitely, use -1. Default is 0.
- 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).
- 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`.
- deblocking : int - 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.
- 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`.
- autoAdjustBuffer : Boolean 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.
- 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. 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).
- noCache : Boolean - If `noCache` is `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 `getLoader()` or `getContent()` by url and when you're running locally)
- estimatedBytes : uint - 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 will be 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).
- requireWithRoot : DisplayObject - LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this VideoLoader as part of its parent SWFLoader's progress, you must set the `requireWithRoot` property to your swf's `root`. For example, `var loader:VideoLoader = new VideoLoader("myScript.php", {name:"textData", requireWithRoot:this.root});`
- allowMalformedURL : Boolean - 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`.
- 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). 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`.
  ----EVENT HANDLER SHORTCUTS----
- onOpen : Function - 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`).
- onInit : Function - A handler function for `Event.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 `Event` (flash.events.Event).
- onProgress : Function - 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`.
- onComplete : Function - 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`).
- 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. Make sure your onCancel function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).
- onError : Function - A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_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`).
- onFail : Function - 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`).
- 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. Make sure your onIOError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Note: Using a `VideoLoaderVars` instance instead of a generic object to define your `vars` is a bit more verbose but provides code hinting and improved debugging because it enforces strict data typing. Use whichever one you prefer.
Note: To avoid garbage collection issues in the Flash player, the `netStream` object that VideoLoader employs must get recreated internally anytime the VideoLoader is unloaded or its loading is cancelled, so if you need to directly access the `netStream`, it is best to do so after the `COMPLETE` event has been dispatched. Otherwise, if you store a reference to the VideoLoader's `netStream` before or during a load and it gets cancelled or unloaded for some reason, it won't reference the one that was used to load the video.
Note: There is a bug/inconsistency in Adobe's NetStream class that causes relative URLs to use the swf's location as the base path instead of the HTML page's location like all other loaders. Therefore, it would be wise to use the "base" attribute of the <OBJECT> and <EMBED> tags in the HTML to make sure all relative paths are consistent. See http://kb2.adobe.com/cps/041/tn_04157.html for details.

Example
Example AS3 code:

     import com.greensock.loading.*;
     import com.greensock.loading.display.*;
     import com.greensock.*;
     import com.greensock.events.LoaderEvent;

    //create a VideoLoader
    var video:VideoLoader = new VideoLoader("assets/video.flv", {name:"myVideo", container:this, width:400, height:300, scaleMode:"proportionalInside", bgColor:0x000000, autoPlay:false, volume:0, requireWithRoot:this.root, estimatedBytes:75000});

    //start loading
    video.load();

    //add a CLICK listener to a button that causes the video to toggle its paused state.
    button.addEventListener(MouseEvent.CLICK, togglePause);
    function togglePause(event:MouseEvent):void {
        video.videoPaused = !video.videoPaused;
    }

    //or you could put the VideoLoader into a LoaderMax queue. Create one first...
    var queue:LoaderMax = new LoaderMax({name:"mainQueue", onProgress:progressHandler, onComplete:completeHandler, onError:errorHandler});

    //append the VideoLoader and several other loaders
    queue.append( video );
    queue.append( new DataLoader("assets/data.txt", {name:"myText"}) );
    queue.append( new ImageLoader("assets/image1.png", {name:"myImage", estimatedBytes:3500}) );

    //start loading the LoaderMax queue
    queue.load();

    function progressHandler(event:LoaderEvent):void {
     trace("progress: " + event.target.progress);
    }

    function completeHandler(event:LoaderEvent):void {
     //play the video
     loader.playVideo();

     //tween the volume up to 1 over the course of 2 seconds.
     TweenLite.to(loader, 2, {volume:1});
    }

    function errorHandler(event:LoaderEvent):void {
     trace("error occured with " + event.target + ": " + event.text);
    }

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.

See also

com.greensock.loading.data.VideoLoaderVars

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | auditedSize : Boolean Indicates whether or not the loader's `bytesTotal` value has been set by any of the following: Defining an `estimatedBytes` in the `vars` object passed to the constructor Calling `auditSize()` and getting a response (an error is also considered a response) When a LoaderMax instance begins loading, it will automatically force a call to `auditSize()` for any of its children that don't have an `estimatedBytes` defined. | LoaderCore
|  | autoAdjustBuffer : Boolean 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. | VideoLoader
|  | 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). | LoaderCore
|  | bufferMode : Boolean When `bufferMode` is `true`, the loader will report its progress only in terms of the video's buffer instead of its overall file loading progress which has the following effects: The `bytesTotal` will be calculated based on the NetStream's `duration`, `bufferLength`, and `bufferTime` meaning it may fluctuate in order to accurately reflect the overall `progress` ratio. Its `COMPLETE` event will be dispatched as soon as the buffer is full, so if the VideoLoader is nested in a LoaderMax, the LoaderMax will move on to the next loader in its queue at that point. | VideoLoader
|  | bufferProgress : Number [read-only] A value between 0 and 1 describing the progress of the buffer (0 = not buffered at all, 0.5 = halfway buffered, and 1 = fully buffered). | VideoLoader
|  | bytesLoaded : uint Bytes loaded | LoaderCore
|  | bytesTotal : uint Total bytes that are to be loaded by the loader. | LoaderCore
|  | content : * [read-only] A ContentDisplay (a Sprite) that contains a Video object to which the NetStream is attached. | VideoLoader
|  | duration : Number [read-only] The duration (in seconds) of the video. | VideoLoader
|  | httpStatus : int The httpStatus code of the loader. | LoaderItem
|  | loadTime : Number The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled. | LoaderCore
|  | metaData : Object The metaData that was received from the video (contains information about its width, height, frame rate, etc.). | VideoLoader
|  | name : String A name that you use to identify the loader instance. | LoaderCore
|  | netStream : NetStream [read-only] The `NetStream` object used to load the video | VideoLoader
|  | paused : Boolean If a loader is paused, its progress will halt and any LoaderMax instances to which it belongs will either skip over it or stop when its position is reached in the queue (depending on whether or not the LoaderMax's `skipPaused` property is `true`). | LoaderCore
|  | playProgress : Number A value between 0 and 1 describing the playback progress where 0 means the virtual playhead is at the very beginning of the video, 0.5 means it is at the halfway point and 1 means it is at the end of the video. | VideoLoader
|  | progress : Number A value between 0 and 1 indicating the overall progress of the loader. | LoaderCore
|  | rawContent : Video [read-only] The `Video` object to which the NetStream was attached (automatically created by VideoLoader internally) | VideoLoader
|  | request : URLRequest The `URLRequest` associated with the loader. | LoaderItem
|  | scriptAccessDenied : Boolean If the loaded content is denied script access (because of security sandbox restrictions, a missing crossdomain.xml file, etc.), `scriptAccessDenied` will be set to `true`. | LoaderItem
|  | status : int Integer code indicating the loader's status; options are `LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETED, LoaderStatus.PAUSED,` and `LoaderStatus.DISPOSED`. | LoaderCore
|  | url : String The url from which the loader should get its content. | LoaderItem
|  | vars : Object An object containing optional configuration details, typically passed through a constructor parameter. | LoaderCore
|  | videoPaused : Boolean The playback status of the video: `true` if the video's playback is paused, `false` if it isn't. | VideoLoader
|  | videoTime : Number The time (in seconds) at which the virtual playhead is positioned on the video. | VideoLoader
|  | volume : Number The volume of the video (a value between 0 and 1). | VideoLoader

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | VideoLoader(urlOrRequest:*, vars:Object = null) Constructor | VideoLoader
|  | addASCuePoint(time:Number, name:String = "", parameters:Object = null):Object Adds an ActionScript cue point. | VideoLoader
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void | VideoLoader
|  | auditSize():void Attempts loading just enough of the content to accurately determine the `bytesTotal` in order to improve the accuracy of the `progress` property. | LoaderItem
|  | cancel():void If the loader is currently loading (`status` is `LoaderStatus.LOADING`), it will be canceled immediately and its status will change to `LoaderStatus.READY`. | LoaderCore
|  | dispose(flushContent:Boolean = false):void Disposes of the loader and releases it internally for garbage collection. | LoaderCore
|  | getCuePointTime(name:String):Number Finds a cue point by name and returns its corresponding time (where it is positioned in the video). | VideoLoader
|  | gotoVideoCuePoint(name:String, forcePlay:Boolean = false, skipCuePoints:Boolean = true):Number Attempts to jump to a certain cue point (either a cue point that was embedded in the video itself when it was encoded or a cue point that was added via `addASCuePoint()`). | VideoLoader
|  | gotoVideoTime(time:Number, forcePlay:Boolean = false, skipCuePoints:Boolean = true):Number Attempts to jump to a certain time in the video. | VideoLoader
|  | load(flushContent:Boolean = false):void Loads the loader's content, optionally flushing any previously loaded content first. | LoaderCore
|  | pause():void Pauses the loader immediately. | LoaderCore
|  | pauseVideo(event:Event = null):void Pauses playback of the video. | VideoLoader
|  | playVideo(event:Event = null):void Plays the video (if the buffer isn't full yet, playback will wait until the buffer is full). | VideoLoader
|  | prioritize(loadNow:Boolean = true):void Immediately prioritizes the loader inside any LoaderMax instances that contain it, forcing it to the top position in their queue and optionally calls `load()` immediately as well. | LoaderCore
|  | removeASCuePoint(timeNameOrCuePoint:*):Object Removes an ActionScript cue point that was added with `addASCuePoint()`. | VideoLoader
|  | resume():void Unpauses the loader and resumes loading immediately. | LoaderCore
|  | toString():String Returns information about the loader, like its type, its `name`, and its `url` (if it has one). | LoaderCore
|  | unload():void Removes any content that was loaded and sets `bytesLoaded` back to zero. | LoaderCore

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined by
--- | --- | --- | ---
|  | cancel | Dispatched when the loader is canceled while loading which can occur either because of a failure or when a sibling loader is prioritized in a LoaderMax queue. | LoaderCore
|  | complete | Dispatched when the loader completes. | LoaderCore
|  | error | Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR. | LoaderCore
|  | fail | Dispatched when the loader fails. | LoaderCore
|  | httpStatus | Dispatched when the loader's `httpStatus` value changes. | VideoLoader
|  | ioError | Dispatched when the loader experiences an IO_ERROR while loading or auditing its size. | LoaderItem
|  | netStatus | Dispatched when the `netStream` dispatches a NET_STATUS event. | VideoLoader
|  | open | Dispatched when the loader starts loading. | LoaderCore
|  | progress | Dispatched each time the `bytesLoaded` value changes while loading (indicating progress). | LoaderCore
|  | unload | Dispatched when the loader unloads (which happens when either `unload()` or `dispose(true)` is called or if a loader is canceled while in the process of loading). | LoaderCore

Public Constants

| Constant | Defined by
--- | --- | ---
|  | PLAY_PROGRESS : String = "playProgress" [static] Event type constant for when the playback progresses (only dispatched when the video is playing). | VideoLoader
|  | VIDEO_BUFFER_EMPTY : String = "videoBufferEmpty" [static] Event type constant for when the video's buffer is empty. | VideoLoader
|  | VIDEO_BUFFER_FULL : String = "videoBufferFull" [static] Event type constant for when the video's buffer is full. | VideoLoader
|  | VIDEO_COMPLETE : String = "videoComplete" [static] Event type constant for when the video completes. | VideoLoader
|  | VIDEO_CUE_POINT : String = "videoCuePoint" [static] Event type constant for when the video reaches a cue point in the playback of the NetStream. | VideoLoader
|  | VIDEO_PAUSE : String = "videoPause" [static] Event type constant for when the video is paused. | VideoLoader
|  | VIDEO_PLAY : String = "videoPlay" [static] Event type constant for when the video begins or resumes playing. | VideoLoader

Property detail

autoAdjustBuffer | property

`public var autoAdjustBuffer:Boolean`

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.

bufferMode | property |

`bufferMode:Boolean` [read-write]

When `bufferMode` is `true`, the loader will report its progress only in terms of the video's buffer instead of its overall file loading progress which has the following effects:

- The `bytesTotal` will be calculated based on the NetStream's `duration`, `bufferLength`, and `bufferTime` meaning it may fluctuate in order to accurately reflect the overall `progress` ratio.
- Its `COMPLETE` event will be dispatched as soon as the buffer is full, so if the VideoLoader is nested in a LoaderMax, the LoaderMax will move on to the next loader in its queue at that point. However, the VideoLoader's NetStream will continue to load in the background, using up bandwidth.

This can be very convenient if, for example, you want to display loading progress based on the video's buffer or if you want to load a series of loaders in a LoaderMax and have it fire its `COMPLETE` event when the buffer is full (as opposed to waiting for the entire video to load). Implementation
`public function get bufferMode():Boolean`
`public function set bufferMode(value:Boolean):void`

bufferProgress | property |

`bufferProgress:Number` [read-only]

A value between 0 and 1 describing the progress of the buffer (0 = not buffered at all, 0.5 = halfway buffered, and 1 = fully buffered). The buffer progress is in relation to the `bufferTime` which is 5 seconds by default or you can pass a custom value in through the `vars` parameter in the constructor like `{bufferTime:20}`.

Implementation
`public function get bufferProgress():Number`

content | property |

`content:*` [read-only]

A ContentDisplay (a Sprite) that contains a Video object to which the NetStream is attached. This ContentDisplay Sprite can be accessed immediately; you do not need to wait for the video to load.

Implementation
`public function get content():*`

duration | property |

`duration:Number` [read-only]

The duration (in seconds) of the video. This value is only accurate AFTER the metaData has been received and the `INIT` event has been dispatched.

Implementation
`public function get duration():Number`

metaData | property |

`public var metaData:Object`

The metaData that was received from the video (contains information about its width, height, frame rate, etc.). See Adobe's docs for information about a NetStream's onMetaData callback.

netStream | property |

`netStream:NetStream` [read-only]

The `NetStream` object used to load the video

Implementation
`public function get netStream():NetStream`

playProgress | property |

`playProgress:Number` [read-write]

A value between 0 and 1 describing the playback progress where 0 means the virtual playhead is at the very beginning of the video, 0.5 means it is at the halfway point and 1 means it is at the end of the video.

Implementation
`public function get playProgress():Number`
`public function set playProgress(value:Number):void`

rawContent | property |

`rawContent:Video` [read-only]

The `Video` object to which the NetStream was attached (automatically created by VideoLoader internally)

Implementation
`public function get rawContent():Video`

videoPaused | property |

`videoPaused:Boolean` [read-write]

The playback status of the video: `true` if the video's playback is paused, `false` if it isn't.

Implementation
`public function get videoPaused():Boolean`
`public function set videoPaused(value:Boolean):void`

videoTime | property |

`videoTime:Number` [read-write]

The time (in seconds) at which the virtual playhead is positioned on the video. For example, if the virtual playhead is currently at the 3-second position (3 seconds from the beginning), this value would be 3.

Implementation
`public function get videoTime():Number`
`public function set videoTime(value:Number):void`

volume | property |

`volume:Number` [read-write]

The volume of the video (a value between 0 and 1).

Implementation
`public function get volume():Number`
`public function set volume(value:Number):void`
Constructor detail

VideoLoader | () | constructor

`public function VideoLoader(urlOrRequest:*, vars:Object = null)`

Constructor

Parameters

| `urlOrRequest:*` — The url (`String`) or `URLRequest` from which the loader should get its content.
| `vars:Object` (default = `null`)`` — An object containing optional configuration details. For example: `new VideoLoader("video/video.flv", {name:"myVideo", onComplete:completeHandler, onProgress:progressHandler})`. The following special properties can be passed into the constructor via the `vars` parameter which can be either a generic object or a `VideoLoaderVars` object: name : String - A name that is used to identify the VideoLoader 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". bufferTime : Number - 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). autoPlay : Boolean - 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`. smoothing : Boolean - When `smoothing` is `true` (the default), smoothing will be enabled for the video which typically leads to better scaling results. container : DisplayObjectContainer - A DisplayObjectContainer into which the `ContentDisplay` should be added immediately. 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). 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. scaleMode : String - When a `width` and `height` are defined, the `scaleMode` controls how the video 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 video will fill the width/height exactly. `"proportionalInside"` - The video will be scaled proportionally to fit inside the area defined by the width/height `"proportionalOutside"` - The video 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 video will be adjusted to fit. `"heightOnly"` - Only the height of the video will be adjusted to fit. `"none"` - No scaling of the video will occur. hAlign : String - When a `width` and `height` are defined, the `hAlign` determines how the video 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 video will be centered horizontally in the area `"left"` - The video will be aligned with the left side of the area `"right"` - The video will be aligned with the right side of the area vAlign : String - When a `width` and `height` are defined, the `vAlign` determines how the video 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 video will be centered vertically in the area `"top"` - The video will be aligned with the top of the area `"bottom"` - The video will be aligned with the bottom of the area crop : Boolean - When a `width` and `height` are defined, setting `crop` to `true` will cause the video 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 video 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. x : Number - Sets the `ContentDisplay`'s `x` property (for positioning on the stage). y : Number - Sets the `ContentDisplay`'s `y` property (for positioning on the stage). scaleX : Number - Sets the `ContentDisplay`'s `scaleX` property. scaleY : Number - Sets the `ContentDisplay`'s `scaleY` property. rotation : Number - Sets the `ContentDisplay`'s `rotation` property. alpha : Number - Sets the `ContentDisplay`'s `alpha` property. visible : Boolean - Sets the `ContentDisplay`'s `visible` property. blendMode : String - Sets the `ContentDisplay`'s `blendMode` property. bgColor : uint - When a `width` and `height` are defined, a rectangle will be drawn inside the `ContentDisplay` immediately in order to ease the development process. It is transparent by default, but you may define a `bgAlpha` if you prefer. bgAlpha : Number - Controls the alpha of the rectangle that is drawn when a `width` and `height` are defined. volume : Number - A value between 0 and 1 indicating the volume at which the video should play (default is 1). repeat : int - Number of times that the video should repeat. To repeat indefinitely, use -1. Default is 0. 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). 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`. deblocking : int - 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. 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`. autoAdjustBuffer : Boolean 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. 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. 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). noCache : Boolean - If `noCache` is `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 `getLoader()` or `getContent()` by url and when you're running locally) estimatedBytes : uint - 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 will be 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). requireWithRoot : DisplayObject - LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this VideoLoader as part of its parent SWFLoader's progress, you must set the `requireWithRoot` property to your swf's `root`. For example, `var loader:VideoLoader = new VideoLoader("myScript.php", {name:"textData", requireWithRoot:this.root});` allowMalformedURL : Boolean - 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`. 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). 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`. ----EVENT HANDLER SHORTCUTS---- onOpen : Function - 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`). onInit : Function - A handler function for `Event.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 `Event` (flash.events.Event). onProgress : Function - 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`. onComplete : Function - 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`). 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. Make sure your onCancel function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`). onError : Function - A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_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`). onFail : Function - 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`). 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. Make sure your onIOError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

See also

com.greensock.loading.data.VideoLoaderVars
Method detail

addASCuePoint | () | method

`public function addASCuePoint(time:Number, name:String = "", parameters:Object = null):Object`

Adds an ActionScript cue point. Cue points are only triggered when the video is playing and passes the cue point's position in the video (in the forwards direction - they are not triggered when you skip to a previous time in the video with `gotoVideoTime()`).
For example, to add a cue point named "coolPart" at the 5-second point of the video, do:
`myVideoLoader.addASCuePoint(5, "coolPart", {message:"This is a cool part.", id:5});
myVideoLoader.addEventListener(VideoLoader.VIDEO_CUE_POINT, cuePointHandler);
function cuePointHandler(event:LoaderEvent):void {
trace("hit cue point " + event.data.name + ", message: " + event.data.parameters.message);
}`

Parameters

| `time:Number` — The time (in seconds) at which the cue point should be placed in the video.
| `name:String` (default = "``")`` — The name of the cue point. It is acceptable to have multiple cue points with the same name.
| `parameters:Object` (default = `null`)`` — An object containing any data that you want associated with the cue point. For example, `{message:"descriptive text", id:5}`. This data can be retrieved in the VIDEO_CUE_POINT handler via the LoaderEvent's `data` property like `event.data.parameters`

Returns

| `Object` — The cue point that was added

See also

removeASCuePoint()
gotoVideoCuePoint()
getCuePointTime()

addEventListener | () | method |

`public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void`

Parameters

| `type:String`
| `listener:Function`
| `useCapture:Boolean` (default = `false`)``
| `priority:int` (default = `0`)``
| `useWeakReference:Boolean` (default = `false`)``

getCuePointTime | () | method |

`public function getCuePointTime(name:String):Number`

Finds a cue point by name and returns its corresponding time (where it is positioned in the video). All cue points will be included in the search (cue points embedded into the video when it was encoded as well as cue points that were added with `addASCuePoint()`).

Parameters

| `name:String` — The name of the cue point

Returns

| `Number` — The cue point's time (NaN if no cue point was found with the specified name)

See also

addASCuePoint()
gotoVideoCuePoint()
gotoVideoTime()

gotoVideoCuePoint | () | method |

`public function gotoVideoCuePoint(name:String, forcePlay:Boolean = false, skipCuePoints:Boolean = true):Number`

Attempts to jump to a certain cue point (either a cue point that was embedded in the video itself when it was encoded or a cue point that was added via `addASCuePoint()`). If the video hasn't downloaded enough to get to the cue point or if there is no keyframe at that point in the video, it will get as close as possible. For example, to jump to a cue point named "highlight1" and play from there:
`loader.gotoVideoCuePoint("highlight1", true);
`

Parameters

| `name:String` — The name of the cue point
| `forcePlay:Boolean` (default = `false`)`` — If `true`, the video will resume playback immediately after seeking to the new position.
| `skipCuePoints:Boolean` (default = `true`)`` — If `true` (the default), any cue points that are positioned between the current videoTime and the destination cue point will be ignored when moving to the new videoTime. In other words, it is like a record player that has its needle picked up, moved, and dropped into a new position rather than dragging it across the record, triggering the various cue points (if any exist there). IMPORTANT: cue points are only triggered when the time advances in the forward direction; they are never triggered when rewinding or restarting.

Returns

| `Number` — The cue point's time (NaN if the cue point wasn't found)

See also

gotoVideoTime()
addASCuePoint()
removeASCuePoint()

gotoVideoTime | () | method |

`public function gotoVideoTime(time:Number, forcePlay:Boolean = false, skipCuePoints:Boolean = true):Number`

Attempts to jump to a certain time in the video. If the video hasn't downloaded enough to get to the new time or if there is no keyframe at that time value, it will get as close as possible. For example, to jump to exactly 3-seconds into the video and play from there:
`loader.gotoVideoTime(3, true);
`

Parameters

| `time:Number` — The time (in seconds, offset from the very beginning) at which to place the virtual playhead on the video.
| `forcePlay:Boolean` (default = `false`)`` — If `true`, the video will resume playback immediately after seeking to the new position.
| `skipCuePoints:Boolean` (default = `true`)`` — If `true` (the default), any cue points that are positioned between the current videoTime and the destination time (defined by the `time` parameter) will be ignored when moving to the new videoTime. In other words, it is like a record player that has its needle picked up, moved, and dropped into a new position rather than dragging it across the record, triggering the various cue points (if any exist there). IMPORTANT: cue points are only triggered when the time advances in the forward direction; they are never triggered when rewinding or restarting.

Returns

| `Number`

See also

pauseVideo()
playVideo()
videoTime
playProgress

pauseVideo | () | method |

`public function pauseVideo(event:Event = null):void`

Pauses playback of the video.

Parameters

| `event:Event` (default = `null`)`` — An optional Event which simply makes it easier to use the method as a handler for mouse clicks or other events.

See also

videoPaused
gotoVideoTime()
playVideo()
videoTime
playProgress

playVideo | () | method |

`public function playVideo(event:Event = null):void`

Plays the video (if the buffer isn't full yet, playback will wait until the buffer is full).

Parameters

| `event:Event` (default = `null`)`` — An optional Event which simply makes it easier to use the method as a handler for mouse clicks or other events.

See also

videoPaused
pauseVideo()
gotoVideoTime()
videoTime
playProgress

removeASCuePoint | () | method |

`public function removeASCuePoint(timeNameOrCuePoint:*):Object`

Removes an ActionScript cue point that was added with `addASCuePoint()`. If multiple ActionScript cue points match the search criteria, only one is removed. To remove all, call this function repeatedly in a loop with the same parameters until it returns null.

Parameters

| `timeNameOrCuePoint:*` — The time, name or cue point object that should be removed. The method removes the first cue point that matches the criteria.

Returns

| `Object` — The cue point that was removed (or `null` if none were found that match the criteria)

See also

addASCuePoint()
Event detail

httpStatus | event

Event object type: `com.greensock.events.LoaderEvent`

Dispatched when the loader's `httpStatus` value changes.

netStatus | event |

Event object type: `flash.events.NetStatusEvent`

Dispatched when the `netStream` dispatches a NET_STATUS event.

Constant detail

PLAY_PROGRESS | constant

`public static const PLAY_PROGRESS:String = "playProgress"`

Event type constant for when the playback progresses (only dispatched when the video is playing).

VIDEO_BUFFER_EMPTY | constant |

`public static const VIDEO_BUFFER_EMPTY:String = "videoBufferEmpty"`

Event type constant for when the video's buffer is empty.

VIDEO_BUFFER_FULL | constant |

`public static const VIDEO_BUFFER_FULL:String = "videoBufferFull"`

Event type constant for when the video's buffer is full.

VIDEO_COMPLETE | constant |

`public static const VIDEO_COMPLETE:String = "videoComplete"`

Event type constant for when the video completes.

VIDEO_CUE_POINT | constant |

`public static const VIDEO_CUE_POINT:String = "videoCuePoint"`

Event type constant for when the video reaches a cue point in the playback of the NetStream.

VIDEO_PAUSE | constant |

`public static const VIDEO_PAUSE:String = "videoPause"`

Event type constant for when the video is paused.

VIDEO_PLAY | constant |

`public static const VIDEO_PLAY:String = "videoPlay"`

Event type constant for when the video begins or resumes playing. If the buffer isn't full yet when VIDEO_PLAY is dispatched, the video will wait to visually begin playing until the buffer is full. So VIDEO_PLAY indicates when the NetStream received an instruction to play, not necessarily when it visually begins playing.