Back to Exoplayer

Transformer.Builder (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/transformer/Transformer.Builder.html

latest19.5 KB
Original Source

Package com.google.android.exoplayer2.transformer

Class Transformer.Builder


public static final classTransformer.Builderextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")

A builder for Transformer instances.

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | Builder​(Context context) | Creates a builder with default values. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | Transformer.Builder | addListener​(Transformer.Listener listener) | Adds a Transformer.Listener to listen to the export events. | | Transformer | build() | Builds a Transformer instance. | | Transformer.Builder | removeAllListeners() | Removes all listeners. | | Transformer.Builder | removeListener​(Transformer.Listener listener) | Removes a Transformer.Listener. | | Transformer.Builder | setAssetLoaderFactory​(AssetLoader.Factory assetLoaderFactory) | Sets the AssetLoader.Factory to be used to retrieve the samples to export. | | Transformer.Builder | setAudioProcessors​(List<AudioProcessor> audioProcessors) | Deprecated. Set the audio processors in an EditedMediaItem, and pass it to Transformer.start(EditedMediaItem, String) instead.

| | Transformer.Builder | setDebugViewProvider​(DebugViewProvider debugViewProvider) | Sets a provider for views to show diagnostic information (if available) during export. | | Transformer.Builder | setEncoderFactory​(Codec.EncoderFactory encoderFactory) | Sets the Codec.EncoderFactory that will be used by the transformer. | | Transformer.Builder | setFlattenForSlowMotion​(boolean flattenForSlowMotion) | Deprecated. Use EditedMediaItem.Builder.setFlattenForSlowMotion(boolean) to flatten the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

| | Transformer.Builder | setListener​(Transformer.Listener listener) | Deprecated. Use addListener(Listener), removeListener(Listener) or removeAllListeners() instead.

| | Transformer.Builder | setLooper​(Looper looper) | Sets the Looper that must be used for all calls to the transformer and that is used to call listeners on. | | Transformer.Builder | setMuxerFactory​(Muxer.Factory muxerFactory) | Sets the factory for muxers that write the media container. | | Transformer.Builder | setRemoveAudio​(boolean removeAudio) | Deprecated. Use EditedMediaItem.Builder.setRemoveAudio(boolean) to remove the audio from the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

| | Transformer.Builder | setRemoveVideo​(boolean removeVideo) | Deprecated. Use EditedMediaItem.Builder.setRemoveVideo(boolean) to remove the video from the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

| | Transformer.Builder | setTransformationRequest​(TransformationRequest transformationRequest) | Sets the TransformationRequest which configures the editing and transcoding options. | | Transformer.Builder | setVideoEffects​(List<Effect> effects) | Deprecated. Set the video effects in an EditedMediaItem, and pass it to Transformer.start(EditedMediaItem, String) instead.

| | Transformer.Builder | setVideoFrameProcessorFactory​(VideoFrameProcessor.Factory videoFrameProcessorFactory) | Sets the factory to be used to create VideoFrameProcessor instances. |

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

- 

Builder

public Builder​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context)

Creates a builder with default values. Parameters:context - The Context.

Method Detail

- 

setTransformationRequest

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setTransformationRequest​([TransformationRequest](TransformationRequest.html "class in com.google.android.exoplayer2.transformer")transformationRequest)

Sets the TransformationRequest which configures the editing and transcoding options.

Actual applied values may differ, per device capabilities. Transformer.Listener.onFallbackApplied(Composition, TransformationRequest, TransformationRequest) will be invoked with the actual applied values.

Parameters:transformationRequest - The TransformationRequest.Returns:This builder.

- 

