SeekMap

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
interface SeekMap

Known direct subclasses

BinarySearchSeeker.BinarySearchSeekMap, ChunkIndex, ConstantBitrateSeekMap, FlacSeekTableSeekMap, ForwardingSeekMap, IndexSeekMap, SeekMap.Unseekable, SingleSampleSeekMap, TrackAwareSeekMap

`BinarySearchSeeker.BinarySearchSeekMap`	A `SeekMap` implementation that returns the estimated byte location from `calculateNextSearchBytePosition` for each `getSeekPoints` query.
`ChunkIndex`	Defines chunks of samples within a media stream.
`ConstantBitrateSeekMap`	A `SeekMap` implementation that assumes the stream has a constant bitrate and consists of multiple independent frames of the same size.
`FlacSeekTableSeekMap`	A `SeekMap` implementation for FLAC streams that contain a seek table.
`ForwardingSeekMap`	A forwarding class for `SeekMap`
`IndexSeekMap`	A `SeekMap` implementation based on a mapping between times and positions in the input stream.
`SeekMap.Unseekable`	A `SeekMap` that does not support seeking.
`SingleSampleSeekMap`	A `SeekMap` implementation that maps the given point back onto itself.
`TrackAwareSeekMap`	A `SeekMap` that also allows seeking based on a specific track ID.

Maps seek positions (in microseconds) to corresponding positions (byte offsets) in the stream.

Summary

Nested types
`class SeekMap.SeekPoints` Contains one or two `SeekPoint`s.
`class SeekMap.Unseekable : SeekMap` A `SeekMap` that does not support seeking.

Public functions
`Long`	`getDurationUs()` Returns the duration of the stream in microseconds.
`SeekMap.SeekPoints!`	`getSeekPoints(timeUs: Long)` Obtains seek points for the specified seek time in microseconds.
`Boolean`	`isSeekable()` Returns whether seeking is supported.

Public functions

getDurationUs

fun getDurationUs(): Long

Returns the duration of the stream in microseconds.

Returns
`Long`	The duration of the stream in microseconds, or `TIME_UNSET` if the duration is unknown.

getSeekPoints

fun getSeekPoints(timeUs: Long): SeekMap.SeekPoints!

Obtains seek points for the specified seek time in microseconds. The returned SeekPoints will contain one or two distinct seek points.

Two seek points [A, B] are returned in the case that seeking can only be performed to discrete points in time, there does not exist a seek point at exactly the requested time, and there exist seek points on both sides of it. In this case A and B are the closest seek points before and after the requested time. A single seek point is returned in all other cases.

Parameters
`timeUs: Long`	A seek time in microseconds.

Returns
`SeekMap.SeekPoints!`	The corresponding seek points.

isSeekable

fun isSeekable(): Boolean

Returns whether seeking is supported.

Returns
`Boolean`	Whether seeking is supported.

SeekMap

Summary

Nested types

Public functions

Public functions

getDurationUs

getSeekPoints

isSeekable