Composition.Builder

Builder(sequences: (Mutable)List<EditedMediaItemSequence!>!)

Creates an instance.

Builder(
    sequence: EditedMediaItemSequence!,
    sequences: Array<EditedMediaItemSequence!>!
)

Creates an instance.

fun build(): Composition!

Builds a Composition instance.

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

Sets whether the output file should always contain an audio track.

The default value is false.

• If false:
  • If the Composition export doesn't produce any audio at timestamp 0, but produces audio later on, the export is aborted.
  • If the Composition doesn't produce any audio during the entire export, the output won't contain any audio.
  • If the Composition export produces audio at timestamp 0, the output will contain an audio track.
• If true, the output will always contain an audio track.

The MIME type of the output's audio track can be set using setAudioMimeType. The sample rate and channel count can be set by passing relevant AudioProcessor instances to the Composition.

Forcing an audio track and requesting audio transmuxing are not allowed together because generating silence requires transcoding.

This method is experimental and may be removed or changed without warning.

@CanIgnoreReturnValue
fun experimentalSetRetainHdrFromUltraHdrImage(
    retainHdrFromUltraHdrImage: Boolean
): Composition.Builder!

Sets whether to use produce an HDR output video from Ultra HDR image input.

If the HdrMode is HDR_MODE_KEEP_HDR, then setting this to true applies the recovery map (i.e. the gainmap) to the base image to produce HDR video frames. This is automatically overridden to true, if the first asset is a HDR video.

The output video will have the same color encoding as the first EditedMediaItem the sequence. If the Ultra HDR image is first in the sequence, output video will default to BT2020 HLG full range colors.

Ignored if HdrMode is not HDR_MODE_KEEP_HDR.

Supported on API 34+, by some device and HDR format combinations. Ignored if unsupported by device or API level.

The default value is false.

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

Sets the Effects to apply to the Composition.

The default value is EMPTY.

@CanIgnoreReturnValue
fun setHdrMode(@Composition.HdrMode hdrMode: Int): Composition.Builder!

Sets the HdrMode for HDR video input.

The default value is HDR_MODE_KEEP_HDR. Apps that need to tone-map HDR to SDR should generally prefer HDR_MODE_TONE_MAP_HDR_TO_SDR_USING_OPEN_GL over HDR_MODE_TONE_MAP_HDR_TO_SDR_USING_MEDIACODEC, because its behavior is likely to be more consistent across devices.

@CanIgnoreReturnValue
fun setTransmuxAudio(transmuxAudio: Boolean): Composition.Builder!

Sets whether to transmux the media items' audio tracks.

The default value is false.

If the Composition contains one MediaItem, the value set is ignored. The audio track will only be transcoded if necessary.

If the input Composition contains multiple media items, all the audio tracks are transcoded by default. They are all transmuxed if transmuxAudio is true. Transmuxed tracks must be compatible (typically, all the MediaItem instances containing the track to transmux are concatenated in a single and have the same sample format for that track). Any transcoding effects requested will be ignored.

Requesting audio transmuxing and forcing an audio track are not allowed together because generating silence requires transcoding.

@CanIgnoreReturnValue
fun setTransmuxVideo(transmuxVideo: Boolean): Composition.Builder!

Sets whether to transmux the media items' video tracks.

The default value is false.

If the Composition contains one MediaItem, the value set is ignored. The video track will only be transcoded if necessary.

If the input Composition contains multiple media items, all the video tracks are transcoded by default. They are all transmuxed if transmuxVideo is true. Transmuxed tracks must be compatible (typically, all the MediaItem instances containing the track to transmux are concatenated in a single and have the same sample format for that track). Any transcoding effects requested will be ignored.

@CanIgnoreReturnValue
fun setVideoCompositorSettings(
    videoCompositorSettings: VideoCompositorSettings!
): Composition.Builder!

Sets the VideoCompositorSettings to apply to the Composition.

The default value is DEFAULT.