Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.net 
NetStreamMulticastInfo 
Packageflash.net
Classpublic final class NetStreamMulticastInfo
InheritanceNetStreamMulticastInfo Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

The NetStreamMulticastInfo class specifies various Quality of Service (QoS) statistics related to a NetStream object's underlying RTMFP Peer-to-Peer and IP Multicast stream transport. A NetStreamMulticastInfo object is returned by the NetStream.multicastInfo property.

Properties that return numbers represent totals computed from the beginning of the multicast stream. These types of properties include the number of media bytes sent or the number of media fragment messages received. Properties that are rates represent a snapshot of the current rate averaged over a few seconds. These types of properties include the rate at which a local node is receiving data.

To see a list of values contained in the NetStreamMulticastInfo object, use the NetStreamMulticastInfo.toString() method.

See also

toString()
flash.net.NetStream.multicastInfo

Public Properties
 PropertyDefined By
  bytesPushedFromPeers : Number
[read-only] Specifies the number of media bytes that were proactively pushed from peers and received by the local node.
NetStreamMulticastInfo
  bytesPushedToPeers : Number
[read-only] Specifies the number of media bytes that the local node has proactively pushed to peers.
NetStreamMulticastInfo
  bytesReceivedFromIPMulticast : Number
[read-only] Specifies the number of media bytes that the local node has received from IP Multicast.
NetStreamMulticastInfo
  bytesReceivedFromServer : Number
[read-only] Specifies the number of media bytes that the local node has received from the server.
NetStreamMulticastInfo
  bytesRequestedByPeers : Number
[read-only] Specifies the number of media bytes that the local node has sent to peers in response to requests from those peers for specific fragments.
NetStreamMulticastInfo
  bytesRequestedFromPeers : Number
[read-only] Specifies the number of media bytes that the local node requested and received from peers.
NetStreamMulticastInfo
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  fragmentsPushedFromPeers : Number
[read-only] Specifies the number of media fragment messages that were proactively pushed from peers and received by the local node.
NetStreamMulticastInfo
  fragmentsPushedToPeers : Number
[read-only] Specifies the number of media fragment messages that the local node has proactively pushed to peers.
NetStreamMulticastInfo
  fragmentsReceivedFromIPMulticast : Number
[read-only] Specifies the number of media fragment messages that the local node has received from IP Multicast.
NetStreamMulticastInfo
  fragmentsReceivedFromServer : Number
[read-only] Specifies the number of media fragment messages that the local node has received from the server.
NetStreamMulticastInfo
  fragmentsRequestedByPeers : Number
[read-only] Specifies the number of media fragment messages that the local node has sent to peers in response to requests from those peers for specific fragments.
NetStreamMulticastInfo
  fragmentsRequestedFromPeers : Number
[read-only] Specifies the number of media fragment messages that the local node requested and received from peers.
NetStreamMulticastInfo
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  receiveControlBytesPerSecond : Number
[read-only] Specifies the rate at which the local node is receiving control overhead messages from peers, in bytes per second.
NetStreamMulticastInfo
  receiveDataBytesPerSecond : Number
[read-only] Specifies the rate at which the local node is receiving media data from peers, from the server, and over IP multicast, in bytes per second.
NetStreamMulticastInfo
  receiveDataBytesPerSecondFromIPMulticast : Number
[read-only] Specifies the rate at which the local node is receiving data from IP Multicast, in bytes per second.
NetStreamMulticastInfo
  receiveDataBytesPerSecondFromServer : Number
[read-only] Specifies the rate at which the local node is receiving media data from the server, in bytes per second.
NetStreamMulticastInfo
  sendControlBytesPerSecond : Number
[read-only] Specifies the rate at which the local node is sending control overhead messages to peers and the server, in bytes per second.
NetStreamMulticastInfo
  sendControlBytesPerSecondToServer : Number
[read-only] Specifies the rate at which the local node is sending control overhead messages to the server, in bytes per second.
NetStreamMulticastInfo
  sendDataBytesPerSecond : Number
[read-only] Specifies the rate at which media data is being sent by the local node to peers, in bytes per second.
NetStreamMulticastInfo
Public Methods
 MethodDefined By
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
Returns a string listing the properties of the NetStreamMulticastInfo object.
NetStreamMulticastInfo
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

bytesPushedFromPeers

property
bytesPushedFromPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that were proactively pushed from peers and received by the local node.



Implementation
    public function get bytesPushedFromPeers():Number

See also

bytesRequestedFromPeers
fragmentsPushedFromPeers
fragmentsRequestedFromPeers

bytesPushedToPeers

property 
bytesPushedToPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that the local node has proactively pushed to peers.



Implementation
    public function get bytesPushedToPeers():Number

See also

bytesRequestedByPeers
fragmentsPushedToPeers
fragmentsRequestedByPeers

bytesReceivedFromIPMulticast

property 
bytesReceivedFromIPMulticast:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that the local node has received from IP Multicast.



Implementation
    public function get bytesReceivedFromIPMulticast():Number

See also

bytesReceivedFromServer
fragmentsReceivedFromIPMulticast
fragmentsReceivedFromServer
receiveDataBytesPerSecondFromIPMulticast

bytesReceivedFromServer

property 
bytesReceivedFromServer:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that the local node has received from the server.



Implementation
    public function get bytesReceivedFromServer():Number

See also

bytesReceivedFromIPMulticast
fragmentsReceivedFromIPMulticast
fragmentsReceivedFromServer
receiveDataBytesPerSecondFromServer

