EditedMediaItemSequence.Builder

Artifact: androidx.media3:media3-transformer

View Source

---

Kotlin |Java

class EditedMediaItemSequence.Builder

---

A builder for instances of EditedMediaItemSequence.

Summary

Public constructors
Builder(editedMediaItems: Array<EditedMediaItem!>!) This function is deprecated. Use Builder to create the builder, and addItems to add the EditedMediaItems, or use the static factory methods like withAudioFrom, withVideoFrom, or withAudioAndVideoFrom.
Builder(editedMediaItems: (Mutable)List<EditedMediaItem!>!) This function is deprecated. Use Builder to create the builder, and addItems to add the EditedMediaItems, or use the static factory methods like withAudioFrom, withVideoFrom, or withAudioAndVideoFrom.
Builder(trackTypes: (Mutable)Set<@C.TrackType Int!>!) Creates an instance.

Public functions
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue addGap(durationUs: Long) Adds a gap to the sequence.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue addItem(item: EditedMediaItem!) Adds the item to the sequence.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue addItems(items: Array<EditedMediaItem!>!) Adds the items to the sequence.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue addItems(items: (Mutable)List<EditedMediaItem!>!) Adds all the items in the list to the sequence.
EditedMediaItemSequence!	build() Builds the EditedMediaItemSequence.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue experimentalSetForceAudioTrack(forceAudioTrack: Boolean) This function is deprecated. Use Builder to set sequence track types instead.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue experimentalSetForceVideoTrack(forceVideoTrack: Boolean) This function is deprecated. Use Builder to set sequence track types instead.
EditedMediaItemSequence.Builder!	@CanIgnoreReturnValue setIsLooping(isLooping: Boolean) See isLooping.

Public constructors

Builder

Builder(editedMediaItems: Array<EditedMediaItem!>!)

This function is deprecated.

Use Builder to create the builder, and addItems to add the EditedMediaItems, or use the static factory methods like withAudioFrom, withVideoFrom, or withAudioAndVideoFrom.

Builder

Builder(editedMediaItems: (Mutable)List<EditedMediaItem!>!)

This function is deprecated.

Use Builder to create the builder, and addItems to add the EditedMediaItems, or use the static factory methods like withAudioFrom, withVideoFrom, or withAudioAndVideoFrom.

Builder

Builder(trackTypes: (Mutable)Set<@C.TrackType Int!>!)

Creates an instance.

Parameters
trackTypes: (Mutable)Set<@C.TrackType Int!>!	The non-empty set of track types enabled for this sequence. Must only contain TRACK_TYPE_AUDIO and/or TRACK_TYPE_VIDEO. This determines which tracks will be included in this sequence's output. For example, passing a set containing only TRACK_TYPE_AUDIO will result in an audio-only sequence.

Public functions

addGap

@CanIgnoreReturnValue
fun addGap(durationUs: Long): EditedMediaItemSequence.Builder!

Adds a gap to the sequence.

A gap is a period of time with no media.

The gap's tracks match the trackTypes.

Parameters
durationUs: Long	The duration of the gap, in milliseconds.

Returns
EditedMediaItemSequence.Builder!	This builder, for convenience.

addItem

@CanIgnoreReturnValue
fun addItem(item: EditedMediaItem!): EditedMediaItemSequence.Builder!

Adds the item to the sequence.

Parameters
item: EditedMediaItem!	The EditedMediaItem to add.

Returns
EditedMediaItemSequence.Builder!	This builder, for convenience.

addItems

@CanIgnoreReturnValue
fun addItems(items: Array<EditedMediaItem!>!): EditedMediaItemSequence.Builder!

Adds the items to the sequence.

Parameters
items: Array<EditedMediaItem!>!	The EditedMediaItem instances to add.

Returns
EditedMediaItemSequence.Builder!	This builder, for convenience.

addItems

@CanIgnoreReturnValue
fun addItems(items: (Mutable)List<EditedMediaItem!>!): EditedMediaItemSequence.Builder!

Adds all the items in the list to the sequence.

Parameters
items: (Mutable)List<EditedMediaItem!>!	The list of EditedMediaItem instances to add.

Returns
EditedMediaItemSequence.Builder!	This builder, for convenience.

build

fun build(): EditedMediaItemSequence!

Builds the EditedMediaItemSequence.

There must be at least one item in the sequence.

Returns
EditedMediaItemSequence!	The built EditedMediaItemSequence.

experimentalSetForceAudioTrack

@CanIgnoreReturnValue
fun experimentalSetForceAudioTrack(forceAudioTrack: Boolean): EditedMediaItemSequence.Builder!

This function is deprecated.

Use Builder to set sequence track types instead.

experimentalSetForceVideoTrack

@CanIgnoreReturnValue
fun experimentalSetForceVideoTrack(forceVideoTrack: Boolean): EditedMediaItemSequence.Builder!

This function is deprecated.

Use Builder to set sequence track types instead.

setIsLooping

@CanIgnoreReturnValue
fun setIsLooping(isLooping: Boolean): EditedMediaItemSequence.Builder!

See isLooping.

Looping is false by default.

Parameters
isLooping: Boolean	Whether this sequence should loop.

Returns
EditedMediaItemSequence.Builder!	This builder, for convenience.