> Documentation index: https://developer.android.com/reference/llms.txt

# ClippingMediaPeriod

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

*** ** * ** ***


```
@UnstableApi
class ClippingMediaPeriod : MediaPeriod, MediaPeriod.Callback
```

<br />

*** ** * ** ***

Wraps a `MediaPeriod` and clips its `SampleStream`s to provide a subsequence of their samples.

## Summary

| ### Public constructors |
|---|
| `ClippingMediaPeriod( mediaPeriod: MediaPeriod!, enableInitialDiscontinuity: Boolean, startUs: Long, endUs: Long )` Creates a new clipping media period that provides a clipped view of the specified `MediaPeriod`'s sample streams. |
| `@ExperimentalApi ClippingMediaPeriod( mediaPeriod: MediaPeriod!, enableInitialDiscontinuity: Boolean, startUs: Long, endUs: Long, enableClippingInMediaPeriod: Boolean )` Creates a new clipping media period that provides a clipped view of the specified `MediaPeriod`'s sample streams. |

| ### Public functions |
|---|---|
| `Boolean` | `continueLoading(loadingInfo: LoadingInfo!)` Attempts to continue loading. |
| `Unit` | `discardBuffer(positionUs: Long, toKeyframe: Boolean)` Discards buffered media up to the specified position. |
| `Long` | `getAdjustedSeekPositionUs( positionUs: Long, seekParameters: SeekParameters! )` Returns the position to which a seek will be performed, given the specified seek position and `SeekParameters`. |
| `Long` | `getBufferedPositionUs()` Returns an estimate of the position up to which data is buffered for the enabled tracks. |
| `Long` | `getNextLoadPositionUs()` Returns the next load time, or `TIME_END_OF_SOURCE` if loading has finished. |
| `(Mutable)List<StreamKey!>!` | `getStreamKeys(trackSelections: (Mutable)List<ExoTrackSelection!>!)` Returns a list of `StreamKeys` which allow to filter the media in this period to load only the parts needed to play the provided `TrackSelections`. |
| `TrackGroupArray!` | `getTrackGroups()` Returns the `TrackGroup`s exposed by the period. |
| `Boolean` | `isLoading()` Returns whether the media period is currently loading. |
| `Unit` | `maybeThrowPrepareError()` Throws an error that's preventing the period from becoming prepared. |
| `Unit` | `onContinueLoadingRequested(source: MediaPeriod!)` Called by the loader to indicate that it wishes for its `continueLoading` method to be called when it can continue to load data. |
| `Unit` | `onPrepared(mediaPeriod: MediaPeriod!)` Called when preparation completes. |
| `Unit` | `prepare(callback: MediaPeriod.Callback!, positionUs: Long)` Prepares this media period asynchronously. |
| `Long` | `readDiscontinuity()` Attempts to read a discontinuity. |
| `Unit` | `reevaluateBuffer(positionUs: Long)` Re-evaluates the buffer given the playback position. |
| `Long` | `seekToUs(positionUs: Long)` Attempts to seek to the specified position in microseconds. |
| `Long` | `selectTracks( selections: Array<ExoTrackSelection?>?, mayRetainStreamFlags: BooleanArray<Boolean>!, streams: Array<SampleStream?>?, streamResetFlags: BooleanArray<Boolean>!, positionUs: Long )` Performs a track selection. |
| `Unit` | `setClippingError( clippingError: ClippingMediaSource.IllegalClippingException! )` Sets a clipping error detected by the media source so that it can be thrown as a period error at the next opportunity. |
| `Unit` | `setUsesStreamPrerollFlags()` Notifies the media period that the player will use `getFlags` to check if streams contain initial discontinuities at the start of the period rather than using `readDiscontinuity`. |
| `Boolean` | `supportsStreamPrerollFlags()` Returns whether this media period supports reporting initial discontinuities via `getFlags`. |
| `Unit` | `updateClipping(startUs: Long, endUs: Long)` Updates the clipping start/end times for this period, in microseconds. |

