LoadControl.Parameters

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

class LoadControl.Parameters

Information about the current playback context and the MediaPeriod for which LoadControl methods are called.

Summary

Public constructors
`Parameters( playerId: PlayerId!, timeline: Timeline!, mediaPeriodId: MediaSource.MediaPeriodId!, playbackPositionUs: Long, bufferedDurationUs: Long, playbackSpeed: Float, playWhenReady: Boolean, rebuffering: Boolean, targetLiveOffsetUs: Long, lastRebufferRealtimeMs: Long )` Creates parameters for `LoadControl` methods.

Public properties
`Long`	`bufferedDurationUs` The total duration of media that's currently buffered.
`Long`	`lastRebufferRealtimeMs` Sets the time at which the last rebuffering occurred, in milliseconds since boot including time spent in sleep.
`MediaSource.MediaPeriodId!`	`mediaPeriodId` The `MediaPeriodId` of the affected `MediaPeriod` in the current `timeline`.
`Boolean`	`playWhenReady` Whether playback should proceed when `STATE_READY`.
`Long`	`playbackPositionUs` The current playback position in microseconds, relative to the start of the affected `MediaPeriod` identified by `mediaPeriodId`.
`Float`	`playbackSpeed` The current factor by which playback is sped up.
`PlayerId!`	`playerId` The `ID of the player`.
`Boolean`	`rebuffering` Whether the player is rebuffering.
`Long`	`targetLiveOffsetUs` The desired playback position offset to the live edge in microseconds, or `TIME_UNSET` if the media is not a live stream or no offset is configured.
`Timeline!`	`timeline` The current `Timeline` of the player.

Public constructors

Parameters

Parameters(
    playerId: PlayerId!,
    timeline: Timeline!,
    mediaPeriodId: MediaSource.MediaPeriodId!,
    playbackPositionUs: Long,
    bufferedDurationUs: Long,
    playbackSpeed: Float,
    playWhenReady: Boolean,
    rebuffering: Boolean,
    targetLiveOffsetUs: Long,
    lastRebufferRealtimeMs: Long
)

Creates parameters for LoadControl methods.

Parameters
`playerId: PlayerId!`	See `playerId`.
`timeline: Timeline!`	See `timeline`.
`mediaPeriodId: MediaSource.MediaPeriodId!`	See `mediaPeriodId`.
`playbackPositionUs: Long`	See `playbackPositionUs`.
`bufferedDurationUs: Long`	See `bufferedDurationUs`.
`playbackSpeed: Float`	See `playbackSpeed`.
`playWhenReady: Boolean`	See `playWhenReady`.
`rebuffering: Boolean`	See `rebuffering`.
`targetLiveOffsetUs: Long`	See `targetLiveOffsetUs`.
`lastRebufferRealtimeMs: Long`	see `lastRebufferRealtimeMs`

Public properties

bufferedDurationUs

val bufferedDurationUs: Long

The total duration of media that's currently buffered.

lastRebufferRealtimeMs

val lastRebufferRealtimeMs: Long

Sets the time at which the last rebuffering occurred, in milliseconds since boot including time spent in sleep.

The time base used is the same as that measured by elapsedRealtime.

Note: If rebuffer events are not known when the load is started or continued, or if no rebuffering has occurred, or if there have been any user interactions such as seeking or stopping the player, the value will be set to TIME_UNSET.

mediaPeriodId

val mediaPeriodId: MediaSource.MediaPeriodId!

The MediaPeriodId of the affected MediaPeriod in the current timeline.

playWhenReady

val playWhenReady: Boolean

Whether playback should proceed when STATE_READY.

playbackPositionUs

val playbackPositionUs: Long

The current playback position in microseconds, relative to the start of the affected MediaPeriod identified by mediaPeriodId. If playback of this period has not yet started, the value will be negative and equal in magnitude to the duration of any media in previous periods still to be played.

playbackSpeed

val playbackSpeed: Float

The current factor by which playback is sped up.

playerId

val playerId: PlayerId!

The ID of the player.

rebuffering

val rebuffering: Boolean

Whether the player is rebuffering. A rebuffer is defined to be caused by buffer depletion rather than a user action. Hence this parameter is false during initial buffering and when buffering as a result of a seek operation.

targetLiveOffsetUs

val targetLiveOffsetUs: Long

The desired playback position offset to the live edge in microseconds, or TIME_UNSET if the media is not a live stream or no offset is configured.

timeline

val timeline: Timeline!

The current Timeline of the player.