Packageflash.net
Classpublic final class NetStreamMulticastInfo
InheritanceNetStreamMulticastInfo Inheritance Object

Language version: ActionScript 3.0
Runtime version: 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
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
  
Returns a string listing the properties of the NetStreamMulticastInfo object.
NetStreamMulticastInfo
 Inherited
Returns the primitive value of the specified object.
Object
Property detail
bytesPushedFromPeersproperty
bytesPushedFromPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

bytesPushedToPeersproperty 
bytesPushedToPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

bytesReceivedFromIPMulticastproperty 
bytesReceivedFromIPMulticast:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

bytesReceivedFromServerproperty 
bytesReceivedFromServer:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

bytesRequestedByPeersproperty 
bytesRequestedByPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

bytesRequestedFromPeersproperty 
bytesRequestedFromPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsPushedFromPeersproperty 
fragmentsPushedFromPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsPushedToPeersproperty 
fragmentsPushedToPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsReceivedFromIPMulticastproperty 
fragmentsReceivedFromIPMulticast:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsReceivedFromServerproperty 
fragmentsReceivedFromServer:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsRequestedByPeersproperty 
fragmentsRequestedByPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

fragmentsRequestedFromPeersproperty 
fragmentsRequestedFromPeers:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

receiveControlBytesPerSecondproperty 
receiveControlBytesPerSecond:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

receiveDataBytesPerSecondproperty 
receiveDataBytesPerSecond:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

receiveDataBytesPerSecondFromIPMulticastproperty 
receiveDataBytesPerSecondFromIPMulticast:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

receiveDataBytesPerSecondFromServerproperty 
receiveDataBytesPerSecondFromServer:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

sendControlBytesPerSecondproperty 
sendControlBytesPerSecond:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

sendControlBytesPerSecondToServerproperty 
sendControlBytesPerSecondToServer:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

sendDataBytesPerSecondproperty 
sendDataBytesPerSecond:Number  [read-only]

Language version: ActionScript 3.0
Runtime version: 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

Method detail
toString()method
public function toString():String

Language version: ActionScript 3.0
Runtime version: 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