ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
NetStatusEvent

Package | flash.events
Class | public class NetStatusEvent
Inheritance | NetStatusEvent Event Object

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Flash® Player dispatches NetStatusEvent objects when a NetConnection, NetStream, or SharedObject object reports its status. There is only one type of status event: `NetStatusEvent.NET_STATUS`.

View the examples

See also

flash.net.NetConnection
flash.net.NetStream
flash.net.SharedObject
NetStatusEvent.NET_STATUS

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | info : Object An object with properties that describe the object's status or error condition. | NetStatusEvent
|  | prototype : Object [static] A reference to the prototype object of a class or function object. | Object
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NetStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null) Creates an Event object that contains information about netStatus events. | NetStatusEvent
|  | clone():Event Creates a copy of the NetStatusEvent object and sets the value of each property to match that of the original. | NetStatusEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in your custom Event class. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether preventDefault() has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | 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
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toString():String Returns a string that contains all the properties of the NetStatusEvent object. | NetStatusEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTIVATE : String = "activate" [static] Defines the value of the type property of an activate event object. | Event
|  | ADDED : String = "added" [static] Defines the value of the type property of an added event object. | Event
|  | ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object. | Event
|  | CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object. | Event
|  | CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | Event
|  | CLEAR : String = "clear" [static] Defines the value of the type property of a clear event object. | Event
|  | CLOSE : String = "close" [static] Defines the value of the type property of a close event object. | Event
|  | COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | Event
|  | CONNECT : String = "connect" [static] Defines the value of the type property of a connect event object. | Event
|  | COPY : String = "copy" [static] Defines the value of the type property of a copy event object. | Event
|  | CUT : String = "cut" [static] Defines the value of the type property of a cut event object. | Event
|  | DEACTIVATE : String = "deactivate" [static] Defines the value of the type property of a deactivate event object. | Event
|  | ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object. | Event
|  | EXIT_FRAME : String = "exitFrame" [static] Defines the value of the type property of an exitFrame event object. | Event
|  | FRAME_CONSTRUCTED : String = "frameConstructed" [static] Defines the value of the type property of an frameConstructed event object. | Event
|  | FULLSCREEN : String = "fullScreen" [static] Defines the value of the type property of a fullScreen event object. | Event
|  | ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object. | Event
|  | INIT : String = "init" [static] Defines the value of the type property of an init event object. | Event
|  | MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object. | Event
|  | NET_STATUS : String = "netStatus" [static] Defines the value of the type property of a netStatus event object. | NetStatusEvent
|  | OPEN : String = "open" [static] Defines the value of the type property of an open event object. | Event
|  | PASTE : String = "paste" [static] Defines the value of the type property of a paste event object. | Event
|  | REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object. | Event
|  | REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object. | Event
|  | RENDER : String = "render" [static] Defines the value of the type property of a render event object. | Event
|  | RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | Event
|  | SAMPLE_DATA : String = "sampleData" [static] Defines the value of the type property of a sampleData event object. | Event
|  | SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object. | Event
|  | SELECT : String = "select" [static] Defines the value of the type property of a select event object. | Event
|  | SELECT_ALL : String = "selectAll" [static] Defines the value of the type property of a selectAll event object. | Event
|  | SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object. | Event
|  | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object. | Event
|  | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object. | Event
|  | TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object. | Event
|  | UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object. | Event

Property Detail

info | property

`info:Object` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

An object with properties that describe the object's status or error condition.

The information object could have a `code` property containing a string that represents a specific event or a `level` property containing a string that is either `"status"` or `"error"`.

The information object could also be something different. The `code` and `level` properties might not work for some implementations and some servers might send different objects.

P2P connections send messages to a `NetConnection` with a `stream` parameter in the information object that indicates which `NetStream` the message pertains to.

The following table describes the possible string values of the `code` and `level` properties.

