Package com.amazonaws.ivs.broadcast

Class TransmissionStats

java.lang.Object

com.amazonaws.ivs.broadcast.TransmissionStats

public class TransmissionStats
extends Object

TransmissionStats contains statistics on the broadcast's current measured bitrate, recommended bitrate by the SDK's adaptive bitrate algorithm, average round trip time, broadcast quality (relative to configured minimum and maximum bitrates), and network health. Expect this callback to be triggered on the BroadcastListener quite frequently (approximately twice per second) as the measured and recommended bitrates change. Measured versus recommended bitrate behavior can vary significantly between platforms. The documentation on each metric provides instructions on how to interpret these values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransmissionStats.BroadcastQuality	BroadcastQuality represents the quality of the stream based on the bitrate minimum and maximum provided on session configuration.
static enum	TransmissionStats.NetworkHealth	NetworkHealth represents the current health of the network.

Field Summary

Fields

Modifier and Type	Field	Description
final TransmissionStats.BroadcastQuality	broadcastQuality	The current BroadcastQuality.
final double	measuredBitrate	The current measured average sending bitrate.
final TransmissionStats.NetworkHealth	networkHealth	The current NetworkHealth.
final double	recommendedBitrate	The bitrate currently recommended by the SDK.
final double	roundTripTime	The current average round trip time for network packets (not image or audio samples).

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

recommendedBitrate

public final double recommendedBitrate

The bitrate currently recommended by the SDK. Depending on network conditions, the SDK may recommend a higher or lower bitrate to preserve the stability of the broadcast, within the constraints of the minimum, maximum, and initial bitrates configured by the application in BroadcastConfiguration.

measuredBitrate

public final double measuredBitrate

The current measured average sending bitrate. Note that the device's video encoder is often unable to match exactly the SDK's recommended bitrate. There can be some delay between the SDK's recommended bitrate and the video encoder responding to the recommendation.

roundTripTime

public final double roundTripTime

The current average round trip time for network packets (not image or audio samples).

broadcastQuality

public final TransmissionStats.BroadcastQuality broadcastQuality

The current BroadcastQuality.

networkHealth

public final TransmissionStats.NetworkHealth networkHealth

The current NetworkHealth.

Method Details

toString

@NonNull
public String toString()

Overrides:

toString in class Object