ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

MetricError  - AS3 OSMF
Packageorg.osmf.events
Classpublic class MetricError
InheritanceMetricError Inheritance Error Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

A MetricError encapsulates an error related to the metrics used in the Adaptive Bitrate algorithm. Errors are represented as error IDs with corresponding messages. Error IDs zero through 999 are reserved for use by the framework.

A list of all possible framework-level errors can be found in the ABRErrorCodes class.

For custom errors, clients should subclass ABRError and override getMessageForErrorID to return messages for the custom errors.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  detail : String
[read-only] An optional string that contains supporting detail for the error.
MetricError
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error message.
Error
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
Public Methods
 MethodDefined By
  
MetricError(errorID:int, detail:String = null)
Constructor.
MetricError
 Inherited
getStackTrace():String
Returns the call stack for an error at the time of the error's construction as a string.
Error
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
[override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.
Error
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
  
getMessageForErrorID(errorID:int):String
Returns the message for the error with the specified ID.
MetricError
Property Detail

detail

property
detail:String  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

An optional string that contains supporting detail for the error. Typically this string is simply the error detail provided by a Flash Player API.



Implementation
    public function get detail():String
Constructor Detail

MetricError

()Constructor
public function MetricError(errorID:int, detail:String = null)

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
errorID:int — The ID for the error. Used to look up a corresponding message. Error IDs 0-999 are reserved for use by the framework, and are defined in MetricErrorCodes.
 
detail:String (default = null) — An optional string that contains supporting detail for the error. Typically this string is simply the error detail provided by a Flash Player API.
Method Detail

getMessageForErrorID

()method
protected function getMessageForErrorID(errorID:int):String

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

Returns the message for the error with the specified ID. If the error ID is unknown, returns the empty string.

Subclasses should override to provide messages for their custom errors, as this method returns the value that is exposed in the message property.

Parameters

errorID:int — The ID for the error.

Returns
String — The message for the error with the specified error ID.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy