| Package | impression.events |
| Class | public class VideoFrameEvent |
| Inheritance | VideoFrameEvent  flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| currentFrame : int [read-only]
The current frame of the current step clip. | VideoFrameEvent | ||
| currentStep : int [read-only]
The current step displayed by the player. | VideoFrameEvent | ||
| currentStepClip : MovieClip [read-only]
The MovieClip currently being displayed. | VideoFrameEvent | ||
| totalFrames : int [read-only]
The total number of frames in the current step clip. | VideoFrameEvent | ||
| totalSteps : int [read-only]
The total number of steps in the video. | VideoFrameEvent | ||
| Method | Defined By | ||
|---|---|---|---|
VideoFrameEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, currentStep:int = -1, totalSteps:int = -1, currentStepClip:MovieClip = null, currentFrame:int = -1, totalFrames:int = -1)
Creates a new instance of a VideoFrameEvent object. | VideoFrameEvent | ||
clone():Event [override]
Duplicates an instance of the event object. | VideoFrameEvent | ||
toString():String [override]
Returns a string containing all the properties of the VideoFrameEvent object. | VideoFrameEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| ENTER_FRAME : String = videoEnterFrame [static]
The VideoFrameEvent.ENTER_FRAME constant defines the value of the
type property of a frame event object. | VideoFrameEvent | ||
| currentFrame | property |
currentFrame:int [read-only] The current frame of the current step clip.
public function get currentFrame():int| currentStep | property |
currentStep:int [read-only] The current step displayed by the player.
public function get currentStep():int| currentStepClip | property |
currentStepClip:MovieClip [read-only] The MovieClip currently being displayed.
public function get currentStepClip():MovieClip| totalFrames | property |
totalFrames:int [read-only] The total number of frames in the current step clip.
public function get totalFrames():int| totalSteps | property |
totalSteps:int [read-only] The total number of steps in the video.
public function get totalSteps():int| VideoFrameEvent | () | Constructor |
public function VideoFrameEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, currentStep:int = -1, totalSteps:int = -1, currentStepClip:MovieClip = null, currentFrame:int = -1, totalFrames:int = -1)Creates a new instance of a VideoFrameEvent object.
If currentStepClip is not null and the values of either the currentFrame or totalFrames parameters
are -1 (the default), this method will use the values from the currentStepClip property to populate the currentFrame
and/or totalFrames properties.
type:String — The type of the event. Event listeners can access this information through the inherited type property.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
currentStep:int (default = -1)currentStep property.
| |
totalSteps:int (default = -1)totalSteps property.
| |
currentStepClip:MovieClip (default = null)currentStepClip property.
| |
currentFrame:int (default = -1)currentFrame property.
| |
totalFrames:int (default = -1)totalFrames property.
|
| clone | () | method |
override public function clone():EventDuplicates an instance of the event object.
Returns a new VideoFrameEvent object that is a copy of the original instance of the VideoFrameEvent object.
You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch
an event--that is, when you call dispatchEvent(event) from a handler that is handling event.
Event — A new VideoStatusEvent object that is identical to the original.
|
| toString | () | method |
override public function toString():StringReturns a string containing all the properties of the VideoFrameEvent object. The string is in the following format:
[VideoFrameEvent type=value bubbles=value cancelable=value eventPhase=value currentStep=value totalSteps=value currentStepClip=value currentFrame=value totalFrames=value]
String — A string containing all the properties of the VideoFrameEvent object.
|
| ENTER_FRAME | Constant |
public static const ENTER_FRAME:String = videoEnterFrameThe VideoFrameEvent.ENTER_FRAME constant defines the value of the type property of a frame event object. This event has the following properties:
| Property | Value |
|---|---|
| bubbles | false |
| cancelable | false; there is no default behavior to cancel. |
| currentTarget | The object that is actively processing the Event object with an event listener. |
| target | The object that raised the event. |
| currentStep | The current step displayed by the player. |
| totalSteps | The total number of steps in the video. |
| currentStepClip | The MovieClip object that is the current step clip. |
| currentFrame | The value of the currentFrame property of the current step clip. |
| totalFrames | The value of the totalFrames property of the current step clip. |