| ### Public properties |
|---|---|
| `MediaPeriod!` | `mediaPeriod` The `MediaPeriod` wrapped by this clipping media period. |

### Inherited functions

From [androidx.media3.exoplayer.source.MediaPeriod](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaPeriod.md.txt) `Long` `setEndPositionUs(endPositionUs: Long)`

Sets the end position at which the period stops loading and providing samples.

## Public constructors

### ClippingMediaPeriod

```
ClippingMediaPeriod(
    mediaPeriod: MediaPeriod!,
    enableInitialDiscontinuity: Boolean,
    startUs: Long,
    endUs: Long
)
```

Creates a new clipping media period that provides a clipped view of the specified `MediaPeriod`'s sample streams.

If the start point is guaranteed to be a key frame, pass `false` to `
enableInitialPositionDiscontinuity` to suppress an initial discontinuity when the period is first read from.

| Parameters |
|---|---|
| `mediaPeriod: MediaPeriod!` | The media period to clip. |
| `enableInitialDiscontinuity: Boolean` | Whether the initial discontinuity should be enabled. |
| `startUs: Long` | The clipping start time, in microseconds. |
| `endUs: Long` | The clipping end time, in microseconds, or `TIME_END_OF_SOURCE` to indicate the end of the period. |

### ClippingMediaPeriod

```
@ExperimentalApi
ClippingMediaPeriod(
    mediaPeriod: MediaPeriod!,
    enableInitialDiscontinuity: Boolean,
    startUs: Long,
    endUs: Long,
    enableClippingInMediaPeriod: Boolean
)
```

Creates a new clipping media period that provides a clipped view of the specified `MediaPeriod`'s sample streams.

If the start point is guaranteed to be a key frame, pass `false` to `
enableInitialDiscontinuity` to suppress an initial discontinuity when a period is first read from.

| Parameters |
|---|---|
| `mediaPeriod: MediaPeriod!` | The media period to clip. |
| `enableInitialDiscontinuity: Boolean` | Whether the initial discontinuity should be enabled. |
| `startUs: Long` | The clipping start time, in microseconds. |
| `endUs: Long` | The clipping end time, in microseconds, or `TIME_END_OF_SOURCE` to indicate the end of the period. |
| `enableClippingInMediaPeriod: Boolean` | Whether to delegate end-position clipping to `MediaPeriod` instances. |

## Public functions

### continueLoading

```
fun continueLoading(loadingInfo: LoadingInfo!): Boolean
```

Attempts to continue loading.

This method may be called both during and after the period has been prepared.

A period may call `onContinueLoadingRequested` on the `Callback` passed to `prepare` to request that this method be called when the period is permitted to continue loading data. A period may do this both during and after preparation.

| Parameters |
|---|---|
| `loadingInfo: LoadingInfo!` | The `LoadingInfo` when attempting to continue loading. |

| Returns |
|---|---|
| `Boolean` | True if progress was made, meaning that `getNextLoadPositionUs` will return a different value than prior to the call. False otherwise. |

### discardBuffer

```
fun discardBuffer(positionUs: Long, toKeyframe: Boolean): Unit
```

Discards buffered media up to the specified position.

This method is only called after the period has been prepared.

| Parameters |
|---|---|
| `positionUs: Long` | The position in microseconds. |
| `toKeyframe: Boolean` | If true then for each track discards samples up to the keyframe before or at the specified position, rather than any sample before or at that position. |

### getAdjustedSeekPositionUs

```
fun getAdjustedSeekPositionUs(
    positionUs: Long,
    seekParameters: SeekParameters!
): Long
```

Returns the position to which a seek will be performed, given the specified seek position and `SeekParameters`.

This method is only called after the period has been prepared.

| Parameters |
|---|---|
| `positionUs: Long` | The seek position in microseconds. |
| `seekParameters: SeekParameters!` | Parameters that control how the seek is performed. Implementations may apply seek parameters on a best effort basis. |

| Returns |
|---|---|
| `Long` | The actual position to which a seek will be performed, in microseconds. |

