EditedMediaItem.Builder
class EditedMediaItem.Builder
A builder for EditedMediaItem instances.
Summary
Public functions |
|
|---|---|
EditedMediaItem! |
build()Builds an |
EditedMediaItem.Builder! |
@CanIgnoreReturnValueSets the duration of the output video in microseconds. |
EditedMediaItem.Builder! |
@CanIgnoreReturnValue |
EditedMediaItem.Builder! |
@CanIgnoreReturnValueSets whether to flatten the |
EditedMediaItem.Builder! |
@CanIgnoreReturnValueSets the frame rate of the output video in frames per second. |
EditedMediaItem.Builder! |
@CanIgnoreReturnValueSets whether to remove the audio from the |
EditedMediaItem.Builder! |
@CanIgnoreReturnValueSets whether to remove the video from the |
Public constructors
Builder
Builder(mediaItem: MediaItem!)
Creates an instance.
For image inputs, 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.
Public functions
setDurationUs
@CanIgnoreReturnValue
fun setDurationUs(durationUs: @IntRange(from = 1) Long): EditedMediaItem.Builder!
Sets the duration of the output video in microseconds.
For an input that doesn't have an intrinsic duration (e.g. images), this should be the desired presentation duration. Otherwise, this should be the duration of the full content that the media URI resolves to, before clippingConfiguration is applied.
No duration is set by default.
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 , 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 frame rate of the output video in frames per second.
This should be set for inputs that don't have an implicit frame rate (e.g. images). It will be ignored for inputs that do have an implicit frame rate (e.g. video).
No frame rate is set by default.
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. |