ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.video 

VideoProgressEvent  - AS3 Flash

Packagefl.video
Classpublic class VideoProgressEvent
InheritanceVideoProgressEvent Inheritance ProgressEvent Inheritance Event Inheritance Object
Implements IVPEvent

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Flash® Player dispatches a VideoProgressEvent object when the user makes a request for the number of bytes loaded during a progressive HTTP download of their video.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 InheritedbytesLoaded : Number
The number of items or bytes loaded when the listener processes the event.
ProgressEvent
 InheritedbytesTotal : Number
The total number of items or bytes that will be loaded if the loading process succeeds.
ProgressEvent
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  vp : uint
The index of the VideoPlayer object involved in this event.
VideoProgressEvent
Public Methods
 MethodDefined By
  
VideoProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, vp:uint = 0)
Creates an Event object that contains information about progress events.
VideoProgressEvent
 Inherited
[override] Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string that contains all the properties of the ProgressEvent object.
ProgressEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  PROGRESS : String = "progress"
[static] Defines the value of the type property of a progress event object.
VideoProgressEvent
Property Detail

vp

property
vp:uint

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The index of the VideoPlayer object involved in this event.



Implementation
    public function get vp():uint
    public function set vp(value:uint):void
Constructor Detail

VideoProgressEvent

()Constructor
public function VideoProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, vp:uint = 0)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of progress event: VideoProgressEvent.PROGRESS.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
bytesLoaded:uint (default = 0) — The number of items or bytes loaded at the time the listener processes the event.
 
bytesTotal:uint (default = 0) — The total number of items or bytes that will be loaded if the loading process succeeds.
 
vp:uint (default = 0) — Determines the index of the VideoPlayer object.
Constant Detail

PROGRESS

Constant
public static const PROGRESS:String = "progress"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of a progress event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that will be loaded if the loading process succeeds.
vpThe index of the VideoPlayer object.