### getBufferedPositionUs

```
fun getBufferedPositionUs(): Long
```

Returns an estimate of the position up to which data is buffered for the enabled tracks.

This method is only called when at least one track is selected.

| Returns |
|---|---|
| `Long` | An estimate of the absolute position in microseconds up to which data is buffered, or `TIME_END_OF_SOURCE` if the track is fully buffered. |

### getNextLoadPositionUs

```
fun getNextLoadPositionUs(): Long
```

Returns the next load time, or `TIME_END_OF_SOURCE` if loading has finished.

This method is only called after the period has been prepared. It may be called when no tracks are selected.

### getStreamKeys

```
fun getStreamKeys(trackSelections: (Mutable)List<ExoTrackSelection!>!): (Mutable)List<StreamKey!>!
```

Returns a list of `StreamKeys` which allow to filter the media in this period to load only the parts needed to play the provided `TrackSelections`.

This method is only called after the period has been prepared.

| Parameters |
|---|---|
| `trackSelections: (Mutable)List<ExoTrackSelection!>!` | The `TrackSelections` describing the tracks for which stream keys are requested. |

| Returns |
|---|---|
| `(Mutable)List<StreamKey!>!` | The corresponding `StreamKeys` for the selected tracks, or an empty list if filtering is not possible and the entire media needs to be loaded to play the selected tracks. |

### getTrackGroups

```
fun getTrackGroups(): TrackGroupArray!
```

Returns the `TrackGroup`s exposed by the period.

This method is only called after the period has been prepared.

| Returns |
|---|---|
| `TrackGroupArray!` | The `TrackGroup`s. |

### isLoading

```
fun isLoading(): Boolean
```

Returns whether the media period is currently loading.

### maybeThrowPrepareError

```
fun maybeThrowPrepareError(): Unit
```

Throws an error that's preventing the period from becoming prepared. Does nothing if no such error exists.

This method is only called before the period has completed preparation.

| Throws |
|---|---|
| `java.io.IOException` | The underlying error. |

### onContinueLoadingRequested

```
fun onContinueLoadingRequested(source: MediaPeriod!): Unit
```

Called by the loader to indicate that it wishes for its `continueLoading` method to be called when it can continue to load data. Called on the playback thread.

### onPrepared

```
fun onPrepared(mediaPeriod: MediaPeriod!): Unit
```

Called when preparation completes.

Called on the playback thread. After invoking this method, the `MediaPeriod` can expect for `selectTracks` to be called with the initial track selection.

| Parameters |
|---|---|
| `mediaPeriod: MediaPeriod!` | The prepared `MediaPeriod`. |

### prepare

```
fun prepare(callback: MediaPeriod.Callback!, positionUs: Long): Unit
```

Prepares this media period asynchronously.

`callback.onPrepared` is called when preparation completes. If preparation fails, `maybeThrowPrepareError` will throw an `IOException`.

If preparation succeeds and results in a source timeline change (e.g. the period duration becoming known), `onSourceInfoRefreshed` will be called before `callback.onPrepared`.

| Parameters |
|---|---|
| `callback: MediaPeriod.Callback!` | Callback to receive updates from this period, including being notified when preparation completes. |
| `positionUs: Long` | The expected starting position, in microseconds. |

### readDiscontinuity

```
fun readDiscontinuity(): Long
```

Attempts to read a discontinuity.

A discontinuity implies that the provided `SampleStreams` will start from a new playback position and any output pipelines need to be reset. This happens for example if the streams provide decode-only samples before the intended playback start position that need to be dropped.

After this method has returned a value other than `TIME_UNSET`, all ` SampleStreams` provided by the period are guaranteed to start from a key frame.

This method is only called after the period has been prepared.

| Returns |
|---|---|
| `Long` | The playback position after the discontinuity, in microseconds, or `TIME_UNSET` if there is no discontinuity. |

### reevaluateBuffer

```
fun reevaluateBuffer(positionUs: Long): Unit
```

Re-evaluates the buffer given the playback position.

