Package | com.greensock.loading |
Class | public class VideoLoader |
Inheritance | VideoLoader ![]() ![]() ![]() |
pauseVideo(), playVideo(), gotoVideoTime(), bufferProgress, playProgress, volume,
duration, metaData,
and videoTime
. Just like ImageLoader and SWFLoader, VideoLoader's content
property refers to a ContentDisplay
object (a Sprite) that gets created immediately so that you can
add it to the display list before the video has finished loading. 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. It packs a surprising amount of functionality
into a very small amount of kb.vars
parameter: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".autoPlay
to false
to pause the video initially).autoPlay
to false
.smoothing
is true
(the default), smoothing will be enabled for the video which typically leads to better scaling results.ContentDisplay
should be added immediately.ContentDisplay
's width
property (applied before rotation, scaleX, and scaleY).ContentDisplay
's height
property (applied before rotation, scaleX, and scaleY).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.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.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 areawidth
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 areawidth
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.ContentDisplay
's x
property (for positioning on the stage).ContentDisplay
's y
property (for positioning on the stage).ContentDisplay
's scaleX
property.ContentDisplay
's scaleY
property.ContentDisplay
's rotation
property.ContentDisplay
's alpha
property.ContentDisplay
's visible
property.ContentDisplay
's blendMode
property.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 bgColor
if you prefer.width
and height
are defined.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
, 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
.flash.media.Video
class docs for details.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
.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
is 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 getLoader()
or getContent()
by url and when you're running locally)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
property to your swf's root
. For example, var loader:VideoLoader = new VideoLoader("myScript.php", {name:"textData", requireWithRoot:this.root});
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
.
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
).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).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
.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
).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
).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
).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
).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
).import com.greensock.loading.*; import com.greensock.loading.display.*; import com.greensock.*; import com.greensock.events.LoaderEvent; //create a VideoLoader var loader: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 loader.load(); //Or you could put the VideoLoader into a LoaderMax. 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( loader ); 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); }
Property | Defined by | ||
---|---|---|---|
![]() | auditedSize : Boolean
Indicates whether or not the loader's
bytesTotal value has been set by any of the following:
| LoaderCore | |
![]() | 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:
| 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.COMPLETE, 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 |
Method | Defined by | ||
---|---|---|---|
VideoLoader(urlOrRequest:*, vars:Object = null)
Constructor
| VideoLoader | ||
![]() |
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
| LoaderCore | |
![]() |
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 | |
gotoVideoTime(time:Number, forcePlay:Boolean = false):void
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 | |
![]() |
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 |
Event | Summary | Defined by | ||
---|---|---|---|---|
![]() | 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 | ||
![]() | Dispatched when the loader completes. | LoaderCore | ||
![]() | Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR. | LoaderCore | ||
![]() | Dispatched when the loader fails. | LoaderCore | ||
Dispatched when the loader's httpStatus value changes. | VideoLoader | |||
![]() | Dispatched when the loader experiences an IO_ERROR while loading or auditing its size. | LoaderItem | ||
Dispatched when the netStream dispatches a NET_STATUS event. | VideoLoader | |||
![]() | Dispatched when the loader starts loading. | LoaderCore | ||
![]() | Dispatched each time the bytesLoaded value changes while loading (indicating progress). | LoaderCore | ||
Dispatched when the video's buffer is empty. | VideoLoader | |||
Dispatched when the video's buffer is full. | VideoLoader | |||
Dispatched when the video finishes playing all the way to the end. | VideoLoader | |||
Dispatched when a cue point is reached while playing the video. | VideoLoader | |||
Dispatched when the video pauses due to a pauseVideo() call or changing the videoPaused property to true . | VideoLoader | |||
Dispatched when the video plays due to a playVideo() call or changing the videoPaused property to false or when autoPlay is true and the video beings playing after enough has been loaded into the buffer. | VideoLoader |
Constant | Defined by | ||
---|---|---|---|
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 |
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:
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.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.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}
.
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.
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
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)
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.
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
VideoLoader | () | constructor |
public function VideoLoader(urlOrRequest:*, vars:Object = null)
Constructor
ParametersurlOrRequest:* — 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:
|
gotoVideoTime | () | method |
public function gotoVideoTime(time:Number, forcePlay:Boolean = false):void
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);
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.
|
See also
pauseVideo | () | method |
public function pauseVideo(event:Event = null):void
Pauses playback of the video.
Parametersevent: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
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).
Parametersevent: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
httpStatus | event |
com.greensock.events.LoaderEvent
Dispatched when the loader's httpStatus
value changes.
netStatus | event |
flash.events.NetStatusEvent
Dispatched when the netStream
dispatches a NET_STATUS event.
videoBufferEmpty | event |
videoBufferFull | event |
videoComplete | event |
com.greensock.loading.VideoLoader
Dispatched when the video finishes playing all the way to the end.
videoCuePoint | event |
com.greensock.loading.VideoLoader
Dispatched when a cue point is reached while playing the video. Use the LoaderEvent's data
property to get info about the particular cue point.
videoPause | event |
com.greensock.loading.VideoLoader
Dispatched when the video pauses due to a pauseVideo()
call or changing the videoPaused
property to true
.
videoPlay | event |
com.greensock.loading.VideoLoader
Dispatched when the video plays due to a playVideo()
call or changing the videoPaused
property to false
or when autoPlay
is true
and the video beings playing after enough has been loaded into the buffer.
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.