CompositionPlayer.Builder

public Builder(Context context)

Creates an instance

public CompositionPlayer build()

Builds the CompositionPlayer instance. Must be called at most once.

If no Looper has been called with setLooper, then this method must be called within a Looper thread which is the thread that can access the player instance and where Listener callbacks are dispatched.

@CanIgnoreReturnValue
public CompositionPlayer.Builder experimentalSetEnableReplayableCache(boolean enableReplayableCache)

Sets whether to enable replayable cache.

By default, the replayable cache is not enabled. Enable it to achieve accurate effect update, at the cost of using more power and computing resources.

@CanIgnoreReturnValue
public CompositionPlayer.Builder experimentalSetLateThresholdToDropInputUs(
    long lateThresholdToDropInputUs
)

Sets the late threshold for decoded frames, in microseconds, after which frames may be dropped before applying effects.

The default value is LATE_US_TO_DROP_INPUT_FRAME.

Set this threshold to TIME_UNSET to disable frame dropping before effects are applied.

This method is experimental and will be renamed or removed in a future release.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Sets AudioAttributes that will be used by the player and whether to handle audio focus.

If audio focus should be handled, the usage must be USAGE_MEDIA or USAGE_GAME. Other usages will throw an IllegalArgumentException.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setAudioMixerFactory(AudioMixer.Factory audioMixerFactory)

Sets the AudioMixer.Factory to be used when audio mixing is needed.

The default value is a DefaultAudioMixer.Factory with default values.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setAudioSink(AudioSink audioSink)

Sets the AudioSink that will be used to play out audio.

By default, a DefaultAudioSink with its default configuration is used.

@VisibleForTesting
@CanIgnoreReturnValue
public CompositionPlayer.Builder setClock(Clock clock)

Sets the Clock that will be used by the player.

By default, DEFAULT is used.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setGlObjectsProvider(GlObjectsProvider glObjectsProvider)

Sets the GlObjectsProvider to be used by the effect processing pipeline.

Setting a GlObjectsProvider is no-op if a VideoGraph.Factory is set. By default, a DefaultGlObjectsProvider is used.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setGlThreadExecutorService(ExecutorService glExecutorService)

Sets the ExecutorService to execute GL commands from.

By default, a newSingleThreadScheduledExecutor, owned and shutdown by the effects pipeline is used.

If set, the ExecutorService must be shut down by the caller after CompositionPlayer has been released.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setImageDecoderFactory(ImageDecoder.Factory imageDecoderFactory)

Sets an ImageDecoder.Factory that will create the ImageDecoder instances to decode images.

By default, an instance of BitmapFactoryImageDecoder.Factory is used, with a max output size set to be consistent with Transformer.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setLoadControl(LoadControl loadControl)

Sets the LoadControl that will be used by the player to control buffering of all media items in a Composition.

By default, a DefaultLoadControl is used.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setLooper(Looper looper)

Sets the Looper from which the player can be accessed and Listener callbacks are dispatched too.

By default, the builder uses the looper of the thread that calls build.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setMediaSourceFactory(MediaSource.Factory mediaSourceFactory)

Sets the MediaSource.Factory that *creates* the MediaSource for MediaItems in a Composition.

To use an external image loader, one could create a DefaultMediaSourceFactory, set the external image loader, and pass in the DefaultMediaSourceFactory here.

@CanIgnoreReturnValue
public CompositionPlayer.Builder setVideoGraphFactory(VideoGraph.Factory videoGraphFactory)

Sets the VideoGraph.Factory that will be used by the player.

By default, a SingleInputVideoGraph.Factory is used.