com.google.android.exoplayer2.upstream

Class DefaultBandwidthMeter

java.lang.Object

com.google.android.exoplayer2.upstream.DefaultBandwidthMeter

All Implemented Interfaces:

BandwidthMeter, TransferListener

public final class DefaultBandwidthMeter
extends java.lang.Object
implements BandwidthMeter, TransferListener

Estimates bandwidth by listening to data transfers.

The bandwidth estimate is calculated using a SlidingPercentile and is updated each time a transfer ends. The initial estimate is based on the current operator's network country code or the locale of the user, as well as the network connection type. This can be configured in the DefaultBandwidthMeter.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultBandwidthMeter.Builder Builder for a bandwidth meter.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.upstream.BandwidthMeter

BandwidthMeter.EventListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,int[]>	DEFAULT_INITIAL_BITRATE_COUNTRY_GROUPS Country groups used to determine the default initial bitrate estimate.
static long	DEFAULT_INITIAL_BITRATE_ESTIMATE Default initial bitrate estimate used when the device is offline or the network type cannot be determined, in bits per second.
static long[]	DEFAULT_INITIAL_BITRATE_ESTIMATES_2G Default initial 2G bitrate estimates in bits per second.
static long[]	DEFAULT_INITIAL_BITRATE_ESTIMATES_3G Default initial 3G bitrate estimates in bits per second.
static long[]	DEFAULT_INITIAL_BITRATE_ESTIMATES_4G Default initial 4G bitrate estimates in bits per second.
static long[]	DEFAULT_INITIAL_BITRATE_ESTIMATES_WIFI Default initial Wifi bitrate estimate in bits per second.
static int	DEFAULT_SLIDING_WINDOW_MAX_WEIGHT Default maximum weight for the sliding window.

Constructor Summary

Constructors

Constructor and Description
DefaultBandwidthMeter() Creates a bandwidth meter with default parameters.
DefaultBandwidthMeter(android.os.Handler eventHandler, BandwidthMeter.EventListener eventListener) Deprecated. Use DefaultBandwidthMeter.Builder instead.
DefaultBandwidthMeter(android.os.Handler eventHandler, BandwidthMeter.EventListener eventListener, int maxWeight) Deprecated. Use DefaultBandwidthMeter.Builder instead.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(android.os.Handler eventHandler, BandwidthMeter.EventListener eventListener) Adds an BandwidthMeter.EventListener to be informed of bandwidth samples.
long	getBitrateEstimate() Returns the estimated bandwidth in bits/sec.
TransferListener	getTransferListener() Returns the TransferListener that this instance uses to gather bandwidth information from data transfers.
void	onBytesTransferred(DataSource source, DataSpec dataSpec, boolean isNetwork, int bytes) Called incrementally during a transfer.
void	onTransferEnd(DataSource source, DataSpec dataSpec, boolean isNetwork) Called when a transfer ends.
void	onTransferInitializing(DataSource source, DataSpec dataSpec, boolean isNetwork) Called when a transfer is being initialized.
void	onTransferStart(DataSource source, DataSpec dataSpec, boolean isNetwork) Called when a transfer starts.
void	removeEventListener(BandwidthMeter.EventListener eventListener) Removes an BandwidthMeter.EventListener.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIAL_BITRATE_COUNTRY_GROUPS

public static final java.util.Map<java.lang.String,int[]> DEFAULT_INITIAL_BITRATE_COUNTRY_GROUPS

Country groups used to determine the default initial bitrate estimate. The group assignment for each country is an array of group indices for [Wifi, 2G, 3G, 4G].

DEFAULT_INITIAL_BITRATE_ESTIMATES_WIFI

public static final long[] DEFAULT_INITIAL_BITRATE_ESTIMATES_WIFI

Default initial Wifi bitrate estimate in bits per second.

DEFAULT_INITIAL_BITRATE_ESTIMATES_2G

public static final long[] DEFAULT_INITIAL_BITRATE_ESTIMATES_2G

Default initial 2G bitrate estimates in bits per second.

DEFAULT_INITIAL_BITRATE_ESTIMATES_3G

public static final long[] DEFAULT_INITIAL_BITRATE_ESTIMATES_3G

Default initial 3G bitrate estimates in bits per second.

