BandwidthMeter

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

@UnstableApi
interface BandwidthMeter

Known direct subclasses

DefaultBandwidthMeter, ExperimentalBandwidthMeter

DefaultBandwidthMeter	Estimates bandwidth by listening to data transfers.
ExperimentalBandwidthMeter	An experimental BandwidthMeter that estimates bandwidth by listening to data transfers.

---

Provides estimates of the currently available bandwidth.

Summary

Nested types
interface BandwidthMeter.EventListener A listener of BandwidthMeter events.
class BandwidthMeter.EventListener.EventDispatcher Event dispatcher which allows listener registration.

Public functions
Unit	addEventListener(     eventHandler: Handler!,     eventListener: BandwidthMeter.EventListener! ) Adds an EventListener.
Long	getBitrateEstimate() Returns the estimated bitrate.
Long	getTimeToFirstByteEstimateUs() Returns the estimated time to first byte, in microseconds, or TIME_UNSET if no estimate is available.
TransferListener?	getTransferListener() Returns the TransferListener that this instance uses to gather bandwidth information from data transfers.
Unit	removeEventListener(eventListener: BandwidthMeter.EventListener!) Removes an EventListener.

Public functions

addEventListener

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

Adds an EventListener.

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

getBitrateEstimate

fun getBitrateEstimate(): Long

Returns the estimated bitrate.

getTimeToFirstByteEstimateUs

fun getTimeToFirstByteEstimateUs(): Long

Returns the estimated time to first byte, in microseconds, or TIME_UNSET if no estimate is available.

getTransferListener

fun getTransferListener(): TransferListener?

Returns the TransferListener that this instance uses to gather bandwidth information from data transfers. May be null if the implementation does not listen to data transfers.

removeEventListener

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

Removes an EventListener.

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