Package | flash.net |
Class | public final class NetStreamInfo |
Inheritance | NetStreamInfo Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
NetStream.info
call, which takes a snapshot of the current QOS state
and provides the QOS statistics through the NetStreamInfo 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 | ||
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 | ||
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 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 |
Method | Defined 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 | ||
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 |
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
audioBufferLength | property |
audioBufferLength:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
audioByteCount | property |
audioByteCount:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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 | property |
audioBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
audioLossRate | property |
audioLossRate:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 Flash Player 10 |
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
byteCount | property |
byteCount:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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 | property |
currentBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
dataBufferByteLength | property |
dataBufferByteLength:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
dataBufferLength | property |
dataBufferLength:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
dataByteCount | property |
dataByteCount:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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 | property |
dataBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
droppedFrames | property |
droppedFrames:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
maxBytesPerSecond | property |
maxBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
playbackBytesPerSecond | property |
playbackBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
SRTT | property |
SRTT:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
videoBufferByteLength | property |
videoBufferByteLength:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
videoBufferLength | property |
videoBufferLength:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
videoByteCount | property |
videoByteCount:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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 | property |
videoBytesPerSecond:Number
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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
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.
ParameterscurBPS: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 |
toString | () | method |
public function toString():String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns a text value listing the properties of the NetStreamInfo object.
ReturnsString — A string containing the values of the properties of the NetStreamInfo object
|
Fri Mar 19 2010, 02:45 AM -07:00