Code property | Level property | Meaning
--- | --- | ---
`"NetStream.Buffer.Empty"` | `"status"` | Data is not being received quickly enough to fill the buffer. Data flow will be interrupted until the buffer refills, at which time a `NetStream.Buffer.Full` message will be sent and the stream will begin playing again.
`"NetStream.Buffer.Full"` | `"status"` | The buffer is full and the stream will begin playing.
`"NetStream.Buffer.Flush"` | `"status"` | Data has finished streaming, and the remaining buffer will be emptied.
`"NetStream.Failed"` | "error" | Flash Media Server only. An error has occurred for a reason other than those listed in other event codes.
`"NetStream.Publish.Start"` | `"status"` | Publish was successful.
`"NetStream.Publish.BadName"` | `"error"` | Attempt to publish a stream which is already being published by someone else.
`"NetStream.Publish.Idle"` | `"status"` | The publisher of the stream is idle and not transmitting data.
`"NetStream.Unpublish.Success"` | `"status"` | The unpublish operation was successfuul.
`"NetStream.Play.Start"` | `"status"` | Playback has started.
`"NetStream.Play.Stop"` | `"status"` | Playback has stopped.
`"NetStream.Play.Failed"` | `"error"` | An error has occurred in playback for a reason other than those listed elsewhere in this table, such as the subscriber not having read access.
`"NetStream.Play.StreamNotFound"` | `"error"` | The FLV passed to the `play()` method can't be found.
`"NetStream.Play.Reset"` | `"status"` | Caused by a play list reset.
`"NetStream.Play.PublishNotify"` | `"status"` | The initial publish to a stream is sent to all subscribers.
`"NetStream.Play.UnpublishNotify"` | `"status"` | An unpublish from a stream is sent to all subscribers.
`"NetStream.Play.InsufficientBW"` | "warning" | Flash Media Server only. The client does not have sufficient bandwidth to play the data at normal speed.
`"NetStream.Play.FileStructureInvalid"` | `"error"` | Player detects an invalid file structure and will not try to play this type of file. For Flash Player 9.0.115.0 and later.
`"NetStream.Play.NoSupportedTrackFound"` | `"error"` | Player does not detect any supported tracks (video, audio or data) and will not try to play the file. For Flash Player 9.0.115.0 and later.
`"NetStream.Pause.Notify"` | `"status"` | The stream is paused.
`"NetStream.Unpause.Notify"` | `"status"` | The stream is resumed.
`"NetStream.Record.Start"` | `"status"` | Recording has started.
`"NetStream.Record.NoAccess"` | `"error"` | Attempt to record a stream that is still playing or the client has no access right.
`"NetStream.Record.Stop"` | `"status"` | Recording stopped.
`"NetStream.Record.Failed"` | `"error"` | An attempt to record a stream failed.
`"NetStream.Seek.Failed"` | `"error"` | The seek fails, which happens if the stream is not seekable.
`"NetStream.Seek.InvalidTime"` | `"error"` | For video downloaded with progressive download, the user has tried to seek or play past the end of the video data that has downloaded thus far, or past the end of the video once the entire file has downloaded. The `message.details` property contains a time code that indicates the last valid position to which the user can seek.
`"NetStream.Seek.Notify"` | `"status"` | The seek operation is complete.
`"NetConnection.Call.BadVersion"` | `"error"` | Packet encoded in an unidentified format.
`"NetConnection.Call.Failed"` | `"error"` | The `NetConnection.call` method was not able to invoke the server-side method or command.
`"NetConnection.Call.Prohibited"` | `"error"` | An Action Message Format (AMF) operation is prevented for security reasons. Either the AMF URL is not in the same domain as the SWF file, or the AMF server does not have a policy file that trusts the domain of the SWF file.
`"NetConnection.Connect.Closed"` | `"status"` | The connection was closed successfully.
`"NetConnection.Connect.Failed"` | `"error"` | The connection attempt failed.
`"NetConnection.Connect.Success"` | `"status"` | The connection attempt succeeded.
`"NetConnection.Connect.Rejected"` | `"error"` | The connection attempt did not have permission to access the application.
`"NetStream.Connect.Closed"` | `"status"` | The P2P connection was closed successfully. The `info.stream` property indicates which stream has closed.
`"NetStream.Connect.Failed"` | `"error"` | The P2P connection attempt failed. The `info.stream` property indicates which stream has failed.
`"NetStream.Connect.Success"` | `"status"` | The P2P connection attempt succeeded. The `info.stream` property indicates which stream has succeeded.
`"NetStream.Connect.Rejected"` | `"error"` | The P2P connection attempt did not have permission to access the other peer. The `info.stream` property indicates which stream was rejected.
`"NetConnection.Connect.AppShutdown"` | `"error"` | The specified application is shutting down.
`"NetConnection.Connect.InvalidApp"` | `"error"` | The application name specified during connect is invalid.
`"SharedObject.Flush.Success"` | `"status"` | The "pending" status is resolved and the `SharedObject.flush()` call succeeded.
`"SharedObject.Flush.Failed"` | `"error"` | The "pending" status is resolved, but the `SharedObject.flush()` failed.
`"SharedObject.BadPersistence"` | `"error"` | A request was made for a shared object with persistence flags, but the request cannot be granted because the object has already been created with different flags.
`"SharedObject.UriMismatch"` | `"error"` | An attempt was made to connect to a NetConnection object that has a different URI (URL) than the shared object.

