MediaItem.ClippingConfiguration

class MediaItem.ClippingConfiguration

Known direct subclasses
MediaItem.ClippingProperties

This class is deprecated.

Use ClippingConfiguration instead.

Optionally clips the media item to a custom start and end position.

Summary

Nested types

Builder for ClippingConfiguration instances.

Constants
const MediaItem.ClippingConfiguration!

A clipping configuration with default values.

Public functions
MediaItem.ClippingConfiguration.Builder!

Returns a Builder initialized with the values of this instance.
Boolean
equals(obj: Any?)
java-static MediaItem.ClippingProperties!

Restores a ClippingProperties from a Bundle.
Int
Bundle!

Public properties
Long

The end position in milliseconds.
Long

The end position in microseconds.
Boolean

Whether startPositionMs and endPositionMs are relative to the default position.
Boolean

Whether the clipping of active media periods moves with a live window.
@IntRange(from = 0) Long

The start position in milliseconds.
@IntRange(from = 0) Long

The start position in microseconds.
Boolean

Sets whether the start point is guaranteed to be a key frame.

Constants

UNSET

const val UNSET: MediaItem.ClippingConfiguration!

A clipping configuration with default values.

Public functions

buildUpon

fun buildUpon(): MediaItem.ClippingConfiguration.Builder!

Returns a Builder initialized with the values of this instance.

equals

fun equals(obj: Any?): Boolean

fromBundle

@UnstableApi
java-static fun fromBundle(bundle: Bundle!): MediaItem.ClippingProperties!

Restores a ClippingProperties from a Bundle.

hashCode

fun hashCode(): Int

toBundle

@UnstableApi
fun toBundle(): Bundle!

Public properties

endPositionMs

val endPositionMs: Long

The end position in milliseconds. This is a value larger than or equal to zero or TIME_END_OF_SOURCE to play to the end of the stream.

endPositionUs

@UnstableApi
val endPositionUs: Long

The end position in microseconds. This is a value larger than or equal to zero or TIME_END_OF_SOURCE to play to the end of the stream.

relativeToDefaultPosition

val relativeToDefaultPosition: Boolean

Whether startPositionMs and endPositionMs are relative to the default position.

relativeToLiveWindow

val relativeToLiveWindow: Boolean

Whether the clipping of active media periods moves with a live window. If false, playback ends when it reaches endPositionMs.

startPositionMs

val startPositionMs: @IntRange(from = 0) Long

The start position in milliseconds. This is a value larger than or equal to zero.

startPositionUs

@UnstableApi
val startPositionUs: @IntRange(from = 0) Long

The start position in microseconds. This is a value larger than or equal to zero.

startsAtKeyFrame

val startsAtKeyFrame: Boolean

Sets whether the start point is guaranteed to be a key frame.