EditedMediaItem.Builder

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.

fun build(): EditedMediaItem!

Builds an EditedMediaItem instance.

@CanIgnoreReturnValue
fun setDurationUs(durationUs: @IntRange(from = 1) Long): EditedMediaItem.Builder!

Sets the duration in microseconds of the source media represented by the MediaItem.

The provided duration should match the duration of the source media before applying any clipping or speed-changing effects.

Setting the duration is optional in the following cases:

• The MediaItem represents an image. The default image duration set via setImageDurationMs.
• On Transformer, when the MediaItem has an intrinsic duration (e.g. encoded video/audio data from an input file).

@CanIgnoreReturnValue
fun setEffects(effects: Effects!): EditedMediaItem.Builder!

Sets the Effects to apply to the MediaItem.

Callers should not interact with underlying audioProcessors.

The default value is EMPTY.

@CanIgnoreReturnValue
fun setFlattenForSlowMotion(flattenForSlowMotion: Boolean): EditedMediaItem.Builder!

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 MediaSource.Factory, 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.

@CanIgnoreReturnValue
fun setFrameRate(frameRate: @IntRange(from = 0) Int): EditedMediaItem.Builder!

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

• For inputs that don't have an intrinsic frame rate (e.g., images), this value determines the frame rate of the output 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.
• For inputs that do have an intrinsic frame rate (e.g., video), this value acts as a maximum frame rate. If the intrinsic frame rate is higher than the value set here, frames will be dropped to achieve the specified maximum frame rate in the output. If the intrinsic frame rate is lower, this parameter has no effect. Setting the max frame rate is particularly important when increasing media speed using the setSpeed API. Increasing media speed adjusts video sample timestamps to the new rate, resulting in a higher effective output frame rate. By setting a maximum frame rate, you can prevent the output from having an excessively high frame rate.

No frame rate is set by default.

@CanIgnoreReturnValue
fun setRemoveAudio(removeAudio: Boolean): EditedMediaItem.Builder!

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.

@CanIgnoreReturnValue
fun setRemoveVideo(removeVideo: Boolean): EditedMediaItem.Builder!

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.

@ExperimentalApi
@CanIgnoreReturnValue
fun setSpeed(parameters: SpeedParameters!): EditedMediaItem.Builder!

Sets a SpeedParameters instance to control the presentation speed of the EditedMediaItem.

If a SpeedParameters instance is set, speed changing effects are not allowed.

@CanIgnoreReturnValue
fun setSpeed(provider: SpeedProvider!): EditedMediaItem.Builder!

Sets a SpeedProvider to control the presentation speed of the EditedMediaItem.

If a SpeedProvider is set, speed changing effects are not allowed.

This method is identical to setSpeed(new SpeedParameters(provider, false)).

The default value is DEFAULT, which represents an unmodified speed.