Packageflash.events
Classpublic class DRMErrorEvent
InheritanceDRMErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object

Language version: ActionScript 3.0
Runtime version: AIR 1.0

The DRMErrorEvent class provides information about errors that occur when playing digital rights management (DRM) encrypted files.

The runtime dispatches a DRMErrorEvent object when a NetStream object, trying to play a digital rights management (DRM) encrypted file, encounters a DRM-related error. For example, a DRMErrorEvent object is dispatched when the content provider does not support the viewing application, or when the user authorization fails, possibly because the user has not purchased the content.

In the case of invalid user credentials, the DRMAuthenticateEvent object handles the error by repeatedly dispatching until the user enters valid credentials, or the application denies further attempts. The application should listen to any other DRM error events in order to detect, identify, and handle the DRM-related errors.

This class provides properties containing the object throwing the exception, the error code, and, where applicable, a suberror code and text message containing information related to the error. For a description of DRM-related error codes, see the Runtime error codes. The DRM-related error codes start at error 3300.

View the examples.

See also

flash.net.NetStream
DRMErrorEvent.DRM_ERROR
Runtime error codes


Public Properties
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  contentData : DRMContentData
The DRMContentData for the media file.
DRMErrorEvent
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
  drmUpdateNeeded : Boolean
[read-only] Indicates whether a DRM update is needed to play the DRM-protected content.
DRMErrorEvent
 InheritederrorID : int
Contains the reference number associated with the specific error.
ErrorEvent
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  subErrorID : int
[read-only] An error ID that indicates more detailed information about the underlying problem.
DRMErrorEvent
  systemUpdateNeeded : Boolean
[read-only] Indicates whether a system update is needed to play the DRM-protected content.
DRMErrorEvent
 Inheritedtarget : Object
The event target.
Event
 Inheritedtext : String
For a textInput event, the character or sequence of characters entered by the user.
TextEvent
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
DRMErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inErrorDetail:String = "", inErrorCode:int = 0, insubErrorID:int = 0, inMetadata:DRMContentData = null, inSystemUpdateNeeded:Boolean = false, inDrmUpdateNeeded:Boolean = false)
Creates an Event object that contains specific information about DRM error events.
DRMErrorEvent
  
Creates a copy of the DRMErrorEvent object and sets the value of each property to match that of the original.
DRMErrorEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
Returns a string that contains all the properties of the DRMErrorEvent object.
DRMErrorEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type property of an browserZoomChange event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant defines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedCLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedDISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
  DRM_ERROR : String = "drmError"
[static] The DRMErrorEvent.DRM_ERROR constant defines the value of the type property of a drmError event object.
DRMErrorEvent
  DRM_LOAD_DEVICEID_ERROR : String = "drmLoadDeviceIdError"
[static]
DRMErrorEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedERROR : String = "error"
[static] Defines the value of the type property of an error event object.
ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedEXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
 InheritedLINK : String = "link"
[static] Defines the value of the type property of a link event object.
TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedPREPARING : String = "preparing"
[static] The Event.PREPARING constant defines the value of the type property of a preparing event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
Event
 InheritedSUSPEND : String = "suspend"
[static] The Event.SUSPEND constant defines the value of the type property of an suspend event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedTEXT_INPUT : String = "textInput"
[static] Defines the value of the type property of a textInput event object.
TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedUSER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] The Event.VIDEO_FRAME constant defines the value of the type property of a videoFrame event object.
Event
 InheritedWORKER_STATE : String = "workerState"
[static] The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
Event
Property detail
contentDataproperty
contentData:DRMContentData  [read-write]

Language version: ActionScript 3.0
Runtime version: AIR 1.5

The DRMContentData for the media file.

You can use the object referenced by the contentData property to retrieve the related DRM voucher from the DRMManager voucher cache. The voucher properties describe the license available to the user and may explain why the DRM-protected content cannot be viewed.

Implementation
    public function get contentData():DRMContentData
    public function set contentData(value:DRMContentData):void
drmUpdateNeededproperty 
drmUpdateNeeded:Boolean  [read-only]

Language version: ActionScript 3.0
Runtime version: AIR 2

Indicates whether a DRM update is needed to play the DRM-protected content.