This method is only called after the period has been prepared.

A period may choose to discard buffered media or cancel ongoing loads so that media can be re-buffered in a different quality.

| Parameters |
|---|---|
| `positionUs: Long` | The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position in this period minus the duration of any media in previous periods still to be played. |

### seekToUs

```
fun seekToUs(positionUs: Long): Long
```

Attempts to seek to the specified position in microseconds.

After this method has been called, all `SampleStream`s provided by the period are guaranteed to start from a key frame.

This method is only called when at least one track is selected.

| Parameters |
|---|---|
| `positionUs: Long` | The seek position in microseconds. |

| Returns |
|---|---|
| `Long` | The actual position to which the period was seeked, in microseconds. |

### selectTracks

```
fun selectTracks(
    selections: Array<ExoTrackSelection?>?,
    mayRetainStreamFlags: BooleanArray<Boolean>!,
    streams: Array<SampleStream?>?,
    streamResetFlags: BooleanArray<Boolean>!,
    positionUs: Long
): Long
```

Performs a track selection.

The call receives track `selections` for each renderer, `mayRetainStreamFlags` indicating whether the existing `SampleStream` can be retained for each selection, and the existing `stream`s themselves. The call will update `streams` to reflect the provided selections, clearing, setting and replacing entries as required. If an existing sample stream is retained but with the requirement that the consuming renderer be reset, then the corresponding flag in `streamResetFlags` will be set to true. This flag will also be set if a new sample stream is created.

Note that previously passed `TrackSelections` are no longer valid, and any references to them must be updated to point to the new selections.

This method is only called after the period has been prepared.

| Parameters |
|---|---|
| `selections: Array<ExoTrackSelection?>?` | The renderer track selections. |
| `mayRetainStreamFlags: BooleanArray<Boolean>!` | Flags indicating whether the existing sample stream can be retained for each track selection. A `true` value indicates that the selection is equivalent to the one that was previously passed, and that the caller does not require that the sample stream be recreated. If a retained sample stream holds any references to the track selection then they must be updated to point to the new selection. |
| `streams: Array<SampleStream?>?` | The existing sample streams, which will be updated to reflect the provided selections. |
| `streamResetFlags: BooleanArray<Boolean>!` | Will be updated to indicate new sample streams, and sample streams that have been retained but with the requirement that the consuming renderer be reset. |
| `positionUs: Long` | The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position. |

| Returns |
|---|---|
| `Long` | The actual position at which the tracks were enabled, in microseconds. |

### setClippingError

```
fun setClippingError(
    clippingError: ClippingMediaSource.IllegalClippingException!
): Unit
```

Sets a clipping error detected by the media source so that it can be thrown as a period error at the next opportunity.

| Parameters |
|---|---|
| `clippingError: ClippingMediaSource.IllegalClippingException!` | The clipping error. |

### setUsesStreamPrerollFlags

```
fun setUsesStreamPrerollFlags(): Unit
```

Notifies the media period that the player will use `getFlags` to check if streams contain initial discontinuities at the start of the period rather than using `readDiscontinuity`.

This method is only called after the period has been prepared and if `supportsStreamPrerollFlags` returns `true`. If invoked then `readDiscontinuity` should only report discontinuities that occur during playback, not any initial discontinuities at the start of the period.

### supportsStreamPrerollFlags

```
fun supportsStreamPrerollFlags(): Boolean
```

Returns whether this media period supports reporting initial discontinuities via `getFlags`.

This method is only called after the period has been prepared.

### updateClipping

```
fun updateClipping(startUs: Long, endUs: Long): Unit
```

Updates the clipping start/end times for this period, in microseconds.

| Parameters |
|---|---|
| `startUs: Long` | The clipping start time, in microseconds. |
| `endUs: Long` | The clipping end time, in microseconds, or `TIME_END_OF_SOURCE` to indicate the end of the period. |

## Public properties

### mediaPeriod

```
val mediaPeriod: MediaPeriod!
```

The `MediaPeriod` wrapped by this clipping media period.