EditedMediaItem.Builder
class EditedMediaItem.Builder
A builder for EditedMediaItem instances.
Summary
Public constructors
Builder
Builder(mediaItem: MediaItem!)
Creates an instance.
For image inputs:
- The
image durationshould always be set. - The values passed into
setRemoveAudio,setRemoveVideoandsetFlattenForSlowMotionwill be ignored. - For multi-picture formats (e.g. gifs), a single image frame from the container is displayed if the
DefaultAssetLoaderFactoryis used.
Public functions
setDurationUs
@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
MediaItemrepresents an image. The default image duration set viasetImageDurationMs. - On
Transformer, when theMediaItemhas an intrinsic duration (e.g. encoded video/audio data from an input file).
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setEffects
@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.
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setFlattenForSlowMotion
@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.
| Parameters | |
|---|---|
flattenForSlowMotion: Boolean |
Whether to flatten for slow motion. |
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setFrameRate
@CanIgnoreReturnValue
fun setFrameRate(frameRate: @IntRange(from = 0) Int): EditedMediaItem.Builder!
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.
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setRemoveAudio
@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.
| Parameters | |
|---|---|
removeAudio: Boolean |
Whether to remove the audio. |
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setRemoveVideo
@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.
| Parameters | |
|---|---|
removeVideo: Boolean |
Whether to remove the video. |
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |
setSpeed
@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.
The default value is DEFAULT, which represents an unmodified speed.
| Returns | |
|---|---|
EditedMediaItem.Builder! |
This builder. |