org.osmf.events

# MetricError - AS3 OSMF

Package | org.osmf.events
Class | public class MetricError
Inheritance | MetricError Error 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
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
|  | detail : String [read-only] An optional string that contains supporting detail for the error. | MetricError
|  | errorID : int [read-only] Contains the reference number associated with the specific error message. | Error
|  | message : String Contains the message associated with the Error object. | Error
|  | name : String Contains the name of the Error object. | Error

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MetricError(errorID:int, detail:String = null) Constructor. | MetricError
|  | getStackTrace():String Returns the call stack for an error at the time of the error's construction as a string. | Error
|  | 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
|  | 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 [override] Returns the string "Error" by default or the value contained in the Error.message property, if defined. | Error
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Protected Methods

| Method | Defined 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00