ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
NetStreamInfo

Package | flash.net
Class | public final class NetStreamInfo
Inheritance | NetStreamInfo Object

The NetStreamInfo class specifies the various Quality of Service (QOS) statistics related to NetStream and the underlying streaming buffer for audio video and data. NetStreamInfo object is returned in response to the `NetStream.getInfo`call which takes a snapshot of the current QOS state and provides it through its properties as described below.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | audioBufferByteLength : Number [read-only] Provides the Netstream audio buffer size informtion in bytes. | NetStreamInfo
|  | audioBufferLength : Number [read-only] Provides Netstream audio buffer size information in time (seconds). | NetStreamInfo
|  | audioByteCount : Number [read-only] Specifies the total audio bytes which have arrived into the queue regardless of how many have played or flushed. | NetStreamInfo
|  | audioBytesPerSecond : Number [read-only] Specifies the rate at which Netstream audio buffer is being filled in Bytes per second, calculated as a smooth average for the audio data received in the last second. | NetStreamInfo
|  | byteCount : Number [read-only] Specifies the total bytes which have arrived into the queue regardless of how many have played or flushed. | NetStreamInfo
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentBytesPerSecond : Number [read-only] Specifies the rate at which Netstream buffer is being filled in Bytes per second, calculated as a smooth average for the total data received in the last second. | NetStreamInfo
|  | dataBufferByteLength : Number [read-only] Provides the Netstream data buffer size informtion in bytes. | NetStreamInfo
|  | dataBufferLength : Number [read-only] Provides Netstream data buffer size information in time (seconds). | NetStreamInfo
|  | dataByteCount : Number [read-only] Specifies the total data messages bytes which have arrived into the queue regardless of how many have played or flushed. | NetStreamInfo
|  | dataBytesPerSecond : Number [read-only] Specifies the rate at which Netstream data buffer is being filled in Bytes per second, calculated as a smooth average for the data messages received in the last second. | NetStreamInfo
|  | droppedFrames : Number [read-only] Returns the number of video frames dropped in the current NetStream playback session. | NetStreamInfo
|  | playbackBytesPerSecond : Number [read-only] Returns the stream playback rate in Bytes Per Second. | NetStreamInfo
|  | prototype : Object [static] A reference to the prototype object of a class or function object. | Object
|  | SRTT : Number [read-only] Specifies the Smooth Round Trip Time for the NetStream session. | NetStreamInfo
|  | videoBufferByteLength : Number [read-only] Provides the Netstream video buffer size informtion in bytes. | NetStreamInfo
|  | videoBufferLength : Number [read-only] Provides Netstream video buffer size information in time (seconds). | NetStreamInfo
|  | videoByteCount : Number [read-only] Specifies the total video bytes which have arrived into the queue regardless of how many have played or flushed. | NetStreamInfo
|  | videoBytesPerSecond : Number [read-only] Specifies the rate at which Netstream video buffer is being filled in Bytes per second, calculated as a smooth average for the video data received in the last second. | NetStreamInfo

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NetStreamInfo(curBPS:Number, byteCount:Number, audioBPS:Number, audioByteCount:Number, videoBPS:Number, videoByteCount:Number, dataBPS:Number, dataByteCount:Number, playbackBPS:Number, droppedFrames:Number, audioBufferByteLength:Number, videoBufferByteLength:Number, dataBufferByteLength:Number, audioBufferLength:Number, videoBufferLength:Number, dataBufferLength:Number, srtt:Number) This is for internal use of the flash player only and should not be used. | NetStreamInfo
|  | 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
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

audioBufferByteLength | property

`audioBufferByteLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides the Netstream audio buffer size informtion in bytes. Similar to `Netstream.bytesLoaded` which is used in progressive cases this specifies buffer size in bytes for audio data for the streaming cases including live and recorded cases

Implementation
`public function get audioBufferByteLength():Number`

audioBufferLength | property |

`audioBufferLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides Netstream audio buffer size information in time (seconds). This property extends the `NetStream.bufferLength` property and provides the buffer length in time specifically for audio data.

Implementation
`public function get audioBufferLength():Number`

audioByteCount | property |

`audioByteCount:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the total audio bytes which have arrived into the queue regardless of how many have played or flushed. This value could also be used to also calculate the incoming audio data rate on a different granularity of time than the one provided by the `audioBytesPerSecond`above, by creating a timer with that granularity and calculating the difference in values in successive timer calls

Implementation
`public function get audioByteCount():Number`

audioBytesPerSecond | property |

`audioBytesPerSecond:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the rate at which Netstream audio buffer is being filled in Bytes per second, calculated as a smooth average for the audio data received in the last second.

Implementation
`public function get audioBytesPerSecond():Number`

byteCount | property |

