flash.net

# NetStreamMulticastInfo - AS3

Package | flash.net
Class | public final class NetStreamMulticastInfo
Inheritance | NetStreamMulticastInfo 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.

Related API Elements

toString()
flash.net.NetStream.multicastInfo

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined 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
|  | constructor : 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
|  | 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | 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
|  | 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
|  | 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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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`

Related API Elements

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00