(Beta)
| Package | fl.video |
| Class | public class CaptionChangeEvent |
| Inheritance | CaptionChangeEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
The event is also dispatched when the following conditions are true:
- the
captionTargetNameproperty is not set - the
captionTargetproperty is not set - the FLVPlaybackCaptioning instance creates a TextField object automatically for captioning.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| added : Boolean
A Boolean value that determines whether the caption was added or removed. | CaptionChangeEvent | ||
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| captionCuePointObject : Object
The cue point object for the caption that was added or removed. | CaptionChangeEvent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
CaptionChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, added:Boolean = true, captionCuePointObject:Object = null)
Creates an Event object that contains information about captionChange events. | CaptionChangeEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| CAPTION_CHANGE : String = "captionChange" [static]
Defines the value of the
type property of a captionChange event object. | CaptionChangeEvent | ||
Property Detail
added | property |
captionCuePointObject | property |
captionCuePointObject:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
The cue point object for the caption that was added or removed.
Implementation
public function get captionCuePointObject():Object public function set captionCuePointObject(value:Object):voidConstructor Detail
CaptionChangeEvent | () | Constructor |
public function CaptionChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, added:Boolean = true, captionCuePointObject:Object = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
Creates an Event object that contains information about captionChange events.
Event objects are passed as parameters to event listeners.
type:String — The type of the event. Event listeners can access this information
through the inherited type property. There is only one type of
captionChange event: CaptionChangeEvent.CAPTION_CHANGE.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
added:Boolean (default = true) | |
captionCuePointObject:Object (default = null) |
Constant Detail
CAPTION_CHANGE | Constant |
public static const CAPTION_CHANGE:String = "captionChange"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
Defines the value of the
type property of a captionChange event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
added | A Boolean that indicates whether the caption was added or removed from the display. |
captionCuePointObject | The cue point object for this caption. |
Wed Nov 21 2018, 06:34 AM -08:00