Action

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
abstract class Action

Known direct subclasses

`Action.AddMediaItems`	Calls `addMediaSources`.
`Action.ClearMediaItems`	Calls `clearMediaItems`}.
`Action.ClearVideoSurface`	Calls `clearVideoSurface`.
`Action.ExecuteRunnable`	Calls `Runnable.run()`.
`Action.MoveMediaItem`	Calls `moveMediaItem`.
`Action.PlayUntilPosition`	Schedules a play action to be executed, waits until the player reaches the specified position, and pauses the player again.
`Action.Prepare`	Calls `prepare`.
`Action.RemoveMediaItem`	Calls `removeMediaItem`.
`Action.RemoveMediaItems`	Calls `removeMediaItems`.
`Action.Seek`	Calls `seekTo` or `seekTo`.
`Action.SendMessages`	Calls `createMessage` and `send`.
`Action.SetAudioAttributes`	Calls `setAudioAttributes`.
`Action.SetMediaItemsResetPosition`	Calls `setMediaSources`.
`Action.SetMediaItems`	Calls `setMediaSources`.
`Action.SetPlayWhenReady`	Calls `setPlayWhenReady`.
`Action.SetPlaybackParameters`	Calls `setPlaybackParameters`.
`Action.SetRendererDisabled`	Updates the `Parameters` of a `DefaultTrackSelector` to specify whether the renderer at a given index should be disabled.
`Action.SetRepeatMode`	Calls `setRepeatMode`.
`Action.SetShuffleModeEnabled`	Calls `setShuffleModeEnabled`.
`Action.SetShuffleOrder`	Calls `setShuffleOrder` .
`Action.SetVideoSurface`	Calls `setVideoSurface`.
`Action.Stop`	Calls `stop`.
`Action.ThrowPlaybackException`	Throws a playback exception on the playback thread.
`Action.WaitForIsLoading`	Waits for a specified loading state, returning either immediately or after a call to `onIsLoadingChanged`.
`Action.WaitForMessage`	Waits for a player message to arrive.
`Action.WaitForPendingPlayerCommands`	Waits until the player acknowledged all pending player commands.
`Action.WaitForPlayWhenReady`	Waits for a specified playWhenReady value, returning either immediately or after a call to `onPlayWhenReadyChanged`.
`Action.WaitForPlaybackState`	Waits for a specified playback state, returning either immediately or after a call to `onPlaybackStateChanged`.
`Action.WaitForPositionDiscontinuity`	Waits for `onPositionDiscontinuity`.
`Action.WaitForTimelineChanged`	Waits for `onTimelineChanged`.

Base class for actions to perform during playback tests.

Summary

Nested types
`class Action.AddMediaItems : Action` Calls `addMediaSources`.
`class Action.ClearMediaItems : Action` Calls `clearMediaItems`}.
`class Action.ClearVideoSurface : Action` Calls `clearVideoSurface`.
`class Action.ExecuteRunnable : Action` Calls `Runnable.run()`.
`class Action.MoveMediaItem : Action` Calls `moveMediaItem`.
`class Action.PlayUntilPosition : Action` Schedules a play action to be executed, waits until the player reaches the specified position, and pauses the player again.
`class Action.Prepare : Action` Calls `prepare`.
`class Action.RemoveMediaItem : Action` Calls `removeMediaItem`.
`class Action.RemoveMediaItems : Action` Calls `removeMediaItems`.
`class Action.Seek : Action` Calls `seekTo` or `seekTo`.
`class Action.SendMessages : Action` Calls `createMessage` and `send`.
`class Action.SetAudioAttributes : Action` Calls `setAudioAttributes`.
`class Action.SetMediaItems : Action` Calls `setMediaSources`.
`class Action.SetMediaItemsResetPosition : Action` Calls `setMediaSources`.
`class Action.SetPlayWhenReady : Action` Calls `setPlayWhenReady`.
`class Action.SetPlaybackParameters : Action` Calls `setPlaybackParameters`.
`class Action.SetRendererDisabled : Action` Updates the `Parameters` of a `DefaultTrackSelector` to specify whether the renderer at a given index should be disabled.
`class Action.SetRepeatMode : Action` Calls `setRepeatMode`.
`class Action.SetShuffleModeEnabled : Action` Calls `setShuffleModeEnabled`.
`class Action.SetShuffleOrder : Action` Calls `setShuffleOrder` .
`class Action.SetVideoSurface : Action` Calls `setVideoSurface`.
`class Action.Stop : Action` Calls `stop`.
`class Action.ThrowPlaybackException : Action` Throws a playback exception on the playback thread.
`class Action.WaitForIsLoading : Action` Waits for a specified loading state, returning either immediately or after a call to `onIsLoadingChanged`.
`class Action.WaitForMessage : Action` Waits for a player message to arrive.
`class Action.WaitForPendingPlayerCommands : Action` Waits until the player acknowledged all pending player commands.
`class Action.WaitForPlayWhenReady : Action` Waits for a specified playWhenReady value, returning either immediately or after a call to `onPlayWhenReadyChanged`.
`class Action.WaitForPlaybackState : Action` Waits for a specified playback state, returning either immediately or after a call to `onPlaybackStateChanged`.
`class Action.WaitForPositionDiscontinuity : Action` Waits for `onPositionDiscontinuity`.
`class Action.WaitForTimelineChanged : Action` Waits for `onTimelineChanged`.

Public constructors
`Action(tag: @Size(max = 23) String!, description: String?)`

Protected functions
`abstract Unit`	`doActionImpl( player: ExoPlayer!, trackSelector: DefaultTrackSelector!, surface: Surface? )` Called by `doActionAndScheduleNextImpl` to perform the action.

Public constructors

Action

Action(tag: @Size(max = 23) String!, description: String?)

Parameters
`tag: @Size(max = 23) String!`	A tag to use for logging.
`description: String?`	A description to be logged when the action is executed, or null if no logging is required.

Protected functions

doActionImpl

protected abstract fun doActionImpl(
    player: ExoPlayer!,
    trackSelector: DefaultTrackSelector!,
    surface: Surface?
): Unit

Called by doActionAndScheduleNextImpl to perform the action.

Parameters
`player: ExoPlayer!`	The player to which the action should be applied.
`trackSelector: DefaultTrackSelector!`	The track selector to which the action should be applied.
`surface: Surface?`	The surface to use when applying actions, or `null` if no surface is needed.

Action

Summary

Nested types

Public constructors

Protected functions

Public constructors

Action

Protected functions

doActionImpl