(Beta)
| Package | org.osmf.events |
| Class | public class DRMEvent |
| Inheritance | DRMEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | 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 | |
| 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 | |
| drmState : String [read-only]
The current state of the DRM trait. | DRMEvent | ||
| endDate : Date [read-only]
The end date for the playback window, null if authentication
hasn't taken place. | DRMEvent | ||
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| mediaError : MediaError [read-only]
The error that describes an authentication failure. | DRMEvent | ||
| period : Number [read-only]
The length of the playback window, in seconds; NaN if
authentication hasn't taken place. | DRMEvent | ||
| serverURL : String [read-only]
The authentication prompt for the DRM content associated with this DRMEvent. | DRMEvent | ||
| startDate : Date [read-only]
The start date for the playback window, null if authentication
hasn't taken place. | DRMEvent | ||
| target : Object [read-only]
The event target. | Event | |
| token : Object [read-only]
The token returned as a result of a successful authentication. | DRMEvent | ||
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
DRMEvent(type:String, state:String, bubbles:Boolean = false, cancelable:Boolean = false, start:Date = null, end:Date = null, period:Number = 0, serverURL:String = null, token:Object = null, mediaError:MediaError = null)
Constructor. | DRMEvent | ||
|
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 | ||
|---|---|---|---|
| DRM_STATE_CHANGE : String = "drmStateChange" [static]
The DRMEvent.DRM_STATE_CHANGE constant defines the value
of the type property of the event object for a change to the drmState
of a DRMTrait. | DRMEvent | ||
Property Detail
drmState | property |
endDate | property |
mediaError | property |
mediaError:MediaError [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
The error that describes an authentication failure.
Implementation
public function get mediaError():MediaErrorperiod | property |
period:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
The length of the playback window, in seconds; NaN if authentication hasn't taken place.
Note that this property will generally be the difference between startDate and endDate, but is included as a property because there may be times where the duration is known up front, but the start or end dates are not (e.g. a one week rental).
Implementation
public function get period():NumberserverURL | property |
startDate | property |
token | property |
Constructor Detail
DRMEvent | () | Constructor |
public function DRMEvent(type:String, state:String, bubbles:Boolean = false, cancelable:Boolean = false, start:Date = null, end:Date = null, period:Number = 0, serverURL:String = null, token:Object = null, mediaError:MediaError = null)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Constructor.
Parameterstype:String — The type of the event.
| |
state:String — Specifies whether the event can bubble up the display list hierarchy.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
start:Date (default = null) | |
end:Date (default = null) | |
period:Number (default = 0) | |
serverURL:String (default = null) | |
token:Object (default = null) | |
mediaError:MediaError (default = null) |
Constant Detail
DRM_STATE_CHANGE | Constant |
public static const DRM_STATE_CHANGE:String = "drmStateChange"| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
The DRMEvent.DRM_STATE_CHANGE constant defines the value of the type property of the event object for a change to the drmState of a DRMTrait.
Wed Nov 21 2018, 06:34 AM -08:00