`byteCount:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the total bytes which have arrived into the queue regardless of how many have played or flushed. This value could also be used to also calculate the incoming data rate on a different granularity of time than the one provided by the `currentBytesPerSecond`above, by creating a timer with that granularity and calculating the difference in values in successive timer calls

Implementation
`public function get byteCount():Number`

currentBytesPerSecond | property |

`currentBytesPerSecond:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the rate at which Netstream buffer is being filled in Bytes per second, calculated as a smooth average for the total data received in the last second.

Implementation
`public function get currentBytesPerSecond():Number`

dataBufferByteLength | property |

`dataBufferByteLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides the Netstream data buffer size informtion in bytes. Similar to `Netstream.bytesLoaded` which is used in progressive cases this specifies buffer size in bytes for data messages for the streaming cases including live and recorded cases

Implementation
`public function get dataBufferByteLength():Number`

dataBufferLength | property |

`dataBufferLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides Netstream data buffer size information in time (seconds). This property extends the `NetStream.bufferLength` property and provides the buffer length in time specifically for data messages besides audio and video.

Implementation
`public function get dataBufferLength():Number`

dataByteCount | property |

`dataByteCount:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the total data messages bytes which have arrived into the queue regardless of how many have played or flushed. This value could also be used to also calculate the incoming data messages rate on a different granularity of time than the one provided by the `dataBytesPerSecond`above, by creating a timer with that granularity and calculating the difference in values in successive timer calls

Implementation
`public function get dataByteCount():Number`

dataBytesPerSecond | property |

`dataBytesPerSecond:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the rate at which Netstream data buffer is being filled in Bytes per second, calculated as a smooth average for the data messages received in the last second.

Implementation
`public function get dataBytesPerSecond():Number`

droppedFrames | property |

`droppedFrames:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Returns the number of video frames dropped in the current NetStream playback session. In recorded streaming or progressive cases if the video is a high quality or high resolution high bit rate video, the decoder may lag behind in decoding the required number of frames per second if it does not have adequete system cpu resources. In Live streaming case the buffer drops out video frames to catch up if the latency gets high. This value gives that absolute number in such cases specifying the number of frames which were dropped and not presented normally.

Implementation
`public function get droppedFrames():Number`

playbackBytesPerSecond | property |

`playbackBytesPerSecond:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Returns the stream playback rate in Bytes Per Second. The playback buffer could have various playlists buffered in it. With dynamic stream switching this could happen more frequently. This property would provide the playback rate which would closely match the bit rate of the stream playing currently.

Implementation
`public function get playbackBytesPerSecond():Number`

SRTT | property |

`SRTT:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the Smooth Round Trip Time for the NetStream session. This value returns a valid value only for RTMFP streams and would return 0 for RTMP streams.

Implementation
`public function get SRTT():Number`

videoBufferByteLength | property |

`videoBufferByteLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides the Netstream video buffer size informtion in bytes. Similar to `Netstream.bytesLoaded` which is used in progressive cases this specifies buffer size in bytes for video data for the streaming cases including live and recorded cases

Implementation
`public function get videoBufferByteLength():Number`

videoBufferLength | property |

`videoBufferLength:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Provides Netstream video buffer size information in time (seconds). This property extends the `NetStream.bufferLength` property and provides the buffer length in time specifically for video data.

Implementation
`public function get videoBufferLength():Number`

videoByteCount | property |

`videoByteCount:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the total video bytes which have arrived into the queue regardless of how many have played or flushed. This value could also be used to also calculate the incoming video data rate on a different granularity of time than the one provided by the `videoBytesPerSecond`above, by creating a timer with that granularity and calculating the difference in values in successive timer calls

Implementation
`public function get videoByteCount():Number`

videoBytesPerSecond | property |

`videoBytesPerSecond:Number` [read-only]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the rate at which Netstream video buffer is being filled in Bytes per second, calculated as a smooth average for the video data received in the last second.

Implementation
`public function get videoBytesPerSecond():Number`
Constructor Detail

NetStreamInfo | () | Constructor

`public function NetStreamInfo(curBPS:Number, byteCount:Number, audioBPS:Number, audioByteCount:Number, videoBPS:Number, videoByteCount:Number, dataBPS:Number, dataByteCount:Number, playbackBPS:Number, droppedFrames:Number, audioBufferByteLength:Number, videoBufferByteLength:Number, dataBufferByteLength:Number, audioBufferLength:Number, videoBufferLength:Number, dataBufferLength:Number, srtt:Number)`

This is for internal use of the flash player only and should not be used. NetStreamInfo objects are only created by the player.

Parameters

| `curBPS:Number`
| `byteCount:Number`
| `audioBPS:Number`
| `audioByteCount:Number`
| `videoBPS:Number`
| `videoByteCount:Number`
| `dataBPS:Number`
| `dataByteCount:Number`
| `playbackBPS:Number`
| `droppedFrames:Number`
| `audioBufferByteLength:Number`
| `videoBufferByteLength:Number`
| `dataBufferByteLength:Number`
| `audioBufferLength:Number`
| `videoBufferLength:Number`
| `dataBufferLength:Number`
| `srtt:Number`

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00