MediaItem.Builder

Artifact: androidx.media3:media3-common

View Source

---

Kotlin |Java

public final class MediaItem.Builder

---

A builder for MediaItem instances.

Summary

Public constructors
Builder() Creates a builder.

Public methods
MediaItem	build() Returns a new MediaItem instance with the current builder values.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setAdTagUri(@Nullable String adTagUri) This method is deprecated. Use setAdsConfiguration, parse the adTagUri with parse and pass the result to Builder instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setAdTagUri(@Nullable Uri adTagUri) This method is deprecated. Use setAdsConfiguration and pass the adTagUri to Builder instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setAdTagUri(@Nullable Uri adTagUri, @Nullable Object adsId) This method is deprecated. Use setAdsConfiguration, pass the adTagUri to Builder and the adsId to setAdsId instead.
MediaItem.Builder	@CanIgnoreReturnValue setAdsConfiguration(     @Nullable MediaItem.AdsConfiguration adsConfiguration ) Sets the optional AdsConfiguration.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setClipEndPositionMs(long endPositionMs) This method is deprecated. Use setClippingConfiguration and setEndPositionMs instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setClipRelativeToDefaultPosition(boolean relativeToDefaultPosition) This method is deprecated. Use setClippingConfiguration and setRelativeToDefaultPosition instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setClipRelativeToLiveWindow(boolean relativeToLiveWindow) This method is deprecated. Use setClippingConfiguration and setRelativeToLiveWindow instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setClipStartPositionMs(@IntRange(from = 0) long startPositionMs) This method is deprecated. Use setClippingConfiguration and setStartPositionMs instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setClipStartsAtKeyFrame(boolean startsAtKeyFrame) This method is deprecated. Use setClippingConfiguration and setStartsAtKeyFrame instead.
MediaItem.Builder	@CanIgnoreReturnValue setClippingConfiguration(     MediaItem.ClippingConfiguration clippingConfiguration ) Sets the ClippingConfiguration, defaults to UNSET.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setCustomCacheKey(@Nullable String customCacheKey) Sets the optional custom cache key (only used for progressive streams).
MediaItem.Builder	@CanIgnoreReturnValue setDrmConfiguration(     @Nullable MediaItem.DrmConfiguration drmConfiguration ) Sets the optional DRM configuration.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmForceDefaultLicenseUri(boolean forceDefaultLicenseUri) This method is deprecated. Use setDrmConfiguration and setForceDefaultLicenseUri instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmKeySetId(@Nullable byte[] keySetId) This method is deprecated. Use setDrmConfiguration and setKeySetId instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmLicenseRequestHeaders(     @Nullable Map<String, String> licenseRequestHeaders ) This method is deprecated. Use setDrmConfiguration and setLicenseRequestHeaders instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmLicenseUri(@Nullable String licenseUri) This method is deprecated. Use setDrmConfiguration and setLicenseUri instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmLicenseUri(@Nullable Uri licenseUri) This method is deprecated. Use setDrmConfiguration and setLicenseUri instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmMultiSession(boolean multiSession) This method is deprecated. Use setDrmConfiguration and setMultiSession instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmPlayClearContentWithoutKey(boolean playClearContentWithoutKey) This method is deprecated. Use setDrmConfiguration and setPlayClearContentWithoutKey instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmSessionForClearPeriods(boolean sessionForClearPeriods) This method is deprecated. Use setDrmConfiguration and setForceSessionsForAudioAndVideoTracks instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmSessionForClearTypes(     @Nullable List<@C.TrackType Integer> sessionForClearTypes ) This method is deprecated. Use setDrmConfiguration and setForcedSessionTrackTypes instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setDrmUuid(@Nullable UUID uuid) This method is deprecated. Use setDrmConfiguration and pass the uuid to Builder instead.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setImageDurationMs(long imageDurationMs) Sets the image duration in video output, in milliseconds.
MediaItem.Builder	@CanIgnoreReturnValue setLiveConfiguration(MediaItem.LiveConfiguration liveConfiguration) Sets the LiveConfiguration.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setLiveMaxOffsetMs(long liveMaxOffsetMs) This method is deprecated. Use setLiveConfiguration and setMaxOffsetMs.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setLiveMaxPlaybackSpeed(float maxPlaybackSpeed) This method is deprecated. Use setLiveConfiguration and setMaxPlaybackSpeed.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setLiveMinOffsetMs(long liveMinOffsetMs) This method is deprecated. Use setLiveConfiguration and setMinOffsetMs.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setLiveMinPlaybackSpeed(float minPlaybackSpeed) This method is deprecated. Use setLiveConfiguration and setMinPlaybackSpeed.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setLiveTargetOffsetMs(long liveTargetOffsetMs) This method is deprecated. Use setLiveConfiguration and setTargetOffsetMs.
MediaItem.Builder	@CanIgnoreReturnValue setMediaId(String mediaId) Sets the optional media ID which identifies the media item.
MediaItem.Builder	@CanIgnoreReturnValue setMediaMetadata(MediaMetadata mediaMetadata) Sets the media metadata.
MediaItem.Builder	@CanIgnoreReturnValue setMimeType(@Nullable String mimeType) Sets the optional MIME type.
MediaItem.Builder	@CanIgnoreReturnValue setRequestMetadata(MediaItem.RequestMetadata requestMetadata) Sets the request metadata.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setStreamKeys(@Nullable List<StreamKey> streamKeys) Sets the optional stream keys by which the manifest is filtered (only used for adaptive streams).
MediaItem.Builder	@CanIgnoreReturnValue setSubtitleConfigurations(     List<MediaItem.SubtitleConfiguration> subtitleConfigurations ) Sets the optional subtitles.
MediaItem.Builder	@CanIgnoreReturnValue @UnstableApi setSubtitles(@Nullable List<MediaItem.Subtitle> subtitles) This method is deprecated. Use setSubtitleConfigurations instead.
MediaItem.Builder	@CanIgnoreReturnValue setTag(@Nullable Object tag) Sets the optional tag for custom attributes.
MediaItem.Builder	@CanIgnoreReturnValue setUri(@Nullable String uri) Sets the optional URI.
MediaItem.Builder	@CanIgnoreReturnValue setUri(@Nullable Uri uri) Sets the optional URI.

