Transformer

const val PROGRESS_STATE_AVAILABLE = 2: Int

Indicates that the progress is available.

const val PROGRESS_STATE_NOT_STARTED = 0: Int

Indicates that the corresponding operation hasn't been started.

const val PROGRESS_STATE_NO_TRANSFORMATION = 0: Int

const val PROGRESS_STATE_UNAVAILABLE = 3: Int

Indicates that the progress is permanently unavailable.

const val PROGRESS_STATE_WAITING_FOR_AVAILABILITY = 1: Int

Indicates that the progress is currently unavailable, but might become available.

fun addListener(listener: Transformer.Listener!): Unit

Adds a Transformer.Listener to listen to the export events.

fun buildUpon(): Transformer.Builder!

Returns a Transformer.Builder initialized with the values of this instance.

fun cancel(): Unit

Cancels the export that is currently in progress, if any.

The export output file (if any) is not deleted.

fun getApplicationLooper(): Looper!

Returns the Looper associated with the application thread that's used to access the transformer and on which transformer events are received.

@Transformer.ProgressState
fun getProgress(progressHolder: ProgressHolder!): Int

Returns the current ProgressState and updates progressHolder with the current progress if it is available.

If the export is resumed, this method returns PROGRESS_STATE_UNAVAILABLE.

After an export completes, this method returns PROGRESS_STATE_NOT_STARTED.

fun removeAllListeners(): Unit

Removes all listeners.

fun removeListener(listener: Transformer.Listener!): Unit

Removes a Transformer.Listener.

fun resume(
    composition: Composition!,
    outputFilePath: String!,
    oldFilePath: String!
): Unit

Resumes a previously cancelled export.

An export can be resumed only when:

• The Composition contains a single EditedMediaItemSequence having continuous audio and video tracks.
• The output is an MP4 file.

Note that export optimizations (such as trim optimization) will not be applied upon resumption.

fun setListener(listener: Transformer.Listener!): Unit

fun start(composition: Composition!, path: String!): Unit

Starts an asynchronous operation to export the given Composition.

The first EditedMediaItem in the first EditedMediaItemSequence that has a given track will determine the output format for that track, unless the format is set when building the Transformer. For example, consider the following composition

  Composition {
    EditedMediaItemSequence {
      [ImageMediaItem, VideoMediaItem]
    },
    EditedMediaItemSequence {
      [AudioMediaItem]
    },
  }

The video format will be determined by the ImageMediaItem in the first , while the audio format will be determined by the AudioMediaItem in the second EditedMediaItemSequence.

This method is under development. A Composition must meet the following conditions:

• The composition effects must contain no audio effects.
• The video composition Presentation effect is applied after input streams are composited. Other composition effects are ignored.

Sequences within the Composition must meet the following conditions:

• A sequence cannot contain both HDR and SDR video input.
• If an EditedMediaItem in a sequence contains data of a given track, so must all items in that sequence.
  • For audio, this condition can be removed by setting an experimental flag.
• All sequences containing audio data must output audio with the same properties. This can be done by adding item specific effects, such as SonicAudioProcessor and .

The export state is notified through the listener.

Concurrent exports on the same Transformer object are not allowed.

If no custom Muxer.Factory is specified, the output is an MP4 file.

The output can contain at most one video track and one audio track. Other track types are ignored. For adaptive bitrate inputs, if no custom AssetLoader.Factory is specified, the highest bitrate video and audio streams are selected.

If exporting the video track entails transcoding, the output frames' dimensions will be swapped if the output video's height is larger than the width. This is to improve compatibility among different device encoders.

fun start(editedMediaItem: EditedMediaItem!, path: String!): Unit

Starts an asynchronous operation to export the given EditedMediaItem.

The export state is notified through the listener.

Concurrent exports on the same Transformer object are not allowed.

If no custom Muxer.Factory is specified, the output is an MP4 file.

The output can contain at most one video track and one audio track. Other track types are ignored. For adaptive bitrate inputs, if no custom AssetLoader.Factory is specified, the highest bitrate video and audio streams are selected.

If exporting the video track entails transcoding, the output frames' dimensions will be swapped if the output video's height is larger than the width. This is to improve compatibility among different device encoders.

fun start(mediaItem: MediaItem!, path: String!): Unit

Starts an asynchronous operation to export the given MediaItem.

The export state is notified through the listener.

Concurrent exports on the same Transformer object are not allowed.

If no custom Muxer.Factory is specified, the output is an MP4 file.

The output can contain at most one video track and one audio track. Other track types are ignored. For adaptive bitrate inputs, if no custom AssetLoader.Factory is specified, the highest bitrate video and audio streams are selected.

If exporting the video track entails transcoding, the output frames' dimensions will be swapped if the output video's height is larger than the width. This is to improve compatibility among different device encoders.

@InlineMe(replacement = "this.start(mediaItem, path)")
fun startTransformation(mediaItem: MediaItem!, path: String!): Unit