setAudioProcessors

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setAudioProcessors​([List](https://developer.android.com/reference/java/util/List.html "class or interface in java.util")<[AudioProcessor](../audio/AudioProcessor.html "interface in com.google.android.exoplayer2.audio")> audioProcessors)

Deprecated. Set the audio processors in an EditedMediaItem, and pass it to Transformer.start(EditedMediaItem, String) instead.

- 

setVideoEffects

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setVideoEffects​([List](https://developer.android.com/reference/java/util/List.html "class or interface in java.util")<[Effect](../util/Effect.html "interface in com.google.android.exoplayer2.util")> effects)

Deprecated. Set the video effects in an EditedMediaItem, and pass it to Transformer.start(EditedMediaItem, String) instead.

- 

setRemoveAudio

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setRemoveAudio​(boolean removeAudio)

Deprecated. Use EditedMediaItem.Builder.setRemoveAudio(boolean) to remove the audio from the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

- 

setRemoveVideo

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setRemoveVideo​(boolean removeVideo)

Deprecated. Use EditedMediaItem.Builder.setRemoveVideo(boolean) to remove the video from the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

- 

setFlattenForSlowMotion

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setFlattenForSlowMotion​(boolean flattenForSlowMotion)

Deprecated. Use EditedMediaItem.Builder.setFlattenForSlowMotion(boolean) to flatten the EditedMediaItem passed to Transformer.start(EditedMediaItem, String) instead.

- 

setListener

@CanIgnoreReturnValue[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setListener​([Transformer.Listener](Transformer.Listener.html "interface in com.google.android.exoplayer2.transformer")listener)

Deprecated. Use addListener(Listener), removeListener(Listener) or removeAllListeners() instead.

- 

addListener

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")addListener​([Transformer.Listener](Transformer.Listener.html "interface in com.google.android.exoplayer2.transformer")listener)

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

This is equivalent to Transformer.addListener(Listener).

Parameters:listener - A Transformer.Listener.Returns:This builder.

- 

removeListener

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")removeListener​([Transformer.Listener](Transformer.Listener.html "interface in com.google.android.exoplayer2.transformer")listener)

Removes a Transformer.Listener.

This is equivalent to Transformer.removeListener(Listener).

Parameters:listener - A Transformer.Listener.Returns:This builder.

- 

removeAllListeners

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")removeAllListeners()

Removes all listeners.

This is equivalent to Transformer.removeAllListeners().

Returns:This builder.

- 

setAssetLoaderFactory

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setAssetLoaderFactory​([AssetLoader.Factory](AssetLoader.Factory.html "interface in com.google.android.exoplayer2.transformer")assetLoaderFactory)

Sets the AssetLoader.Factory to be used to retrieve the samples to export.

The default value is a DefaultAssetLoaderFactory built with a DefaultMediaSourceFactory and a DefaultDecoderFactory.

Parameters:assetLoaderFactory - An AssetLoader.Factory.Returns:This builder.

- 

setVideoFrameProcessorFactory

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setVideoFrameProcessorFactory​([VideoFrameProcessor.Factory](../util/VideoFrameProcessor.Factory.html "interface in com.google.android.exoplayer2.util")videoFrameProcessorFactory)

Sets the factory to be used to create VideoFrameProcessor instances.

The default value is a DefaultVideoFrameProcessor.Factory built with default values.

Parameters:videoFrameProcessorFactory - A VideoFrameProcessor.Factory.Returns:This builder.

- 

setEncoderFactory

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setEncoderFactory​([Codec.EncoderFactory](Codec.EncoderFactory.html "interface in com.google.android.exoplayer2.transformer")encoderFactory)

Sets the Codec.EncoderFactory that will be used by the transformer.

The default value is a DefaultEncoderFactory instance.

Parameters:encoderFactory - The Codec.EncoderFactory instance.Returns:This builder.

- 

setMuxerFactory

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setMuxerFactory​([Muxer.Factory](Muxer.Factory.html "interface in com.google.android.exoplayer2.transformer")muxerFactory)

Sets the factory for muxers that write the media container.

The default value is a DefaultMuxer.Factory.

Parameters:muxerFactory - A Muxer.Factory.Returns:This builder.

- 

setLooper

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setLooper​([Looper](https://developer.android.com/reference/android/os/Looper.html "class or interface in android.os")looper)

Sets the Looper that must be used for all calls to the transformer and that is used to call listeners on.

The default value is the Looper of the thread that this builder was created on, or if that thread does not have a Looper, the Looper of the application's main thread.

Parameters:looper - A Looper.Returns:This builder.

- 

setDebugViewProvider

@CanIgnoreReturnValue
public[Transformer.Builder](Transformer.Builder.html "class in com.google.android.exoplayer2.transformer")setDebugViewProvider​([DebugViewProvider](../util/DebugViewProvider.html "interface in com.google.android.exoplayer2.util")debugViewProvider)

Sets a provider for views to show diagnostic information (if available) during export.

This is intended for debugging. The default value is DebugViewProvider.NONE, which doesn't show any debug info.

Not all exports will result in debug views being populated.

Parameters:debugViewProvider - Provider for debug views.Returns:This builder.

- 

build

public[Transformer](Transformer.html "class in com.google.android.exoplayer2.transformer")build()

Builds a Transformer instance. Throws:IllegalStateException - If both audio and video have been removed (otherwise the output would not contain any samples).IllegalStateException - If the muxer doesn't support the requested audio/video MIME type.