# MediaItem.ClippingConfiguration

# MediaItem.ClippingConfiguration

Artifact:[androidx.media3:media3-common](https://developer.android.com/jetpack/androidx/releases/media3)  
[View Source](https://cs.android.com/search?q=file:androidx/media3/common/MediaItem.java+class:androidx.media3.common.MediaItem.ClippingConfiguration)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration "View this page in Java")

<br />

```
class MediaItem.ClippingConfiguration
```

<br />

Known direct subclasses  
[MediaItem.ClippingProperties](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingProperties)  

|------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [MediaItem.ClippingProperties](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingProperties) | **This class is deprecated.** Use[ClippingConfiguration](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration)instead. <br /> |

*** ** * ** ***

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

## Summary

|                                                                                                                                                   ### Nested types                                                                                                                                                   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[MediaItem.ClippingConfiguration.Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration.Builder) Builder for[ClippingConfiguration](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration)instances. |

|                                                                    ### Constants                                                                    |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[MediaItem.ClippingConfiguration](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration)`!` | [UNSET](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#UNSET()) A clipping configuration with default values. |

|                                                                    ### Public functions                                                                     |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [MediaItem.ClippingConfiguration.Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration.Builder)`!` | [buildUpon](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#buildUpon())`()` Returns a[Builder](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration.Builder)initialized with the values of this instance.                                                                                                                                               |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                         | [equals](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#equals(java.lang.Object))`(obj: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)`                                                                                                                                                                                                                                 |
| `java-static `[MediaItem.ClippingProperties](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingProperties)`!`         | `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) [fromBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#fromBundle(android.os.Bundle))`(bundle: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`!)` Restores a`ClippingProperties`from a[Bundle](https://developer.android.com/reference/android/os/Bundle.html). |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                 | [hashCode](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#hashCode())`()`                                                                                                                                                                                                                                                                                                                                |
| [Bundle](https://developer.android.com/reference/android/os/Bundle.html)`!`                                                                                 | `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) [toBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#toBundle())`()`                                                                                                                                                                                                                       |

|                                                                                ### Public properties                                                                                 |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                  | `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) [allowUnseekableMedia](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#allowUnseekableMedia()) Whether clipping to a non-zero start position in unseekable media is allowed.                                                                                                                                                    |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)                                                                                                        | [endPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#endPositionMs()) The end position in milliseconds.                                                                                                                                                                                                                                                                                                                       |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)                                                                                                        | `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) [endPositionUs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#endPositionUs()) The end position in microseconds.                                                                                                                                                                                                              |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                  | [relativeToDefaultPosition](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#relativeToDefaultPosition()) Whether[startPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#startPositionMs())and[endPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#endPositionMs())are relative to the default position. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                  | [relativeToLiveWindow](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#relativeToLiveWindow()) Whether the clipping of active media periods moves with a live window.                                                                                                                                                                                                                                                                    |
| `@`[IntRange](https://developer.android.com/reference/kotlin/androidx/annotation/IntRange)`(from = 0) `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [startPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#startPositionMs()) The start position in milliseconds.                                                                                                                                                                                                                                                                                                                 |
| `@`[IntRange](https://developer.android.com/reference/kotlin/androidx/annotation/IntRange)`(from = 0) `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | `@`[UnstableApi](https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi) [startPositionUs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#startPositionUs()) The start position in microseconds.                                                                                                                                                                                                        |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                  | [startsAtKeyFrame](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#startsAtKeyFrame()) 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](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration.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](https://developer.android.com/reference/android/os/Bundle.html).  

### hashCode

```
fun hashCode(): Int
```  

### toBundle

```
@UnstableApi
fun toBundle(): Bundle!
```  

## Public properties

### allowUnseekableMedia

```
@UnstableApi
val allowUnseekableMedia: Boolean
```

Whether clipping to a non-zero start position in unseekable media is allowed.  

### endPositionMs

```
val endPositionMs: Long
```

The end position in milliseconds. This is a value larger than or equal to zero or[TIME_END_OF_SOURCE](https://developer.android.com/reference/kotlin/androidx/media3/common/C#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](https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_END_OF_SOURCE())to play to the end of the stream.  

### relativeToDefaultPosition

```
val relativeToDefaultPosition: Boolean
```

Whether[startPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#startPositionMs())and[endPositionMs](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#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](https://developer.android.com/reference/kotlin/androidx/media3/common/MediaItem.ClippingConfiguration#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
```

Whether the start point is guaranteed to be a key frame.