BinarySearchSeeker

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
abstract class BinarySearchSeeker

A seeker that supports seeking within a stream by searching for the target frame using binary search.

This seeker operates on a stream that contains multiple frames (or samples). Each frame is associated with some kind of timestamps, such as stream time, or frame indices. Given a target seek time, the seeker will find the corresponding target timestamp, and perform a search operation within the stream to identify the target frame and return the byte position in the stream of the target frame.

Summary

Nested types
`class BinarySearchSeeker.BinarySearchSeekMap : SeekMap` A `SeekMap` implementation that returns the estimated byte location from `calculateNextSearchBytePosition` for each `getSeekPoints` query.
`class BinarySearchSeeker.DefaultSeekTimestampConverter : BinarySearchSeeker.SeekTimestampConverter` A `SeekTimestampConverter` implementation that returns the seek time itself as the timestamp for a seek time position.
`protected class BinarySearchSeeker.SeekOperationParams` Contains parameters for a pending seek operation by `BinarySearchSeeker`.
`protected interface BinarySearchSeeker.SeekTimestampConverter` A converter that converts seek time in stream time into target timestamp for the `BinarySearchSeeker`.
`class BinarySearchSeeker.TimestampSearchResult` Represents possible search results for `searchForTimestamp`.
`protected interface BinarySearchSeeker.TimestampSeeker` A seeker that looks for a given timestamp from an input.

Protected constructors
`BinarySearchSeeker( seekTimestampConverter: BinarySearchSeeker.SeekTimestampConverter!, timestampSeeker: BinarySearchSeeker.TimestampSeeker!, durationUs: Long, floorTimePosition: Long, ceilingTimePosition: Long, floorBytePosition: Long, ceilingBytePosition: Long, approxBytesPerFrame: Long, minimumSearchRange: Int )` Constructs an instance.

Public functions
`SeekMap!`	`getSeekMap()` Returns the seek map for the stream.
`Int`	`handlePendingSeek( input: ExtractorInput!, seekPositionHolder: PositionHolder! )` Continues to handle the pending seek operation.
`Boolean`	`isSeeking()` Returns whether the last operation set by `setSeekTargetUs` is still pending.
`Unit`	`setSeekTargetUs(timeUs: Long)` Sets the target time in microseconds within the stream to seek to.

Protected functions
`BinarySearchSeeker.SeekOperationParams!`	`createSeekParamsForTargetTimeUs(timeUs: Long)`
`Unit`	`markSeekOperationFinished( foundTargetFrame: Boolean, resultPosition: Long )`
`Unit`	`onSeekOperationFinished(foundTargetFrame: Boolean, resultPosition: Long)`
`Int`	`seekToPosition( input: ExtractorInput!, position: Long, seekPositionHolder: PositionHolder! )`
`Boolean`	`skipInputUntilPosition(input: ExtractorInput!, position: Long)`

Protected properties
`BinarySearchSeeker.BinarySearchSeekMap!`	`seekMap`
`BinarySearchSeeker.SeekOperationParams?`	`seekOperationParams`
`BinarySearchSeeker.TimestampSeeker!`	`timestampSeeker`

Protected constructors