DRMTrait

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

DRMTrait defines the trait interface for media which can be protected by digital rights management (DRM) technology. It can also be used as the base class for a more specific DRMTrait subclass.

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.

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

Public Methods

	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
		authenticate(username:String = null, password:String = null):void Authenticates the media.	DRMTrait
		authenticateWithToken(token:Object):void Authenticates the media using an object which serves as a token.	DRMTrait
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		dispose():void Disposes of any resources used by this trait.	MediaTraitBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	Method		Defined By
		setDrmState(value:String):void Updates the drm state.	DRMTrait
		setEndDate(value:Date):void Updates the end date.	DRMTrait
		setPeriod(value:Number):void Updates the period.	DRMTrait
		setStartDate(value:Date):void Updates the start date.	DRMTrait

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
drmStateChange	Dispatched when either anonymous or credential-based authentication is needed in order to playback the media.	DRMTrait

Property Detail

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():String

Related API Elements

DRMState

endDate

property

endDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10.1, AIR 1.5

The end date for the playback window. Returns null if authentication has not yet occurred.

Implementation
public function get endDate():Date

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():Number

startDate

property

startDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10.1, AIR 1.5

The start date for the playback window. Returns null if authentication has not yet occurred.

Implementation
public function get startDate():Date

Constructor Detail

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.

Method Detail

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`) — The username. Should be null for anonymous authentication.

	`password:String` (default = `null`) — The password. Should be null for anonymous authentication.

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

protected final function setEndDate(value:Date):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10.1, AIR 1.5

Updates the end date.

Parameters

value:Date — The new value for endDate.

setPeriod

()

method

protected final function setPeriod(value:Number):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10.1, AIR 1.5

Updates the period.

Parameters

value:Number — The new value for period.

setStartDate

()

method

protected final function setStartDate(value:Date):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10.1, AIR 1.5

Updates the start date.

Parameters

value:Date — The new value for startDate.

Event Detail

drmStateChange

Event

Event Object Type: org.osmf.events.DRMEvent
property 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.

Legal Notices | Online Privacy Policy

DRMTrait - AS3 OSMF

Classes x

drmState

endDate

period

startDate

DRMTrait

authenticate

authenticateWithToken

setDrmState

setEndDate

setPeriod

setStartDate

drmStateChange