| Package | org.osmf.traits |
| Class | public class DRMTrait |
| Inheritance | DRMTrait  MediaTraitBase EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Both anonymous and credential-based authentication are supported.
The workflow for media which has a DRMTrait is that the media undergoes some type of authentication, after which it is valid (i.e. able to be played) for a specific time window.
Use the MediaElement.hasTrait(MediaTraitType.DRM) method to query
whether a media element has this trait.
If hasTrait(MediaTraitType.DRM) returns true,
use the MediaElement.getTrait(MediaTraitType.DRM) method
to get an object of this type.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| drmState : String [read-only]
The current state of the DRM for this media. | DRMTrait | ||
| endDate : Date [read-only]
The end date for the playback window. | DRMTrait | ||
| period : Number [read-only]
The length of the playback window, in seconds. | DRMTrait | ||
| startDate : Date [read-only]
The start date for the playback window. | DRMTrait | ||
| traitType : String [read-only]
The MediaTraitType for this trait. | MediaTraitBase | |
| Method | Defined By | ||
|---|---|---|---|
DRMTrait()
Constructor. | DRMTrait | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Authenticates the media. | DRMTrait | ||
Authenticates the media using an object which serves as a token. | DRMTrait | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Disposes of any resources used by this trait. | MediaTraitBase | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
Updates the drm state. | DRMTrait | ||
Updates the end date. | DRMTrait | ||
Updates the period. | DRMTrait | ||
Updates the start date. | DRMTrait | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when either anonymous or credential-based authentication is needed in order to playback the media. | DRMTrait | |||
drmState | property |
drmState:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
The current state of the DRM for this media. The states are described in the DRMState enumeration.
Implementation
public function get drmState():StringRelated API Elements
endDate | property |
period | 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. Returns 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():NumberstartDate | property |
DRMTrait | () | Constructor |
public function DRMTrait()| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Constructor.
authenticate | () | method |
public function authenticate(username:String = null, password:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Authenticates the media. Can be used for both anonymous and credential-based authentication. If the media has already been authenticated, this is a no-op.
Parameters
username:String (default = null) | |
password:String (default = null) |
Throws
IllegalOperationError — If the media is not initialized yet.
|
authenticateWithToken | () | method |
public function authenticateWithToken(token:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Authenticates the media using an object which serves as a token. Can be used for both anonymous and credential-based authentication. If the media has already been authenticated, this is a no-op.
Parameters
token:Object — The token to use for authentication.
|
setDrmState | () | method |
protected final function setDrmState(value:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Updates the drm state.
Note that this method doesn't dispatch the drmStateChange event.
Parameters
value:String — The new value for drmState.
|
setEndDate | () | method |
setPeriod | () | method |
setStartDate | () | method |
drmStateChange | Event |
org.osmf.events.DRMEventproperty DRMEvent.type =
org.osmf.events.DRMEvent.DRM_STATE_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10.1, AIR 1.5 |
Dispatched when either anonymous or credential-based authentication is needed in order to playback the media.
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.Thu Dec 6 2018, 01:12 PM -08:00