Implementation
    public function get drmUpdateNeeded():Boolean
subErrorIDproperty 
subErrorID:int  [read-only]

Language version: ActionScript 3.0
Runtime version: AIR 1.0

An error ID that indicates more detailed information about the underlying problem.

Implementation
    public function get subErrorID():int
systemUpdateNeededproperty 
systemUpdateNeeded:Boolean  [read-only]

Language version: ActionScript 3.0
Runtime version: AIR 2

Indicates whether a system update is needed to play the DRM-protected content.

Implementation
    public function get systemUpdateNeeded():Boolean
Constructor detail
DRMErrorEvent()constructor
public function DRMErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inErrorDetail:String = "", inErrorCode:int = 0, insubErrorID:int = 0, inMetadata:DRMContentData = null, inSystemUpdateNeeded:Boolean = false, inDrmUpdateNeeded:Boolean = false)

Language version: ActionScript 3.0
Runtime version: AIR 1.0

Creates an Event object that contains specific information about DRM error events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
inErrorDetail:String (default = "") — Where applicable, the specific syntactical details of the error.
 
inErrorCode:int (default = 0) — The major error code.
 
insubErrorID:int (default = 0) — The minor error ID.
 
inMetadata:DRMContentData (default = null)
 
inSystemUpdateNeeded:Boolean (default = false)
 
inDrmUpdateNeeded:Boolean (default = false)
Method detail
clone()method
public override function clone():Event

Language version: ActionScript 3.0
Runtime version: AIR 1.0

Creates a copy of the DRMErrorEvent object and sets the value of each property to match that of the original.

Returns
Event — A new DRMErrorEvent object with property values that match those of the original.
toString()method 
public override function toString():String

Language version: ActionScript 3.0
Runtime version: AIR 1.0

Returns a string that contains all the properties of the DRMErrorEvent object. The string is in the following format:

[DRMErrorEvent type=value bubbles=value cancelable=value eventPhase=value errroID=value subErrorID=value text=value

Returns
String — A string that contains all the properties of the DRMErrorEvent object.
Constant detail
DRM_ERRORconstant
public static const DRM_ERROR:String = "drmError"

Language version: ActionScript 3.0
Runtime version: AIR 1.0

The DRMErrorEvent.DRM_ERROR constant defines the value of the type property of a drmError event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorIDA numerical error code assigned to the problem.
subErrorIDAn error code that indicates more detailed information about the underlying problem.
targetThe NetStream object.

See also

DRM_LOAD_DEVICEID_ERRORconstant 
public static const DRM_LOAD_DEVICEID_ERROR:String = "drmLoadDeviceIdError"
Examples
examples\DRMErrorEventExample
package
{
    import flash.display.Sprite;
	import flash.events.AsyncErrorEvent;
	import flash.events.NetStatusEvent;
	import flash.events.DRMErrorEvent;
	import flash.media.Video;
	import flash.net.NetConnection;
	import flash.net.NetStream;

	public class DRMVideoExample extends Sprite
	{
		var videoURL:String = "Video.flv";
		var videoConnection:NetConnection;
		var videoStream:NetStream;
		var video:Video = new Video();			

		public function DRMVideoExample()
		{
            videoConnection = new NetConnection();
            videoConnection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
            videoConnection.connect(null);
        }

        private function connectStream():void {
            videoStream = new NetStream(videoConnection);
            videoStream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
            videoStream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
			videoStream.addEventListener(DRMErrorEvent.DRM_ERROR, drmErrorEventHandler);
            video.attachNetStream(videoStream);
            videoStream.play(videoURL);
            addChild(video);
        }

        private function netStatusHandler(event:NetStatusEvent):void {
            switch (event.info.code) {
                case "NetConnection.Connect.Success":
                    connectStream();
                    break;
                case "NetStream.Play.StreamNotFound":
                    trace("Unable to locate video: " + videoURL);
                    break;
            }
        }

        private function asyncErrorHandler(event:AsyncErrorEvent):void {
            // ignore AsyncErrorEvent events.
        }

		private function drmErrorEventHandler(event:DRMErrorEvent):void {
			trace(event.toString());
		}
 	}
}