EditedMediaItem.Builder

Artifact: androidx.media3:media3-transformer

View Source

---

Kotlin |Java

public final class EditedMediaItem.Builder

---

A builder for EditedMediaItem instances.

Summary

Public constructors
Builder(MediaItem mediaItem) Creates an instance.

Public methods
EditedMediaItem	build() Builds an EditedMediaItem instance.
EditedMediaItem.Builder	@CanIgnoreReturnValue setDurationUs(@IntRange(from = 1) long durationUs) Sets the MediaItem duration in the output, in microseconds.
EditedMediaItem.Builder	@CanIgnoreReturnValue setEffects(Effects effects) Sets the Effects to apply to the MediaItem.
EditedMediaItem.Builder	@CanIgnoreReturnValue setFlattenForSlowMotion(boolean flattenForSlowMotion) Sets whether to flatten the MediaItem if it contains slow motion markers.
EditedMediaItem.Builder	@CanIgnoreReturnValue setFrameRate(@IntRange(from = 0) int frameRate) Sets the MediaItem frame rate in the output video, in frames per second.
EditedMediaItem.Builder	@CanIgnoreReturnValue setRemoveAudio(boolean removeAudio) Sets whether to remove the audio from the MediaItem.
EditedMediaItem.Builder	@CanIgnoreReturnValue setRemoveVideo(boolean removeVideo) Sets whether to remove the video from the MediaItem.

Public constructors

Builder

public Builder(MediaItem mediaItem)

Creates an instance.

For image inputs:

• The image duration should always be set.
• The values passed into setRemoveAudio, setRemoveVideo and setFlattenForSlowMotion will be ignored.
• For multi-picture formats (e.g. gifs), a single image frame from the container is displayed if the DefaultAssetLoaderFactory is used.

Parameters
MediaItem mediaItem	The MediaItem on which transformations are applied.

Public methods

build

public EditedMediaItem build()

Builds an EditedMediaItem instance.

setDurationUs

@CanIgnoreReturnValue
public EditedMediaItem.Builder setDurationUs(@IntRange(from = 1) long durationUs)

Sets the MediaItem duration in the output, in microseconds.

For export, this should be set for non-image inputs that don't have an intrinsic duration (e.g. raw video data). It will be ignored for inputs that do have an intrinsic duration (e.g. encoded video data from input file).

For preview, this should be set for all non-image inputs (i.e. audio and video input).

This duration doesn't need to be set for images, because the default value is the 's image duration.

If clipping is applied, this should be the duration before clipping.

Parameters
@IntRange(from = 1) long durationUs	The duration, in microseconds.

Returns
EditedMediaItem.Builder	This builder.

setEffects

@CanIgnoreReturnValue
public EditedMediaItem.Builder setEffects(Effects effects)

Sets the Effects to apply to the MediaItem.

Callers should not interact with underlying audioProcessors.

The default value is EMPTY.

Parameters
Effects effects	The Effects to apply.

Returns
EditedMediaItem.Builder	This builder.

setFlattenForSlowMotion

@CanIgnoreReturnValue
public EditedMediaItem.Builder setFlattenForSlowMotion(boolean flattenForSlowMotion)

Sets whether to flatten the MediaItem if it contains slow motion markers.

The default value is false.

See flattenForSlowMotion for more information about slow motion flattening.

If using an ExoPlayerAssetLoader.Factory with a provided , make sure that FLAG_READ_SEF_DATA is set on the Mp4Extractor used. Otherwise, the slow motion metadata will be ignored and the input won't be flattened.

Slow motion flattening is only supported when the Composition contains exactly one MediaItem.

Using slow motion flattening together with MediaItem.ClippingConfiguration is not supported yet.

Parameters
boolean flattenForSlowMotion	Whether to flatten for slow motion.

Returns
EditedMediaItem.Builder	This builder.

setFrameRate

@CanIgnoreReturnValue
public EditedMediaItem.Builder setFrameRate(@IntRange(from = 0) int frameRate)

Sets the MediaItem frame rate in the output video, in frames per second.

This should be set for inputs that don't have an intrinsic frame rate (e.g., images). It will be ignored for inputs that do have an intrinsic frame rate (e.g., video).

For images, the frame rate depends on factors such as desired look, output format requirement, and whether the content is static or dynamic (e.g., animation). However, 30 fps is suitable for most use cases.

No frame rate is set by default.

Parameters
@IntRange(from = 0) int frameRate	The frame rate, in frames per second.

Returns
EditedMediaItem.Builder	This builder.

setRemoveAudio

@CanIgnoreReturnValue
public EditedMediaItem.Builder setRemoveAudio(boolean removeAudio)

Sets whether to remove the audio from the MediaItem.

The default value is false.

The audio and video cannot both be removed because the output would not contain any samples.

Parameters
boolean removeAudio	Whether to remove the audio.

Returns
EditedMediaItem.Builder	This builder.

setRemoveVideo

@CanIgnoreReturnValue
public EditedMediaItem.Builder setRemoveVideo(boolean removeVideo)

Sets whether to remove the video from the MediaItem.

The default value is false.

The audio and video cannot both be removed because the output would not contain any samples.

Parameters
boolean removeVideo	Whether to remove the video.

Returns
EditedMediaItem.Builder	This builder.