If you consistently see errors regarding the buffer, try changing the buffer using the `NetStream.bufferTime` property.

Implementation
`public function get info():Object`
`public function set info(value:Object):void`

See also

NetConnection class
NetStream class
Constructor Detail

NetStatusEvent | () | Constructor

`public function NetStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null)`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Creates an Event object that contains information about `netStatus` 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 status event: `NetStatusEvent.NET_STATUS`.
| `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.
| `info:Object` (default = `null`)`` — An object containing properties that describe the object's status. Event listeners can access this object through the `info` property.

See also

flash.events.NetStatusEvent.NET_STATUS
Method Detail

clone | () | method

`override public function clone():Event`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

Returns

| `Event` — A new NetStatusEvent object with property values that match those of the original.

toString | () | method |

`override public function toString():String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

`[NetStatusEvent type=value bubbles=value cancelable=value info=value]`

Returns

| `String` — A string that contains all the properties of the NetStatusEvent object.

Constant Detail

NET_STATUS | Constant

`public static const NET_STATUS:String = "netStatus"`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Defines the value of the `type` property of a `netStatus` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`info` | An object with properties that describe the object's status or error condition.
`target` | The NetConnection or NetStream object reporting its status.

See also

flash.events.NetStatusEvent.info
flash.net.NetConnection.netStatus
flash.net.NetStream.netStatus
flash.net.SharedObject.netStatus
Examples How to use examples
NetStatusEventExample.as
The following example uses a Video object with the NetConnection and NetStream classes to load and play an FLV file.

In this example, the `netStatusHandler` method is registered as a listener for the NetStatusEvent event `NetConnection.netStatus`. When the status (success or failure) of the `NetConnection.connect()` attempt is determined, the `netStatus` event triggers this method. If the attempt to connect to the NetConnection object is successful (in other words, if the `info` property of the NetStatusEvent object dispatched by the `netStatus` event has a `code` property that indicates success), the code creates the Video and NetStream objects and calls the `Video.attachNetStream()` and `NetStream.play()` methods.

Note: To run this example, you need an FLV file whose name and location match the variable passed to `videoURL`; in this case, an FLV file called Video.flv that is in the same directory as the SWF file.

     package {
        import flash.display.Sprite;
        import flash.events.*;
        import flash.media.Video;
        import flash.net.NetConnection;
        import flash.net.NetStream;

        public class NetStatusEventExample extends Sprite {
            private var videoURL:String = "Video.flv";
            private var connection:NetConnection;
            private var stream:NetStream;

            public function NetStatusEventExample() {
                connection = new NetConnection();
                connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
                connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
                connection.connect(null);
            }

            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 connectStream():void {
                var stream:NetStream = new NetStream(connection);
                stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
                stream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
                var video:Video = new Video();
                video.attachNetStream(stream);
                stream.play(videoURL);
                addChild(video);
            }

            private function securityErrorHandler(event:SecurityErrorEvent):void {
                trace("securityErrorHandler: " + event);
            }

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

        }
     }

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00