Packageflash.net
Classpublic final class NetStreamInfo
InheritanceNetStreamInfo Inheritance Object

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


Public Properties
 PropertyDefined By
  audioBufferByteLength : Number
[read-only] Provides the NetStream audio buffer size in bytes.
NetStreamInfo
  audioBufferLength : Number
[read-only] Provides NetStream audio buffer size in seconds.
NetStreamInfo
  audioByteCount : Number
[read-only] Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed.
NetStreamInfo
  audioBytesPerSecond : Number
[read-only] Specifies the rate at which the NetStream audio buffer is filled in bytes per second.
NetStreamInfo
  audioLossRate : Number
[read-only] Specifies the audio loss for the NetStream session.
NetStreamInfo
  byteCount : Number
[read-only] Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed.
NetStreamInfo
 Inheritedconstructor : 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 the NetStream buffer is filled in bytes per second.
NetStreamInfo
  dataBufferByteLength : Number
[read-only] Provides the NetStream data buffer size in bytes.
NetStreamInfo
  dataBufferLength : Number
[read-only] Provides NetStream data buffer size in seconds.
NetStreamInfo
  dataByteCount : Number
[read-only] Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed.
NetStreamInfo
  dataBytesPerSecond : Number
[read-only] Specifies the rate at which the NetStream data buffer is filled in bytes per second.
NetStreamInfo
  droppedFrames : Number
[read-only] Returns the number of video frames dropped in the current NetStream playback session.
NetStreamInfo
  maxBytesPerSecond : Number
[read-only] Specifies the maximum rate at which the NetStream buffer is filled in bytes per second.
NetStreamInfo
  playbackBytesPerSecond : Number
[read-only] Returns the stream playback rate in bytes per second.
NetStreamInfo
 Inheritedprototype : 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 in bytes.
NetStreamInfo
  videoBufferLength : Number
[read-only] Provides NetStream video buffer size in seconds.
NetStreamInfo
  videoByteCount : Number
[read-only] Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed.
NetStreamInfo
  videoBytesPerSecond : Number
[read-only] Specifies the rate at which the NetStream video buffer is filled in bytes per second.
NetStreamInfo
Public Methods
 MethodDefined By
  
NetStreamInfo(curBPS:Number, byteCount:Number, maxBPS: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, audioLossRate:Number)
For internal use only; not recommended for use.
NetStreamInfo
 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 text value listing the properties of the NetStreamInfo object.
NetStreamInfo
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
audioBufferByteLengthproperty
audioBufferByteLength:Number  [read-only]

Provides the NetStream audio buffer size in bytes. It specifies the buffer size for audio data in streaming media, both live and recorded. This property is like Netstream.bytesLoaded, which is used in progressive downloads.



Implementation
    public function get audioBufferByteLength():Number
audioBufferLengthproperty 
audioBufferLength:Number  [read-only]

Provides NetStream audio buffer size in 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
audioByteCountproperty 
audioByteCount:Number  [read-only]

Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed. You can use this value to calculate the incoming audio data rate, using the metric of your choice, by creating a timer and calculating the difference in values in successive timer calls. Alternatively, use audioBytesPerSecond.



Implementation
    public function get audioByteCount():Number

See also

audioBytesPerSecond
audioBytesPerSecondproperty 
audioBytesPerSecond:Number  [read-only]

Specifies the rate at which the NetStream audio buffer is filled in bytes per second. The value is calculated as a smooth average for the audio data received in the last second.



Implementation
    public function get audioBytesPerSecond():Number
audioLossRateproperty 
audioLossRate:Number  [read-only]

Specifies the audio loss for the NetStream session. This value returns a valid value only for RTMFP streams and would return 0 for RTMP streams. Loss rate is defined as the ratio of lost messages to total messages.



Implementation
    public function get audioLossRate():Number
byteCountproperty 
byteCount:Number  [read-only]

Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed. You can use this value to calculate the incoming data rate, using the metric of your choice, by creating a timer and calculating the difference in values in successive timer calls. Alternatively, use currentBytesPerSecond.



Implementation
    public function get byteCount():Number

See also

currentBytesPerSecond
currentBytesPerSecondproperty 
currentBytesPerSecond:Number  [read-only]

