com.smaxe.uv.client.rtmfp

Class NetStreamInfo

java.lang.Object

com.smaxe.uv.client.rtmfp.NetStreamInfo

public abstract class NetStreamInfo
extends java.lang.Object

NetStreamInfo - specifies the various Quality of Service (QOS) statistics and other information 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.

Version:

2.0.0

Author:

Andrei Sochirca

See Also:

JUV RTMFP Client

Constructor Summary

Constructors

Constructor and Description
NetStreamInfo()

Method Summary

Methods

Modifier and Type	Method and Description
long	audioBufferByteLength() Provides the NetStream audio buffer size in bytes.
long	audioBufferLength() Provides NetStream audio buffer size in seconds.
long	audioByteCount() Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed.
long	audioBytesPerSecond() Specifies the rate at which the NetStream audio buffer is filled in bytes per second.
long	audioLossRate() Specifies the audio loss for the NetStream session.
long	byteCount() Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed.
long	currentBytesPerSecond() Specifies the rate at which the NetStream buffer is filled in bytes per second.
long	dataBufferByteLength() Provides the NetStream data buffer size in bytes.
long	dataBufferLength() Provides NetStream data buffer size in seconds.
long	dataByteCount() Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed.
long	dataBytesPerSecond() Specifies the rate at which the NetStream data buffer is filled in bytes per second.
long	droppedFrames() Returns the number of video frames dropped in the current NetStream playback session.
boolean	isLive() Whether the media being played is recorded or live.
long	maxBytesPerSecond() Specifies the maximum rate at which the NetStream buffer is filled in bytes per second.
java.lang.Object	metaData() The most recent metadata object associated with the media being played.
long	playbackBytesPerSecond() Returns the stream playback rate in bytes per second.
java.lang.String	resourceName() The resource name used when NetStream.play() was called.
long	SRTT() The smoothed round trip time (SRTT) for the NetStream session, in milliseconds.
java.lang.String	uri() The URI used when NetConnection.connect() was called.
long	videoBufferByteLength() Provides the NetStream video buffer size in bytes.
long	videoBufferLength() Provides NetStream video buffer size in seconds.
long	videoByteCount() Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed.
long	videoBytesPerSecond() Specifies the rate at which the NetStream video buffer is filled in bytes per second.
long	videoLossRate() Provides the NetStream video loss rate (ratio of lost messages to total messages).
java.lang.Object	xmpData() The most recent XMP data object associated with the media being played.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetStreamInfo

public NetStreamInfo()

Method Detail

audioBufferByteLength

public long audioBufferByteLength()

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.

Returns:

length

audioBufferLength

public long audioBufferLength()

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.

Returns:

length

audioByteCount

public long audioByteCount()

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.

Returns:

total number of audio bytes that have arrived in the queue

audioBytesPerSecond

public long audioBytesPerSecond()

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.

Returns:

rate at which the NetStream audio buffer is filled in bytes per second

audioLossRate

public long audioLossRate()

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.

Returns:

audio loss for the NetStream session

byteCount

public long byteCount()

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.

Returns:

total number of bytes that have arrived into the queue

currentBytesPerSecond

public long currentBytesPerSecond()

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.

Returns:

rate at which the NetStream buffer is filled in bytes per second

dataBufferByteLength

public long dataBufferByteLength()

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.

Returns:

NetStream data buffer size in bytes

dataBufferLength

public long dataBufferLength()

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.

Returns:

data buffer size in seconds

dataByteCount

public long dataByteCount()

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.

Returns:

total number of bytes of data messages that have arrived in the queue

dataBytesPerSecond

public long dataBytesPerSecond()

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.

Returns:

rate at which the NetStream data buffer is filled in bytes per second

droppedFrames

public long droppedFrames()

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.

Returns:

number of video frames dropped in the current NetStream playback session

isLive

public boolean isLive()

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.

Returns:

is recorded or live stream flag

maxBytesPerSecond

public long maxBytesPerSecond()

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.

Returns:

maximum rate at which the NetStream buffer is filled in bytes per second

metaData

public java.lang.Object metaData()

The most recent metadata object associated with the media being played.

Returns:

most recent metadata object

playbackBytesPerSecond

public long playbackBytesPerSecond()

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.

Returns:

stream playback rate in bytes per second

resourceName

public java.lang.String resourceName()

The resource name used when NetStream.play() was called. This property contains the full URL for progressive download, the resource name for RTMP streaming and null for HTTP streaming.

Returns:

resource name

SRTT

public long SRTT()

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.

Returns:

smoothed round trip time

uri

public java.lang.String uri()

The URI used when NetConnection.connect() was called. This is null for progressive download or HTTP streaming.

Returns:

uri

videoBufferByteLength

public long videoBufferByteLength()

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.

Returns:

video buffer size in bytes

videoBufferLength

public long videoBufferLength()

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.

Returns:

video buffer size in seconds

videoByteCount

public long videoByteCount()

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.

Returns:

total number of video bytes that have arrived in the queue

videoBytesPerSecond

public long videoBytesPerSecond()

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.

Returns:

rate at which the NetStream video buffer is filled in bytes per second

videoLossRate

public long videoLossRate()

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.

Returns:

video loss rate

xmpData

public java.lang.Object xmpData()

The most recent XMP data object associated with the media being played.

Returns:

most recent XMP data object