BandwidthEstimator

Kotlin |Java

@UnstableApi
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
`const Long`	`ESTIMATE_NOT_AVAILABLE = -9223372036854775808`

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

const val ESTIMATE_NOT_AVAILABLE = -9223372036854775808: Long

fun addEventListener(
    eventHandler: Handler!,
    eventListener: BandwidthMeter.EventListener!
): Unit

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

fun getBandwidthEstimate(): Long

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

fun onBytesTransferred(source: DataSource!, bytesTransferred: Int): Unit

Called incrementally during a transfer.

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

fun onNetworkTypeChange(newBandwidthEstimate: Long): Unit

Notifies this estimator that a network change has been detected.

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

fun onTransferEnd(source: DataSource!): Unit

Called when a transfer ends.

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

fun onTransferInitializing(source: DataSource!): Unit

Called when a transfer is being initialized.

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

fun onTransferStart(source: DataSource!): Unit

Called when a transfer starts.

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

fun removeEventListener(eventListener: BandwidthMeter.EventListener!): Unit

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