Public constructors

Builder

public Builder()

Creates a builder.

Public methods

build

public MediaItem build()

Returns a new MediaItem instance with the current builder values.

setAdTagUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setAdTagUri(@Nullable String adTagUri)

This method is deprecated.

Use setAdsConfiguration, parse the adTagUri with parse and pass the result to Builder instead.

setAdTagUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setAdTagUri(@Nullable Uri adTagUri)

This method is deprecated.

Use setAdsConfiguration and pass the adTagUri to Builder instead.

setAdTagUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setAdTagUri(@Nullable Uri adTagUri, @Nullable Object adsId)

This method is deprecated.

Use setAdsConfiguration, pass the adTagUri to Builder and the adsId to setAdsId instead.

setAdsConfiguration

@CanIgnoreReturnValue
public MediaItem.Builder setAdsConfiguration(
    @Nullable MediaItem.AdsConfiguration adsConfiguration
)

Sets the optional AdsConfiguration.

This method should only be called if setUri is passed a non-null value.

setClipEndPositionMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setClipEndPositionMs(long endPositionMs)

This method is deprecated.

Use setClippingConfiguration and setEndPositionMs instead.

setClipRelativeToDefaultPosition

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setClipRelativeToDefaultPosition(boolean relativeToDefaultPosition)

This method is deprecated.

Use setClippingConfiguration and setRelativeToDefaultPosition instead.

setClipRelativeToLiveWindow

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setClipRelativeToLiveWindow(boolean relativeToLiveWindow)

This method is deprecated.

Use setClippingConfiguration and setRelativeToLiveWindow instead.

setClipStartPositionMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setClipStartPositionMs(@IntRange(from = 0) long startPositionMs)

This method is deprecated.

Use setClippingConfiguration and setStartPositionMs instead.

setClipStartsAtKeyFrame

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setClipStartsAtKeyFrame(boolean startsAtKeyFrame)

This method is deprecated.

Use setClippingConfiguration and setStartsAtKeyFrame instead.

setClippingConfiguration

@CanIgnoreReturnValue
public MediaItem.Builder setClippingConfiguration(
    MediaItem.ClippingConfiguration clippingConfiguration
)

Sets the ClippingConfiguration, defaults to UNSET.

setCustomCacheKey

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setCustomCacheKey(@Nullable String customCacheKey)

Sets the optional custom cache key (only used for progressive streams).

This method should only be called if setUri is passed a non-null value.

setDrmConfiguration

@CanIgnoreReturnValue
public MediaItem.Builder setDrmConfiguration(
    @Nullable MediaItem.DrmConfiguration drmConfiguration
)

Sets the optional DRM configuration.

setDrmForceDefaultLicenseUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmForceDefaultLicenseUri(boolean forceDefaultLicenseUri)

This method is deprecated.

Use setDrmConfiguration and setForceDefaultLicenseUri instead.

setDrmKeySetId

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmKeySetId(@Nullable byte[] keySetId)

This method is deprecated.

Use setDrmConfiguration and setKeySetId instead.

setDrmLicenseRequestHeaders

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmLicenseRequestHeaders(
    @Nullable Map<String, String> licenseRequestHeaders
)

This method is deprecated.

Use setDrmConfiguration and setLicenseRequestHeaders instead. Note that setLicenseRequestHeaders doesn't accept null, use an empty map to clear the headers.

setDrmLicenseUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmLicenseUri(@Nullable String licenseUri)

This method is deprecated.

Use setDrmConfiguration and setLicenseUri instead.

setDrmLicenseUri

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmLicenseUri(@Nullable Uri licenseUri)

This method is deprecated.

Use setDrmConfiguration and setLicenseUri instead.

setDrmMultiSession

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmMultiSession(boolean multiSession)

This method is deprecated.

Use setDrmConfiguration and setMultiSession instead.

