| Package | flash.net |
| Class | public final class NetStreamInfo |
| Inheritance | NetStreamInfo  Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
NetStream.info call, which takes a snapshot of the current QOS state
and provides the QOS statistics through the NetStreamInfo properties.
Note: AIR 3.0 for iOS does not support any NetStreamInfo properties.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined 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 | ||
 | 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 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 | ||
| isLive : Boolean [read-only]
Returns whether the media being played is recorded or live. | NetStreamInfo | ||
| maxBytesPerSecond : Number [read-only]
Specifies the maximum rate at which the NetStream buffer is filled in bytes per second. | NetStreamInfo | ||
| metaData : Object [read-only]
Retrieve last meta data object associated with media being played. | 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 | |
| resourceName : String [read-only]
Return resource name used when NetStream.play() was called. | NetStreamInfo | ||
| SRTT : Number [read-only]
The smoothed round trip time (SRTT) for the NetStream session, in milliseconds. | NetStreamInfo | ||
| uri : String [read-only]
Return the URI used when NetConnection.connect() was called. | 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 | ||
| videoLossRate : Number [read-only]
Provides the NetStream video loss rate (ratio of lost messages to total messages). | NetStreamInfo | ||
| xmpData : Object [read-only]
Retrieve last XMP data object associated with media being played. | NetStreamInfo | ||
| Method | Defined By | ||
|---|---|---|---|
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
Returns a text value listing the properties of the NetStreamInfo object. | NetStreamInfo | ||
|
Returns the primitive value of the specified object. | Object | |
audioBufferByteLength | property |
audioBufferByteLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get audioBufferByteLength():NumberaudioBufferLength | property |
audioBufferLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get audioBufferLength():NumberaudioByteCount | property |
audioByteCount:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get audioByteCount():NumberRelated API Elements
audioBytesPerSecond | property |
audioBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get audioBytesPerSecond():NumberaudioLossRate | property |
audioLossRate:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 10, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get audioLossRate():NumberbyteCount | property |
byteCount:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get byteCount():NumberRelated API Elements
currentBytesPerSecond | property |
currentBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get currentBytesPerSecond():NumberdataBufferByteLength | property |
dataBufferByteLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get dataBufferByteLength():NumberdataBufferLength | property |
dataBufferLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get dataBufferLength():NumberdataByteCount | property |
dataByteCount:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get dataByteCount():NumberRelated API Elements
dataBytesPerSecond | property |
dataBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get dataBytesPerSecond():NumberdroppedFrames | property |
droppedFrames:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get droppedFrames():NumberisLive | property |
isLive:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.3, AIR 2.7 |
Returns whether the media being played is recorded or live. This property is relevant for RTMP streaming only. For progressive download and HTTP Dynamic Streaming the property is always false.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get isLive():BooleanmaxBytesPerSecond | property |
maxBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get maxBytesPerSecond():NumbermetaData | property |
playbackBytesPerSecond | property |
playbackBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get playbackBytesPerSecond():NumberresourceName | property |
resourceName:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.3, AIR 2.7 |
Return resource name used when NetStream.play() was called. This contains the full URL for progressive
download, resource name for RTMP streaming and null for HTTP streaming.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get resourceName():StringRelated API Elements
SRTT | property |
SRTT:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
The smoothed round trip time (SRTT) for the NetStream session, in milliseconds. This property contains a valid value only for RTMFP streams. For RTMP streams, the value is 0.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get SRTT():NumberRelated API Elements
uri | property |
uri:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.3, AIR 2.7 |
Return the URI used when NetConnection.connect() was called. This is null for progressive download
or HTTP streaming.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get uri():StringRelated API Elements
videoBufferByteLength | property |
videoBufferByteLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get videoBufferByteLength():NumbervideoBufferLength | property |
videoBufferLength:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get videoBufferLength():NumbervideoByteCount | property |
videoByteCount:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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,
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get videoByteCount():NumberRelated API Elements
videoBytesPerSecond | property |
videoBytesPerSecond:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
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.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get videoBytesPerSecond():NumbervideoLossRate | property |
videoLossRate:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Provides the NetStream video loss rate (ratio of lost messages to total messages).
When the message size is smaller than the maximum transmission unit (MTU), this value corresponds to the network packet loss rate.
This property returns a valid value only for RTMFP streams. For RTMP streams, it returns a value of zero. For more information, see the Flash Media Server documentation.
Note: Not supported in AIR 3.0 for iOS.
Implementation
public function get videoLossRate():NumberxmpData | property |
toString | () | method |
Mon Nov 28 2011, 06:48 AM -08:00