Indicates the object on which callback methods should be invoked. The default is this NetConnection instance. If you set the client property to another object, callback methods will be invoked on that object.

Indicates whether Flash Player has connected to a server through a persistent RTMP connection (true) or not (false). When connected through HTTP, this property is always false. It is always true for AMF connections to application servers.

If a successful connection is made, indicates the method that was used to make it: a direct connection, the CONNECT method, or HTTP tunneling. Possible values are "none", "HTTP", "HTTPS", and "CONNECT". This property is valid only when a NetConnection object is connected. This property is used in Flex applications and Flash Media Server applications. In Flash Player 9, this property is applicable only when RTMP, RTMPS, or RTMPT is used. The CONNECT method is applicable only to users who are connected to the network by a proxy server.

You can read this property to determine which method of connection was used. This property returns "none" if a direct connection was made, "HTTP" if HTTP tunneling was used, "HTTPS" if secure HTTPS tunneling was used, and "CONNECT" if the proxy CONNECT method was used.

The default object encoding (AMF version) for NetConnection objects created in the SWF file. When an object is written to or read from binary data, the defaultObjectEncoding property indicates which Action Message Format version should be used: the ActionScript 3.0 format or the ActionScript 1.0 and ActionScript 2.0 format.

By default, NetConnection.defaultObjectEncoding is set to use the ActionScript 3.0 format, AMF3. Changing NetConnection.defaultObjectEncoding does not affect existing NetConnection instances; it affects only instances that are created subsequently.

To set an object's encoding separately (rather than setting object encoding for the entire SWF file), set the objectEncoding property of the NetConnection object instead.

For more detailed information, see the description of the objectEncoding property.

See also

The object encoding (AMF version) for this NetConnection instance. The default value of this property is the value of defaultObjectEncoding. Acceptable values are ObjectEncoding.AMF3 and ObjectEncoding.AMF0.

It's important to understand this property if your ActionScript 3.0 SWF file needs to communicate with servers released prior to Flash Player 9.

When an object is written to or read from binary data, the objectEncoding property indicates which Action Message Format version should be used: the ActionScript 3.0 format (ObjectEncoding.AMF3) or the ActionScript 1.0 and ActionScript 2.0 format (ObjectEncoding.AMF0). When you use NetConnection objects to connect to a server, three scenarios are possible:

• Connecting exclusively to a server that was released with or after Flash Player 9, such as Flex 2. The default value of defaultObjectEncoding is ObjectEncoding.AMF3. All NetConnection instances created in this SWF file use AMF3 serialization, so you don't need to tell Flash Player which AMF encoding to use.
• Connecting exclusively to a server that was released prior to Flash Player 9, such as Flex 1.5 and Flash Media Server 2. In this scenario, set the static defaultObjectEncoding property to ObjectEncoding.AMF0. All NetConnection instances created in this SWF file use AMF0 serialization. You don't need to set the objectEncoding property.
• Connecting to multiple servers that use different encoding versions. Instead of using defaultObjectEncoding, set the object encoding on a per-connection basis using the objectEncoding property for each connection. Set it to ObjectEncoding.AMF0 to connect to servers that use AMF0 encoding, such as Flex 1.5 and Flash Media Server 2, and set it to ObjectEncoding.AMF3 to connect to servers that use AMF3 encoding, such as Flex 2.

Changing defaultObjectEncoding does not affect existing NetConnection instances; it affects only instances that are created subsequently.

Once the NetConnection instance is connected, its objectEncoding property is read-only.

If you use the wrong encoding to connect to a server, Flash Player dispatches the netStatus event. The NetStatusEvent.info property contains an information object with a code property value of NetConnection.Connect.Failed, and a description explaining that the object encoding is incorrect.

See also

Determines whether native SSL is used for RTMPS instead of HTTPS, and whether the CONNECT method of tunneling is used to connect through a proxy server. Acceptable values are "none", "HTTP", "CONNECT", and "best". This property is used in Flex applications and Flash Media Server 2 applications.

In Flash Player 9, this property is applicable only when using RTMP, RTMPS, or RTMPT. The CONNECT method is applicable only to users who are connected to the network by a proxy server.

The proxyType property determines which fallback methods are tried if the initial connection attempt fails. You must set the proxyType property before calling the NetConnection.connect() method. This property determines whether to try to use native Transport Layer Security (TLS), and how to work with proxy servers that your application encounters when attempting to make a connection.