Specifies the rate at which the NetStream buffer is filled in bytes per second. The value is calculated as a smooth average for the total data received in the last second.



Implementation
    public function get currentBytesPerSecond():Number
dataBufferByteLengthproperty 
dataBufferByteLength:Number  [read-only]

Provides the NetStream data buffer size in bytes. It specifies the buffer size for data messages in streaming media, both live and recorded. This property is like Netstream.bytesLoaded, which is used in progressive downloads.



Implementation
    public function get dataBufferByteLength():Number
dataBufferLengthproperty 
dataBufferLength:Number  [read-only]

Provides NetStream data buffer size in seconds. This property extends the NetStream.bufferLength property and provides the buffer length in time specifically for data messages.



Implementation
    public function get dataBufferLength():Number
dataByteCountproperty 
dataByteCount:Number  [read-only]

Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed. You can use this value to calculate the incoming data-messages rate, using the metric of your choice, by creating a timer and calculating the difference in values in successive timer calls. Alternatively, use dataBytesPerSecond.



Implementation
    public function get dataByteCount():Number

See also

dataBytesPerSecond
dataBytesPerSecondproperty 
dataBytesPerSecond:Number  [read-only]

Specifies the rate at which the NetStream data buffer is filled in bytes per second. The value is calculated as a smooth average for the data messages received in the last second.



Implementation
    public function get dataBytesPerSecond():Number
droppedFramesproperty 
droppedFrames:Number  [read-only]

Returns the number of video frames dropped in the current NetStream playback session.

In recorded streaming or progressive download, if the video is a high-quality or high-resolution, high-bitrate video, the decoder can lag behind in decoding the required number of frames per second if it does not have adequate system CPU resources. In live streaming, the buffer drops video frames if the latency is too high. This property specifies the number of frames that were dropped and not presented normally.



Implementation
    public function get droppedFrames():Number
maxBytesPerSecondproperty 
maxBytesPerSecond:Number  [read-only]

Specifies the maximum rate at which the NetStream buffer is filled in bytes per second. This value provides information about the capacity of the client network based on the last messages received by the NetStream object. Depending on the size of the buffer specified in NetStream.bufferTime and the bandwidth available on the client, Flash Media Server fills the buffer in bursts. This property provides the maximum rate at which the client buffer is filled.



Implementation
    public function get maxBytesPerSecond():Number
playbackBytesPerSecondproperty 
playbackBytesPerSecond:Number  [read-only]

Returns the stream playback rate in bytes per second. The playback buffer can contain content of various playlists. This property provides the playback rate that closely matches the bit rate of the currently playing stream.



Implementation
    public function get playbackBytesPerSecond():Number
SRTTproperty 
SRTT:Number  [read-only]

Specifies the Smooth Round Trip Time for the NetStream session. This value returns a valid value only for RTMFP streams and returns 0 for RTMP streams. For more information, see the Flash Media Server documentation.



Implementation
    public function get SRTT():Number
videoBufferByteLengthproperty 
videoBufferByteLength:Number  [read-only]

Provides the NetStream video buffer size in bytes. It specifies the buffer size for video data in streaming media, both live and recorded. This property is like Netstream.bytesLoaded, which is used in progressive downloads.



Implementation
    public function get videoBufferByteLength():Number
videoBufferLengthproperty 
videoBufferLength:Number  [read-only]

Provides NetStream video buffer size in 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
videoByteCountproperty 
videoByteCount:Number  [read-only]

Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed. You can use this value to calculate the incoming video data rate, using the metric of your choice, by creating a timer and calculating the difference in values in successive timer calls. Alternatively, use videoBytesPerSecond,



Implementation
    public function get videoByteCount():Number

See also

videoBytesPerSecond
videoBytesPerSecondproperty 
videoBytesPerSecond:Number  [read-only]

Specifies the rate at which the NetStream video buffer is filled in bytes per second. The value is 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, maxBPS: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, audioLossRate:Number)

For internal use only; not recommended for use. Only the runtime can create NetStreamInfo objects.

Parameters
curBPS:Number
 
byteCount:Number
 
maxBPS: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
 
audioLossRate:Number
Method Detail
toString()method
public function toString():String

Returns a text value listing the properties of the NetStreamInfo object.

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



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Aug 13 2009, 03:11 AM -07:00