BandwidthEstimator

Kotlin |Java

@UnstableApi
public interface BandwidthEstimator

Known direct subclasses

`CombinedParallelSampleBandwidthEstimator`	A `BandwidthEstimator` that captures a transfer sample each time all parallel transfers end.
`SplitParallelSampleBandwidthEstimator`	A `BandwidthEstimator` that captures a transfer sample each time a transfer ends.

The interface for different bandwidth estimation strategies.

Summary

Constants
`default static final long`	`ESTIMATE_NOT_AVAILABLE = -9223372036854775808`

Public methods
`abstract void`	`addEventListener( Handler eventHandler, BandwidthMeter.EventListener eventListener )` Adds an `BandwidthMeter.EventListener`.
`abstract long`	`getBandwidthEstimate()` Returns the bandwidth estimate in bits per second, or `ESTIMATE_NOT_AVAILABLE` if there is no estimate available yet.
`abstract void`	`onBytesTransferred(DataSource source, int bytesTransferred)` Called incrementally during a transfer.
`abstract void`	`onNetworkTypeChange(long newBandwidthEstimate)` Notifies this estimator that a network change has been detected.
`abstract void`	`onTransferEnd(DataSource source)` Called when a transfer ends.
`abstract void`	`onTransferInitializing(DataSource source)` Called when a transfer is being initialized.
`abstract void`	`onTransferStart(DataSource source)` Called when a transfer starts.
`abstract void`	`removeEventListener(BandwidthMeter.EventListener eventListener)` Removes an `BandwidthMeter.EventListener`.

default static final long ESTIMATE_NOT_AVAILABLE = -9223372036854775808

abstract void addEventListener(
    Handler eventHandler,
    BandwidthMeter.EventListener eventListener
)

Parameters
`Handler eventHandler`	A handler for events.
`BandwidthMeter.EventListener eventListener`	A listener of events.

abstract long getBandwidthEstimate()

Returns the bandwidth estimate in bits per second, or ESTIMATE_NOT_AVAILABLE if there is no estimate available yet.

abstract void onBytesTransferred(DataSource source, int bytesTransferred)

Called incrementally during a transfer.

Parameters
`DataSource source`	The `DataSource` performing the transfer.
`int bytesTransferred`	The number of bytes transferred since the previous call to this method

abstract void onNetworkTypeChange(long newBandwidthEstimate)

Notifies this estimator that a network change has been detected.

Parameters
`long newBandwidthEstimate`	The new initial bandwidth estimate based on network type.

abstract void onTransferEnd(DataSource source)

Called when a transfer ends.

Parameters
`DataSource source`	The `DataSource` performing the transfer.

abstract void onTransferInitializing(DataSource source)

Called when a transfer is being initialized.

Parameters
`DataSource source`	The `DataSource` performing the transfer.

abstract void onTransferStart(DataSource source)

Called when a transfer starts.

Parameters
`DataSource source`	The `DataSource` performing the transfer.

abstract void removeEventListener(BandwidthMeter.EventListener eventListener)

Parameters
`BandwidthMeter.EventListener eventListener`	The listener to be removed.