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

NetClient  - AS3 OSMF

Packageorg.osmf.net
Classpublic dynamic class NetClient
InheritanceNetClient Inheritance Proxy

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

The NetClient class provides support for handling callbacks dynamically from an RTMP server that is streaming to a MediaElement that works with NetStream under the hood (such as VideoElement).

Use this class to listen for callbacks on the NetConnection and NetStream created by a NetLoader's load operation.

Assign the value of the client property of the NetConnection or NetStream to an instance of the NetClient class. Then use the NetClient's addHandler() and removeHandler() methods to register and unregister handlers for the NetStream callbacks.

Related API Elements



Public Methods
 MethodDefined By
  
addHandler(name:String, handler:Function, priority:int = 0):void
Adds a handler for the specified callback name.
NetClient
  
Removes a handler method for the specified callback name.
NetClient
Method Detail

addHandler

()method
public function addHandler(name:String, handler:Function, priority:int = 0):void

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

Adds a handler for the specified callback name.

If multiple handlers register for the same callback, the result of the callback is an array holding the results of each handler's invocation.

This example sets up handler for the onMetaData callback.

         function onMetaData(value:Object):void
         {
               trace("Got metadata.");
         }
         
         var stream:NetStream;
         var client:NetClient = (stream.client as NetClient); //assign the stream to the NetClient
         client.addHandler("onMetaData", onMetaData); //add the handler
         

Parameters

name:String — Name of callback to handle.
 
handler:Function — Handler to add.
 
priority:int (default = 0)

removeHandler

()method 
public function removeHandler(name:String, handler:Function):void

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

Removes a handler method for the specified callback name.

Parameters

name:String — Name of callback for whose handler is being removed.
 
handler:Function — Handler to remove.