Effects

Artifact: androidx.media3:media3-transformer

Kotlin |Java

@UnstableApi
class Effects

Effects to apply to a MediaItem or to a Composition.

Summary

Constants
`const Effects!`	`EMPTY` An empty `Effects` instance.

Public constructors
`Effects( audioProcessors: (Mutable)List<AudioProcessor!>!, videoEffects: (Mutable)List<Effect!>! )` Creates an instance.

Public functions
`java-static Pair<AudioProcessor!, Effect!>!`	`createExperimentalSpeedChangingEffect(speedProvider: SpeedProvider!)` This function is deprecated. Use `setSpeed` instead.
`String!`	`toString()`

Public functions

java-static Pair<AudioProcessor!, Effect!>!

createExperimentalSpeedChangingEffect(speedProvider: SpeedProvider!)

This function is deprecated.

Use setSpeed instead.

String!

toString()

Public properties
`ImmutableList<AudioProcessor!>!`	`audioProcessors` The list of `audio processors` to apply to audio buffers.
`ImmutableList<Effect!>!`	`videoEffects` The list of `video effects` to apply to each frame.

Constants

EMPTY

const val EMPTY: Effects!

An empty Effects instance.

Public constructors

Effects

Effects(
    audioProcessors: (Mutable)List<AudioProcessor!>!,
    videoEffects: (Mutable)List<Effect!>!
)

Creates an instance.

Parameters
`audioProcessors: (Mutable)List<AudioProcessor!>!`	The `audioProcessors`.
`videoEffects: (Mutable)List<Effect!>!`	The `videoEffects`.

Public functions

createExperimentalSpeedChangingEffect

java-static fun createExperimentalSpeedChangingEffect(speedProvider: SpeedProvider!): Pair<AudioProcessor!, Effect!>!

Creates an interlinked audio processor and video effect that changes the speed of media samples in segments of the input file specified by the given SpeedProvider.

The audio processor and video effect are interlinked to help maintain A/V sync. When using Transformer, if the input file doesn't have audio, or audio is being removed, you may have to include TRACK_TYPE_AUDIO in the trackTypes of the EditedMediaItemSequence for the interlinked effects to function correctly. Alternatively, you can use SpeedChangeEffect when the input has no audio.

Parameters
`speedProvider: SpeedProvider!`	The `SpeedProvider` determining the speed for the media at specific timestamps.

toString

fun toString(): String!

Public properties

audioProcessors

val audioProcessors: ImmutableList<AudioProcessor!>!

The list of audio processors to apply to audio buffers. They are applied in the order of the list, and buffers will only be modified by that AudioProcessor if it isActive based on the current configuration.

videoEffects

val videoEffects: ImmutableList<Effect!>!

The list of video effects to apply to each frame. They are applied in the order of the list.