DEFAULT_INITIAL_BITRATE_ESTIMATES_4G

public static final long[] DEFAULT_INITIAL_BITRATE_ESTIMATES_4G

Default initial 4G bitrate estimates in bits per second.

DEFAULT_INITIAL_BITRATE_ESTIMATE

public static final long DEFAULT_INITIAL_BITRATE_ESTIMATE

Default initial bitrate estimate used when the device is offline or the network type cannot be determined, in bits per second.

See Also:

Constant Field Values

DEFAULT_SLIDING_WINDOW_MAX_WEIGHT

public static final int DEFAULT_SLIDING_WINDOW_MAX_WEIGHT

Default maximum weight for the sliding window.

See Also:

Constant Field Values

Constructor Detail

DefaultBandwidthMeter

public DefaultBandwidthMeter()

Creates a bandwidth meter with default parameters.

DefaultBandwidthMeter

@Deprecated
public DefaultBandwidthMeter(android.os.Handler eventHandler,
                                         BandwidthMeter.EventListener eventListener)

Deprecated. Use DefaultBandwidthMeter.Builder instead.

DefaultBandwidthMeter

@Deprecated
public DefaultBandwidthMeter(android.os.Handler eventHandler,
                                         BandwidthMeter.EventListener eventListener,
                                         int maxWeight)

Deprecated. Use DefaultBandwidthMeter.Builder instead.

Method Detail

getBitrateEstimate

public long getBitrateEstimate()

Description copied from interface: BandwidthMeter

Returns the estimated bandwidth in bits/sec.

Specified by:

getBitrateEstimate in interface BandwidthMeter

getTransferListener

@Nullable
public TransferListener getTransferListener()

Description copied from interface: BandwidthMeter

Returns the TransferListener that this instance uses to gather bandwidth information from data transfers. May be null, if no transfer listener is used.

Specified by:

getTransferListener in interface BandwidthMeter

addEventListener

public void addEventListener(android.os.Handler eventHandler,
                             BandwidthMeter.EventListener eventListener)

Description copied from interface: BandwidthMeter

Adds an BandwidthMeter.EventListener to be informed of bandwidth samples.

Specified by:

addEventListener in interface BandwidthMeter

Parameters:

eventHandler - A handler for events.

eventListener - A listener of events.

removeEventListener

public void removeEventListener(BandwidthMeter.EventListener eventListener)

Description copied from interface: BandwidthMeter

Removes an BandwidthMeter.EventListener.

Specified by:

removeEventListener in interface BandwidthMeter

Parameters:

eventListener - The listener to be removed.

onTransferInitializing

public void onTransferInitializing(DataSource source,
                                   DataSpec dataSpec,
                                   boolean isNetwork)

Description copied from interface: TransferListener

Called when a transfer is being initialized.

Specified by:

onTransferInitializing in interface TransferListener

Parameters:

source - The source performing the transfer.

dataSpec - Describes the data for which the transfer is initialized.

isNetwork - Whether the data is transferred through a network.

onTransferStart

public void onTransferStart(DataSource source,
                            DataSpec dataSpec,
                            boolean isNetwork)

Description copied from interface: TransferListener

Called when a transfer starts.

Specified by:

onTransferStart in interface TransferListener

Parameters:

source - The source performing the transfer.

dataSpec - Describes the data being transferred.

isNetwork - Whether the data is transferred through a network.

onBytesTransferred

public void onBytesTransferred(DataSource source,
                               DataSpec dataSpec,
                               boolean isNetwork,
                               int bytes)

Description copied from interface: TransferListener

Called incrementally during a transfer.

Specified by:

onBytesTransferred in interface TransferListener

Parameters:

source - The source performing the transfer.

dataSpec - Describes the data being transferred.

isNetwork - Whether the data is transferred through a network.

bytes - The number of bytes transferred since the previous call to this method

onTransferEnd

public void onTransferEnd(DataSource source,
                          DataSpec dataSpec,
                          boolean isNetwork)

Description copied from interface: TransferListener

Called when a transfer ends.

Specified by:

onTransferEnd in interface TransferListener

Parameters:

source - The source performing the transfer.

dataSpec - Describes the data being transferred.

isNetwork - Whether the data is transferred through a network.