# PercentileTimeToFirstByteEstimator

# PercentileTimeToFirstByteEstimator

Artifact:[androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3)  
[View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator.java+class:androidx.media3.exoplayer.upstream.experimental.PercentileTimeToFirstByteEstimator)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator "View this page in Java")

<br />

```
@UnstableApi
class PercentileTimeToFirstByteEstimator : TimeToFirstByteEstimator
```

<br />

*** ** * ** ***

Implementation of[TimeToFirstByteEstimator](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/TimeToFirstByteEstimator)that returns a configured percentile of a sliding window of collected response times.

## Summary

|                                      ### Constants                                      |
|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)     | [DEFAULT_MAX_SAMPLES_COUNT](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_MAX_SAMPLES_COUNT())` = 10` The default maximum number of samples. |
| `const `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [DEFAULT_PERCENTILE](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_PERCENTILE())` = 0.5f` The default percentile to return.                  |

|                                                                                                                                                                                                                                                                                                                    ### Public constructors                                                                                                                                                                                                                                                                                                                    |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [PercentileTimeToFirstByteEstimator](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#PercentileTimeToFirstByteEstimator())`()` Creates an instance that keeps up to[DEFAULT_MAX_SAMPLES_COUNT](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_MAX_SAMPLES_COUNT())samples and returns the[DEFAULT_PERCENTILE](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_PERCENTILE())percentile. |
| [PercentileTimeToFirstByteEstimator](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#PercentileTimeToFirstByteEstimator(int,float))`(` ` numberOfSamples: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` percentile: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) `)` Creates an instance.                                                                                                                                                                                                           |

|                             ### Public functions                              |
|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getTimeToFirstByteEstimateUs](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#getTimeToFirstByteEstimateUs())`()` Returns the estimated time to first byte of the response body, in microseconds, or[TIME_UNSET](https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET())if no estimate is available. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onTransferInitializing](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#onTransferInitializing(androidx.media3.datasource.DataSpec))`(dataSpec: `[DataSpec](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec)`!)` Called when a transfer is being initialized.                                   |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onTransferStart](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#onTransferStart(androidx.media3.datasource.DataSpec))`(dataSpec: `[DataSpec](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec)`!)` Called when a transfer starts.                                                               |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [reset](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#reset())`()` Resets the estimator.                                                                                                                                                                                                                                          |

## Constants

### DEFAULT_MAX_SAMPLES_COUNT

```
const val DEFAULT_MAX_SAMPLES_COUNT = 10: Int
```

The default maximum number of samples.  

### DEFAULT_PERCENTILE

```
const val DEFAULT_PERCENTILE = 0.5f: Float
```

The default percentile to return.  

## Public constructors

### PercentileTimeToFirstByteEstimator

```
PercentileTimeToFirstByteEstimator()
```

Creates an instance that keeps up to[DEFAULT_MAX_SAMPLES_COUNT](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_MAX_SAMPLES_COUNT())samples and returns the[DEFAULT_PERCENTILE](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/experimental/PercentileTimeToFirstByteEstimator#DEFAULT_PERCENTILE())percentile.  

### PercentileTimeToFirstByteEstimator

```
PercentileTimeToFirstByteEstimator(
    numberOfSamples: Int,
    percentile: Float
)
```

Creates an instance.  

|                                           Parameters                                           |
|------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| `numberOfSamples: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The maximum number of samples to be kept in the sliding window. |
| `percentile: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)  | The percentile for estimating the time to the first byte.       |

## Public functions

### getTimeToFirstByteEstimateUs

```
fun getTimeToFirstByteEstimateUs(): Long
```

Returns the estimated time to first byte of the response body, in microseconds, or[TIME_UNSET](https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET())if no estimate is available.  

### onTransferInitializing

```
fun onTransferInitializing(dataSpec: DataSpec!): Unit
```

Called when a transfer is being initialized.  

|                                                  Parameters                                                   |
|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
| `dataSpec: `[DataSpec](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec)`!` | Describes the data for which the transfer is initialized. |

### onTransferStart

```
fun onTransferStart(dataSpec: DataSpec!): Unit
```

Called when a transfer starts.  

|                                                  Parameters                                                   |
|---------------------------------------------------------------------------------------------------------------|---------------------------------------|
| `dataSpec: `[DataSpec](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec)`!` | Describes the data being transferred. |

### reset

```
fun reset(): Unit
```

Resets the estimator.