In Flash Player 9, the default value for this property is "none"; if you do not change this value, Flash Player uses HTTPS tunneling for RTMPS. If the property is set to "best", the optimal method of connecting is established, attempting the best method first and then falling back to other methods if they fail. For RTMPS connections, native SSL sockets are used by default, and a fallback to other methods is used if necessary. If the property is set to "HTTP" and a direct connection fails, the old method of HTTP tunneling is used. If the property is set to "CONNECT" and a direct connection fails, the CONNECT method of tunneling is used. If that fails, the connection will not fall back to HTTP tunneling.

The URI of the application server that was passed to NetConnection.connect(), if connect was used to connect to a server. If NetConnection.connect() hasn't yet been called or if no URI was passed, this property is undefined.

Indicates whether a secure connection was made using native Transport Layer Security (TLS) rather than HTTPS. This property is valid only when a NetConnection object is connected.

Creates a NetConnection object that you can use with a NetStream object to invoke commands on a remote application server or to play back streaming video (FLV) files locally. After creating the NetConnection object, use connect() to make the actual connection.

Playing external FLV files provides several advantages over embedding video in a Flash document, such as better performance, better memory management, and independent video and Flash frame rates.

If your ActionScript 3.0 SWF file needs to communicate with servers released prior to Flash Player 9, you might need to adjust the NetConnection object's objectEncoding property.

See also

Adds a context header to the AMF packet structure. This header is sent with every future AMF packet. If you call NetConnection.addHeader() using the same name, the new header replaces the existing header, and the new header persists for the duration of the NetConnection object. You can remove a header by calling NetConnection.addHeader() with the name of the header to remove an undefined object. This method is relevant when used with a server, such as Flex or Flash Media Server.

Parameters

Invokes a command or method on the server running Flash Media Server, or on an application server, to which the application instance is connected. You must create a server-side function to pass to this method.

Parameters

Closes the connection that was opened locally or with the server and dispatches the netStatus event with a code property of NetConnection.Connect.Closed.

This method disconnects all NetStream objects running over this connection; any queued data that has not been sent is discarded. (To terminate streams without closing the connection, use NetStream.close().) If you call this method and then want to reconnect, you must recreate the NetStream object.

See also

Opens a connection to a server. Through this connection, you can play back audio or video (FLV) files from the local file system, or you can invoke commands on a remote server.

When using this method, consider the Flash Player security model and the following security considerations:

• By default, the website denies access between sandboxes. The website can enable access to a resource by using a cross-domain policy file.
• A website can deny access to a resource by adding server-side ActionScript application logic in Flash Media Server.
• You cannot use the NetConnection.connect() method if the calling SWF file is in the local-with-file-system sandbox.
• You can prevent a SWF file from using this method by setting the allowNetworking parameter of the the object and embed tags in the HTML page that contains the SWF content.

For more information, see the following:

• The security chapter in the Programming ActionScript 3.0 book and the latest comments on LiveDocs
• The Flash Player 9 Security white paper

Parameters

See also

Dispatched when an exception is thrown asynchronously — that is, from native asynchronous code.

This event has the following properties:

Dispatched when an input or output error occurs that causes a network operation to fail.

This event has the following properties:

Dispatched when a NetConnection object is reporting its status or error condition. The netStatus event contains an info property, which is an information object that contains specific information about the event, such as whether a connection attempt succeeded or failed.

This event has the following properties:

See also

Dispatched if a call to NetConnection.call() attempts to connect to a server outside the caller's security sandbox.

This event has the following properties:

See also

In this example, the code that creates the Video and NetStream objects and calls the Video.attachNetStream() and NetStream.play() methods is placed in a handler function. The handler is called only if the attempt to connect to the NetConnection object is successful; that is, when the netStatus event returns an info object with a code property that indicates success. It is recommended that you wait for a successful connection before you call NetStream.play().

package {
    import flash.display.Sprite;
    import flash.events.NetStatusEvent;
    import flash.events.SecurityErrorEvent;
    import flash.media.Video;
    import flash.net.NetConnection;
    import flash.net.NetStream;
    import flash.events.Event;

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

        public function NetConnectionExample() {
            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("Stream not found: " + videoURL);
                    break;
            }
        }

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

        private function connectStream():void {
            var stream:NetStream = new NetStream(connection);
            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
            stream.client = new CustomClient();
            var video:Video = new Video();
            video.attachNetStream(stream);
            stream.play(videoURL);
            addChild(video);
        }
    }
}

class CustomClient {
    public function onMetaData(info:Object):void {
        trace("metadata: duration=" + info.duration + " width=" + info.width + " height=" + info.height + " framerate=" + info.framerate);
    }
    public function onCuePoint(info:Object):void {
        trace("cuepoint: time=" + info.time + " name=" + info.name + " type=" + info.type);
    }
}