bytesRequestedByPeers

property 
bytesRequestedByPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that the local node has sent to peers in response to requests from those peers for specific fragments.



Implementation
    public function get bytesRequestedByPeers():Number

See also

bytesPushedToPeers
fragmentsPushedToPeers
fragmentsRequestedByPeers

bytesRequestedFromPeers

property 
bytesRequestedFromPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media bytes that the local node requested and received from peers.



Implementation
    public function get bytesRequestedFromPeers():Number

See also

bytesPushedFromPeers
fragmentsPushedFromPeers
fragmentsRequestedFromPeers

fragmentsPushedFromPeers

property 
fragmentsPushedFromPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that were proactively pushed from peers and received by the local node.



Implementation
    public function get fragmentsPushedFromPeers():Number

See also

bytesPushedFromPeers
bytesRequestedFromPeers
fragmentsRequestedFromPeers

fragmentsPushedToPeers

property 
fragmentsPushedToPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that the local node has proactively pushed to peers.



Implementation
    public function get fragmentsPushedToPeers():Number

See also

bytesPushedToPeers
bytesRequestedByPeers
fragmentsRequestedByPeers

fragmentsReceivedFromIPMulticast

property 
fragmentsReceivedFromIPMulticast:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that the local node has received from IP Multicast.



Implementation
    public function get fragmentsReceivedFromIPMulticast():Number

See also

bytesReceivedFromIPMulticast
bytesReceivedFromServer
fragmentsReceivedFromServer
receiveDataBytesPerSecondFromIPMulticast

fragmentsReceivedFromServer

property 
fragmentsReceivedFromServer:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that the local node has received from the server.



Implementation
    public function get fragmentsReceivedFromServer():Number

See also

bytesReceivedFromIPMulticast
bytesReceivedFromServer
fragmentsReceivedFromIPMulticast
receiveDataBytesPerSecondFromServer

fragmentsRequestedByPeers

property 
fragmentsRequestedByPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that the local node has sent to peers in response to requests from those peers for specific fragments.



Implementation
    public function get fragmentsRequestedByPeers():Number

See also

bytesPushedToPeers
bytesRequestedByPeers
fragmentsPushedToPeers

fragmentsRequestedFromPeers

property 
fragmentsRequestedFromPeers:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the number of media fragment messages that the local node requested and received from peers.



Implementation
    public function get fragmentsRequestedFromPeers():Number

See also

bytesPushedFromPeers
bytesRequestedFromPeers
fragmentsPushedFromPeers

receiveControlBytesPerSecond

property 
receiveControlBytesPerSecond:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is receiving control overhead messages from peers, in bytes per second.



Implementation
    public function get receiveControlBytesPerSecond():Number

See also

receiveDataBytesPerSecond
receiveDataBytesPerSecondFromServer
receiveDataBytesPerSecondFromIPMulticast
sendControlBytesPerSecond

receiveDataBytesPerSecond

property 
receiveDataBytesPerSecond:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is receiving media data from peers, from the server, and over IP multicast, in bytes per second.



Implementation
    public function get receiveDataBytesPerSecond():Number

See also

receiveControlBytesPerSecond
receiveDataBytesPerSecondFromIPMulticast
receiveDataBytesPerSecondFromServer
sendDataBytesPerSecond

receiveDataBytesPerSecondFromIPMulticast

property 
receiveDataBytesPerSecondFromIPMulticast:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is receiving data from IP Multicast, in bytes per second.



Implementation
    public function get receiveDataBytesPerSecondFromIPMulticast():Number

See also

receiveControlBytesPerSecond
receiveDataBytesPerSecond
receiveDataBytesPerSecondFromServer
sendDataBytesPerSecond

receiveDataBytesPerSecondFromServer

property 
receiveDataBytesPerSecondFromServer:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is receiving media data from the server, in bytes per second.



Implementation
    public function get receiveDataBytesPerSecondFromServer():Number

See also

receiveControlBytesPerSecond
receiveDataBytesPerSecond
receiveDataBytesPerSecondFromIPMulticast
sendDataBytesPerSecond

sendControlBytesPerSecond

property 
sendControlBytesPerSecond:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is sending control overhead messages to peers and the server, in bytes per second.



Implementation
    public function get sendControlBytesPerSecond():Number

See also

receiveControlBytesPerSecond
sendControlBytesPerSecondToServer
sendDataBytesPerSecond

sendControlBytesPerSecondToServer

property 
sendControlBytesPerSecondToServer:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which the local node is sending control overhead messages to the server, in bytes per second.



Implementation
    public function get sendControlBytesPerSecondToServer():Number

See also

receiveDataBytesPerSecondFromServer
sendControlBytesPerSecond
sendDataBytesPerSecond

sendDataBytesPerSecond

property 
sendDataBytesPerSecond:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Specifies the rate at which media data is being sent by the local node to peers, in bytes per second.



Implementation
    public function get sendDataBytesPerSecond():Number

See also

receiveDataBytesPerSecond
sendControlBytesPerSecond
sendControlBytesPerSecondToServer
Method Detail

toString

()method
public function toString():String

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.1, AIR 2

Returns a string listing the properties of the NetStreamMulticastInfo object.

Returns
String — A string containing the values of the properties of the NetStreamMulticastInfo object



© 2010 Adobe Systems Incorporated. All rights reserved.
Thu May 20 2010, 02:19 AM -07:00