setDrmPlayClearContentWithoutKey

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmPlayClearContentWithoutKey(boolean playClearContentWithoutKey)

This method is deprecated.

Use setDrmConfiguration and setPlayClearContentWithoutKey instead.

setDrmSessionForClearPeriods

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmSessionForClearPeriods(boolean sessionForClearPeriods)

This method is deprecated.

Use setDrmConfiguration and setForceSessionsForAudioAndVideoTracks instead.

setDrmSessionForClearTypes

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmSessionForClearTypes(
    @Nullable List<@C.TrackType Integer> sessionForClearTypes
)

This method is deprecated.

Use setDrmConfiguration and setForcedSessionTrackTypes instead. Note that setForcedSessionTrackTypes doesn't accept null, use an empty list to clear the contents.

setDrmUuid

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setDrmUuid(@Nullable UUID uuid)

This method is deprecated.

Use setDrmConfiguration and pass the uuid to Builder instead.

setImageDurationMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setImageDurationMs(long imageDurationMs)

Sets the image duration in video output, in milliseconds.

Must be set if the URI is set and resolves to an image. Ignored otherwise.

Motion photos will be rendered as images if this parameter is set, and as videos otherwise.

Default value is TIME_UNSET.

setLiveConfiguration

@CanIgnoreReturnValue
public MediaItem.Builder setLiveConfiguration(MediaItem.LiveConfiguration liveConfiguration)

Sets the LiveConfiguration. Defaults to UNSET.

setLiveMaxOffsetMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setLiveMaxOffsetMs(long liveMaxOffsetMs)

This method is deprecated.

Use setLiveConfiguration and setMaxOffsetMs.

setLiveMaxPlaybackSpeed

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setLiveMaxPlaybackSpeed(float maxPlaybackSpeed)

This method is deprecated.

Use setLiveConfiguration and setMaxPlaybackSpeed.

setLiveMinOffsetMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setLiveMinOffsetMs(long liveMinOffsetMs)

This method is deprecated.

Use setLiveConfiguration and setMinOffsetMs.

setLiveMinPlaybackSpeed

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setLiveMinPlaybackSpeed(float minPlaybackSpeed)

This method is deprecated.

Use setLiveConfiguration and setMinPlaybackSpeed.

setLiveTargetOffsetMs

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setLiveTargetOffsetMs(long liveTargetOffsetMs)

This method is deprecated.

Use setLiveConfiguration and setTargetOffsetMs.

setMediaId

@CanIgnoreReturnValue
public MediaItem.Builder setMediaId(String mediaId)

Sets the optional media ID which identifies the media item.

By default DEFAULT_MEDIA_ID is used.

setMediaMetadata

@CanIgnoreReturnValue
public MediaItem.Builder setMediaMetadata(MediaMetadata mediaMetadata)

Sets the media metadata.

setMimeType

@CanIgnoreReturnValue
public MediaItem.Builder setMimeType(@Nullable String mimeType)

Sets the optional MIME type.

The MIME type may be used as a hint for inferring the type of the media item.

This method should only be called if setUri is passed a non-null value.

Parameters
@Nullable String mimeType	The MIME type.

setRequestMetadata

@CanIgnoreReturnValue
public MediaItem.Builder setRequestMetadata(MediaItem.RequestMetadata requestMetadata)

Sets the request metadata.

setStreamKeys

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setStreamKeys(@Nullable List<StreamKey> streamKeys)

Sets the optional stream keys by which the manifest is filtered (only used for adaptive streams).

null or an empty List can be used for a reset.

If setUri is passed a non-null uri, the stream keys are used to create a LocalConfiguration object. Otherwise they will be ignored.

setSubtitleConfigurations

@CanIgnoreReturnValue
public MediaItem.Builder setSubtitleConfigurations(
    List<MediaItem.SubtitleConfiguration> subtitleConfigurations
)

Sets the optional subtitles.

This method should only be called if setUri is passed a non-null value.

setSubtitles

@CanIgnoreReturnValue
@UnstableApi
public MediaItem.Builder setSubtitles(@Nullable List<MediaItem.Subtitle> subtitles)

This method is deprecated.

Use setSubtitleConfigurations instead. Note that setSubtitleConfigurations doesn't accept null, use an empty list to clear the contents.

setTag

@CanIgnoreReturnValue
public MediaItem.Builder setTag(@Nullable Object tag)

Sets the optional tag for custom attributes. The tag for the media source which will be published in the androidx.media3.common.Timeline of the source as androidx.media3.common.Timeline.Window#tag.

This method should only be called if setUri is passed a non-null value.

setUri

@CanIgnoreReturnValue
public MediaItem.Builder setUri(@Nullable String uri)

Sets the optional URI.

If uri is null or unset then no LocalConfiguration object is created during build and no other Builder methods that would populate localConfiguration should be called.

setUri

@CanIgnoreReturnValue
public MediaItem.Builder setUri(@Nullable Uri uri)

Sets the optional URI.

If uri is null or unset then no LocalConfiguration object is created during build and no other Builder methods that would populate localConfiguration should be called.