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

VideoError  - AS3 Flash

Packagefl.video
Classpublic class VideoError
InheritanceVideoError Inheritance Error Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The VideoError exception is the primary mechanism for reporting runtime errors from the FLVPlayback and VideoPlayer classes.



Public Properties
 PropertyDefined By
  code : uint
[read-only] The code that corresponds to the error.
VideoError
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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
  
VideoError(errCode:uint, msg:String = null)
Creates a new VideoError object.
VideoError
 Inherited
Returns the call stack for an error at the time of the error's construction as a string.
Error
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.
Error
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DELETE_DEFAULT_PLAYER : uint = 1007
[static] State variable indicating that the user cannot delete the default VideoPlayer object.
VideoError
  ILLEGAL_CUE_POINT : uint = 1002
[static] State variable indicating the illegal cue point.
VideoError
  INCMANAGER_CLASS_UNSET : uint = 1008
[static] State variable indicating that the INCManager class is not set.
VideoError
  INVALID_SEEK : uint = 1003
[static] State variable indicating an invalid seek.
VideoError
  INVALID_SOURCE : uint = 1004
[static] State variable indicating an invalid source.
VideoError
  INVALID_XML : uint = 1005
[static] State variable indicating invalid XML.
VideoError
  MISSING_SKIN_STYLE : uint = 1010
[static] State variable indicating a missing skin style.
VideoError
  NETSTREAM_CLIENT_CLASS_UNSET : uint = 1012
[static] An error that occurs when the VideoPlayer.netStatusClientClass static property is set to an invalid value.
VideoError
  NO_BITRATE_MATCH : uint = 1006
[static] State variable indicating that there is no bitrate match.
VideoError
  NO_CONNECTION : uint = 1000
[static] State variable indicating that Flash Player is unable to make a connection to the server or to find the FLV file on the server.
VideoError
  NULL_URL_LOAD : uint = 1009
[static] State variable indicating that a null URL was sent to the load() method.
VideoError
  SHORT_VERSION : String = "2.1"
[static] State variable indicating the short version number of the component.
VideoError
  UNSUPPORTED_PROPERTY : uint = 1011
[static] State variable indicating that an unsupported property was passed to the INCManager class, or the getProperty or setProperty methods.
VideoError
  VERSION : String = "2.1.0.23"
[static] State variable indicating the long version number of the component.
VideoError
Property Detail

code

property
code:uint  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The code that corresponds to the error. The error code is passed into the constructor.



Implementation
    public function get code():uint
Constructor Detail

VideoError

()Constructor
public function VideoError(errCode:uint, msg:String = null)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates a new VideoError object.

Parameters
errCode:uint — The code that corresponds to the error.
 
msg:String (default = null) — The error message.
Constant Detail

DELETE_DEFAULT_PLAYER

Constant
public static const DELETE_DEFAULT_PLAYER:uint = 1007

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that the user cannot delete the default VideoPlayer object.

ILLEGAL_CUE_POINT

Constant 
public static const ILLEGAL_CUE_POINT:uint = 1002

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating the illegal cue point.

INCMANAGER_CLASS_UNSET

Constant 
public static const INCMANAGER_CLASS_UNSET:uint = 1008

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that the INCManager class is not set.

INVALID_SEEK

Constant 
public static const INVALID_SEEK:uint = 1003

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating an invalid seek.

INVALID_SOURCE

Constant 
public static const INVALID_SOURCE:uint = 1004

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating an invalid source.

INVALID_XML

Constant 
public static const INVALID_XML:uint = 1005

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating invalid XML.

MISSING_SKIN_STYLE

Constant 
public static const MISSING_SKIN_STYLE:uint = 1010

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating a missing skin style.

NETSTREAM_CLIENT_CLASS_UNSET

Constant 
public static const NETSTREAM_CLIENT_CLASS_UNSET:uint = 1012

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.115.0, AIR 1.0

An error that occurs when the VideoPlayer.netStatusClientClass static property is set to an invalid value. This includes cases where it is a string and the class cannot be found and where the class does not have a constructor that takes an instance of VideoPlayer as a parameter.

A sample error message can be seen with the following code:

      // Place the FLVPlayback component on the Stage at 0,0 and provide the instance name myflvPlayback.
      import fl.video.
      VideoPlayer.netStreamClientClass = null;
       try {
            myflvPlayback.play('test.flv');
       } catch (e:VideoError) {
             if (e.code =VideoError.NETSTREAM_CLIENT_CLASS_UNSET) {
               trace('I forced this error on purpose');
             }
      }
    

NO_BITRATE_MATCH

Constant 
public static const NO_BITRATE_MATCH:uint = 1006

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that there is no bitrate match.

NO_CONNECTION

Constant 
public static const NO_CONNECTION:uint = 1000

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that Flash Player is unable to make a connection to the server or to find the FLV file on the server.

NULL_URL_LOAD

Constant 
public static const NULL_URL_LOAD:uint = 1009

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that a null URL was sent to the load() method.

SHORT_VERSION

Constant 
public static const SHORT_VERSION:String = "2.1"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating the short version number of the component. The version number is useful when you have a FLA file and need to know the component version. To determine the component version, type the following code trace into the FLA file:

FLVPlayback.SHORT_VERSION

The SHORT_VERSION variable includes only the major and minor version numbers, for example, 2.0. The VERSION variable includes the major and minor version numbers as well as the revision and build numbers, for example, 2.0.0.11.

Related API Elements

UNSUPPORTED_PROPERTY

Constant 
public static const UNSUPPORTED_PROPERTY:uint = 1011

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating that an unsupported property was passed to the INCManager class, or the getProperty or setProperty methods.

Related API Elements

VERSION

Constant 
public static const VERSION:String = "2.1.0.23"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

State variable indicating the long version number of the component. The version number is useful when you have a FLA file and need to know the component version. To determine the component version, type the following code trace into the FLA file:

FLVPlayback.VERSION

The VERSION variable includes the major and minor version numbers as well as the revision and build numbers, for example, 2.0.0.11. The SHORT_VERSION variable includes only the major and minor version numbers, for example, 2.0.

Related API Elements