ContentSteeringTracker

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
interface ContentSteeringTracker

Known direct subclasses

HlsContentSteeringTracker

HlsContentSteeringTracker

Tracks the content steering states for an HLS stream.

Tracks the content steering states for an adaptive stream.

Summary

Public functions
`Boolean`	`excludeCurrentPathway(excludeDurationMs: Long)` Excludes the current pathway for the given duration, in milliseconds.
`Boolean`	`isActive()` Returns whether the `ContentSteeringTracker` is active.
`Unit`	`start( initialSteeringManifestUri: Uri!, initialPathwayId: String?, eventDispatcher: MediaSourceEventListener.EventDispatcher! )` Starts the `ContentSteeringTracker`.
`Unit`	`stop()` Stops the `ContentSteeringTracker`.

Public functions

excludeCurrentPathway

fun excludeCurrentPathway(excludeDurationMs: Long): Boolean

Excludes the current pathway for the given duration, in milliseconds.

Parameters
`excludeDurationMs: Long`	The duration for which to exclude the current pathway.

Returns
`Boolean`	Whether the exclusion was successful.

isActive

fun isActive(): Boolean

Returns whether the ContentSteeringTracker is active.

If this method returns false, the caller of the ContentSteeringTracker should behave as if content steering is absent.

start

fun start(
    initialSteeringManifestUri: Uri!,
    initialPathwayId: String?,
    eventDispatcher: MediaSourceEventListener.EventDispatcher!
): Unit

Starts the ContentSteeringTracker.

Parameters
`initialSteeringManifestUri: Uri!`	The initial `Uri` of the steering manifest.
`initialPathwayId: String?`	The ID of the initial pathway to use before the first steering manifest is loaded, or `null` to allow the tracker to pick any available pathway before the first steering manifest is loaded.
`eventDispatcher: MediaSourceEventListener.EventDispatcher!`	A `MediaSourceEventListener.EventDispatcher` for reporting load events.

stop

fun stop(): Unit

Stops the ContentSteeringTracker.