StubExoPlayer

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
public class StubExoPlayer extends StubPlayer implements ExoPlayer

java.lang.Object
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.test.utils.StubPlayer
		↳	androidx.media3.test.utils.StubExoPlayer

An abstract ExoPlayer implementation that throws UnsupportedOperationException from every method.

Summary

Public constructors
`StubExoPlayer()`

Public methods
`void`	`addAnalyticsListener(AnalyticsListener listener)` Adds an `AnalyticsListener` to receive analytics events.
`void`	`addAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Adds a listener to receive audio offload events.
`void`	`addMediaSource(MediaSource mediaSource)` Adds a media source to the end of the playlist.
`void`	`addMediaSource(int index, MediaSource mediaSource)` Adds a media source at the given index of the playlist.
`void`	`addMediaSources(List<MediaSource> mediaSources)` Adds a list of media sources to the end of the playlist.
`void`	`addMediaSources(int index, List<MediaSource> mediaSources)` Adds a list of media sources at the given index of the playlist.
`void`	`clearAuxEffectInfo()` Detaches any previously attached auxiliary audio effect from the underlying audio track.
`void`	`clearCameraMotionListener(CameraMotionListener listener)` Clears the listener which receives camera motion events if it matches the one passed.
`void`	`clearVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Clears the listener which receives video frame metadata events if it matches the one passed.
`PlayerMessage`	`createMessage(PlayerMessage.Target target)` Creates a message that can be sent to a `PlayerMessage.Target`.
`AnalyticsCollector`	`getAnalyticsCollector()` Returns the `AnalyticsCollector` used for collecting analytics events.
`@Nullable DecoderCounters`	`getAudioDecoderCounters()` Returns `DecoderCounters` for audio, or null if no audio is being played.
`@Nullable Format`	`getAudioFormat()` Returns the audio format currently being played, or null if no audio is being played.
`int`	`getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`Clock`	`getClock()` Returns the `Clock` used for playback.
`TrackGroupArray`	`getCurrentTrackGroups()` This method is deprecated. Use `getCurrentTracks`.
`TrackSelectionArray`	`getCurrentTrackSelections()` This method is deprecated. Use `getCurrentTracks`.
`boolean`	`getPauseAtEndOfMediaItems()` Returns whether the player pauses playback at the end of each media item.
`Looper`	`getPlaybackLooper()` Returns the `Looper` associated with the playback thread.
`ExoPlaybackException`	`getPlayerError()` Returns the error that caused playback to fail.
`ExoPlayer.PreloadConfiguration`	`getPreloadConfiguration()` Returns the `preload configuration`.
`Renderer`	`getRenderer(int index)` Returns the renderer at the given index.
`int`	`getRendererCount()` Returns the number of renderers.
`int`	`getRendererType(int index)` Returns the track type that the renderer at a given index handles.
`ScrubbingModeParameters`	`getScrubbingModeParameters()` Gets the parameters that control behavior in `scrubbing mode`.
`SeekParameters`	`getSeekParameters()` Returns the currently active `SeekParameters` of the player.
`boolean`	`getSkipSilenceEnabled()` Returns whether skipping silences in the audio stream is enabled.
`@Nullable TrackSelector`	`getTrackSelector()` Returns the track selector that this player uses, or null if track selection is not supported.
`int`	`getVideoChangeFrameRateStrategy()` Returns the `C.VideoChangeFrameRateStrategy`.
`@Nullable DecoderCounters`	`getVideoDecoderCounters()` Returns `DecoderCounters` for video, or null if no video is being played.
`@Nullable Format`	`getVideoFormat()` Returns the video format currently being played, or null if no video is being played.
`int`	`getVideoScalingMode()` Returns the `C.VideoScalingMode`.
`boolean`	`isReleased()` Returns whether `release` has been called on the player.
`boolean`	`isScrubbingModeEnabled()` Returns whether the player is optimized for scrubbing (many frequent seeks).
`boolean`	`isSleepingForOffload()` Returns whether the player has paused its main loop to save power in offload scheduling mode.
`boolean`	`isTunnelingEnabled()` Returns whether tunneling is enabled for the currently selected tracks.
`void`	`prepare(MediaSource mediaSource)` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`void`	`prepare( MediaSource mediaSource, boolean resetPosition, boolean resetState )` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`void`	`removeAnalyticsListener(AnalyticsListener listener)` Removes an `AnalyticsListener`.
`void`	`removeAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Removes a listener of audio offload events.
`void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Sets the attributes for audio playback, used by the underlying audio track.
`void`	`setAudioSessionId(int audioSessionId)` Sets the ID of the audio session to attach to the underlying `android.media.AudioTrack`.
`void`	`setAuxEffectInfo(AuxEffectInfo auxEffectInfo)` Sets information on an auxiliary audio effect to attach to the underlying audio track.
`void`	`setCameraMotionListener(CameraMotionListener listener)` Sets a listener of camera motion events.
`void`	`setForegroundMode(boolean foregroundMode)` Sets whether the player is allowed to keep holding limited resources such as video decoders, even when in the idle state.
`void`	`setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy)` Sets whether the player should pause automatically when audio is rerouted from a headset to device speakers.
`void`	`setImageOutput(@Nullable ImageOutput imageOutput)` Sets the `ImageOutput` where rendered images will be forwarded.
`void`	`setMediaSource(MediaSource mediaSource)` Clears the playlist, adds the specified `MediaSource` and resets the position to the default position.
`void`	`setMediaSource(MediaSource mediaSource, boolean resetPosition)` Clears the playlist and adds the specified `MediaSource`.
`void`	`setMediaSource(MediaSource mediaSource, long startPositionMs)` Clears the playlist and adds the specified `MediaSource`.
`void`	`setMediaSources(List<MediaSource> mediaSources)` Clears the playlist, adds the specified `MediaSources` and resets the position to the default position.
`void`	`setMediaSources(List<MediaSource> mediaSources, boolean resetPosition)` Clears the playlist and adds the specified `MediaSources`.
`void`	`setMediaSources( List<MediaSource> mediaSources, int startMediaItemIndex, long startPositionMs )` Clears the playlist and adds the specified `MediaSources`.
`void`	`setPauseAtEndOfMediaItems(boolean pauseAtEndOfMediaItems)` Sets whether to pause playback at the end of each media item.
`void`	`setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo)` Sets the preferred audio device.
`void`	`setPreloadConfiguration( ExoPlayer.PreloadConfiguration preloadConfiguration )` Sets the `preload configuration` to configure playlist preloading.
`void`	`setPriority(@C.Priority int priority)` Sets the `C.Priority` for this player.
`void`	`setPriorityTaskManager( @Nullable PriorityTaskManager priorityTaskManager )` Sets a `PriorityTaskManager`, or null to clear a previously set priority task manager.
`void`	`setScrubbingModeEnabled(boolean scrubbingModeEnabled)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`void`	`setScrubbingModeParameters( ScrubbingModeParameters scrubbingModeParameters )` Sets the parameters that control behavior in `scrubbing mode`.
`void`	`setSeekParameters(@Nullable SeekParameters seekParameters)` Sets the parameters that control how seek operations are performed.
`void`	`setShuffleOrder(ShuffleOrder shuffleOrder)` Sets the shuffle order.
`void`	`setSkipSilenceEnabled(boolean skipSilenceEnabled)` Sets whether skipping silences in the audio stream is enabled.
`void`	`setVideoChangeFrameRateStrategy(int videoChangeFrameRateStrategy)` Sets a `C.VideoChangeFrameRateStrategy` that will be used by the player when provided with a video output `Surface`.
`void`	`setVideoEffects(List<Effect> videoEffects)` Sets a `List` of `video effects` that will be applied to each video frame.
`void`	`setVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Sets a listener to receive video frame metadata events.
`void`	`setVideoScalingMode(int videoScalingMode)` Sets the `C.VideoScalingMode`.
`void`	`setWakeMode(int wakeMode)` Sets how the player should keep the device awake for playback when the screen is off.

Inherited Constants

From androidx.media3.exoplayer.ExoPlayer

`static final long`	`@UnstableApi DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000` The default timeout for detaching a surface from the player, in milliseconds.
`static final long`	`@UnstableApi DEFAULT_RELEASE_TIMEOUT_MS = 500` The default timeout for calls to `release` and `setForegroundMode`, in milliseconds.

From androidx.media3.common.Player

`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME = 26` This field is deprecated. Use `COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS = 34` Command to increase and decrease the device volume and mute it with volume flags.
`static final int`	`COMMAND_CHANGE_MEDIA_ITEMS = 20` Command to change the `media items` in the playlist.
`static final int`	`COMMAND_GET_AUDIO_ATTRIBUTES = 21` Command to get the player current `AudioAttributes`.
`static final int`	`COMMAND_GET_CURRENT_MEDIA_ITEM = 16` Command to get information about the currently playing `MediaItem`.
`static final int`	`COMMAND_GET_DEVICE_VOLUME = 23` Command to get the device volume and whether it is muted.
`static final int`	`COMMAND_GET_MEDIA_ITEMS_METADATA = 18` This field is deprecated. Use `COMMAND_GET_METADATA` instead.
`static final int`	`COMMAND_GET_METADATA = 18` Command to get metadata related to the playlist and current `MediaItem`.
`static final int`	`COMMAND_GET_TEXT = 28` Command to get the text that should currently be displayed by the player.
`static final int`	`COMMAND_GET_TIMELINE = 17` Command to get the information about the current timeline.
`static final int`	`COMMAND_GET_TRACKS = 30` Command to get details of the current track selection.
`static final int`	`COMMAND_GET_VOLUME = 22` Command to get the player volume.
`static final int`	`COMMAND_INVALID = -1` Represents an invalid `Command`.
`static final int`	`COMMAND_PLAY_PAUSE = 1` Command to start, pause or resume playback.
`static final int`	`COMMAND_PREPARE = 2` Command to prepare the player.
`static final int`	`COMMAND_RELEASE = 32` Command to release the player.
`static final int`	`COMMAND_SEEK_BACK = 11` Command to seek back by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_FORWARD = 12` Command to seek forward by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM = 5` Command to seek anywhere inside the current `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_IN_CURRENT_WINDOW = 5` This field is deprecated. Use `COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_DEFAULT_POSITION = 4` Command to seek to the default position of the current `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_MEDIA_ITEM = 10` Command to seek anywhere in any `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT = 9` Command to seek to a later position in the current `MediaItem` or the default position of the next `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT_MEDIA_ITEM = 8` Command to seek to the default position of the next `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_NEXT_WINDOW = 8` This field is deprecated. Use `COMMAND_SEEK_TO_NEXT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS = 7` Command to seek to an earlier position in the current `MediaItem` or the default position of the previous `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM = 6` Command to seek to the default position of the previous `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_PREVIOUS_WINDOW = 6` This field is deprecated. Use `COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM` instead.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_WINDOW = 10` This field is deprecated. Use `COMMAND_SEEK_TO_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SET_AUDIO_ATTRIBUTES = 35` Command to set the player's audio attributes.
`static final int`	`COMMAND_SET_DEVICE_VOLUME = 25` This field is deprecated. Use `COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS = 33` Command to set the device volume with volume flags.
`static final int`	`COMMAND_SET_MEDIA_ITEM = 31` Command to set a `MediaItem`.
`static final int`	`COMMAND_SET_MEDIA_ITEMS_METADATA = 19` This field is deprecated. Use `COMMAND_SET_PLAYLIST_METADATA` instead.
`static final int`	`COMMAND_SET_PLAYLIST_METADATA = 19` Command to set the playlist metadata.
`static final int`	`COMMAND_SET_REPEAT_MODE = 15` Command to set the repeat mode.
`static final int`	`COMMAND_SET_SHUFFLE_MODE = 14` Command to enable shuffling.
`static final int`	`COMMAND_SET_SPEED_AND_PITCH = 13` Command to set the playback speed and pitch.
`static final int`	`COMMAND_SET_TRACK_SELECTION_PARAMETERS = 29` Command to set the player's track selection parameters.
`static final int`	`COMMAND_SET_VIDEO_SURFACE = 27` Command to set and clear the surface on which to render the video.
`static final int`	`COMMAND_SET_VOLUME = 24` Command to set the player volume.
`static final int`	`COMMAND_STOP = 3` Command to stop playback.
`static final int`	`DISCONTINUITY_REASON_AUTO_TRANSITION = 0` Automatic playback transition from one period in the timeline to the next.
`static final int`	`DISCONTINUITY_REASON_INTERNAL = 5` Discontinuity introduced internally (e.g. by the source).
`static final int`	`DISCONTINUITY_REASON_REMOVE = 4` Discontinuity caused by the removal of the current period from the `Timeline`.
`static final int`	`DISCONTINUITY_REASON_SEEK = 1` Seek within the current period or to another period.
`static final int`	`DISCONTINUITY_REASON_SEEK_ADJUSTMENT = 2` Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.
`static final int`	`DISCONTINUITY_REASON_SILENCE_SKIP = 6` Discontinuity introduced by a skipped silence.
`static final int`	`DISCONTINUITY_REASON_SKIP = 3` Discontinuity introduced by a skipped period (for instance a skipped ad).
`static final int`	`EVENT_AUDIO_ATTRIBUTES_CHANGED = 20` `getAudioAttributes` changed.
`static final int`	`EVENT_AUDIO_SESSION_ID = 21` The audio session id was set.
`static final int`	`EVENT_AVAILABLE_COMMANDS_CHANGED = 13` `isCommandAvailable` changed for at least one `Command`.
`static final int`	`EVENT_CUES = 27` `getCurrentCues` changed.
`static final int`	`EVENT_DEVICE_INFO_CHANGED = 29` `getDeviceInfo` changed.
`static final int`	`EVENT_DEVICE_VOLUME_CHANGED = 30` `getDeviceVolume` or `isDeviceMuted` changed.
`static final int`	`EVENT_IS_LOADING_CHANGED = 3` `isLoading` ()} changed.
`static final int`	`EVENT_IS_PLAYING_CHANGED = 7` `isPlaying` changed.
`static final int`	`EVENT_MAX_SEEK_TO_PREVIOUS_POSITION_CHANGED = 18` `getMaxSeekToPreviousPosition` changed.
`static final int`	`EVENT_MEDIA_ITEM_TRANSITION = 1` `getCurrentMediaItem` changed or the player started repeating the current item.
`static final int`	`EVENT_MEDIA_METADATA_CHANGED = 14` `getMediaMetadata` changed.
`static final int`	`EVENT_METADATA = 28` Metadata associated with the current playback time changed.
`static final int`	`EVENT_PLAYBACK_PARAMETERS_CHANGED = 12` `getPlaybackParameters` changed.
`static final int`	`EVENT_PLAYBACK_STATE_CHANGED = 4` `getPlaybackState` changed.
`static final int`	`EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED = 6` `getPlaybackSuppressionReason` changed.
`static final int`	`EVENT_PLAYER_ERROR = 10` `getPlayerError` changed.
`static final int`	`EVENT_PLAYLIST_METADATA_CHANGED = 15` `getPlaylistMetadata` changed.
`static final int`	`EVENT_PLAY_WHEN_READY_CHANGED = 5` `getPlayWhenReady` changed.
`static final int`	`EVENT_POSITION_DISCONTINUITY = 11` A position discontinuity occurred.
`static final int`	`EVENT_RENDERED_FIRST_FRAME = 26` A frame is rendered for the first time since setting the surface, or since the renderer was reset, or since the stream being rendered was changed.
`static final int`	`EVENT_REPEAT_MODE_CHANGED = 8` `getRepeatMode` changed.
`static final int`	`EVENT_SEEK_BACK_INCREMENT_CHANGED = 16` `getSeekBackIncrement` changed.
`static final int`	`EVENT_SEEK_FORWARD_INCREMENT_CHANGED = 17` `getSeekForwardIncrement` changed.
`static final int`	`EVENT_SHUFFLE_MODE_ENABLED_CHANGED = 9` `getShuffleModeEnabled` changed.
`static final int`	`EVENT_SKIP_SILENCE_ENABLED_CHANGED = 23` Skipping silences in the audio stream is enabled or disabled.
`static final int`	`EVENT_SURFACE_SIZE_CHANGED = 24` The size of the surface onto which the video is being rendered changed.
`static final int`	`EVENT_TIMELINE_CHANGED = 0` `getCurrentTimeline` changed.
`static final int`	`EVENT_TRACKS_CHANGED = 2` `getCurrentTracks` changed.
`static final int`	`EVENT_TRACK_SELECTION_PARAMETERS_CHANGED = 19` `getTrackSelectionParameters` changed.
`static final int`	`EVENT_VIDEO_SIZE_CHANGED = 25` `getVideoSize` changed.
`static final int`	`EVENT_VOLUME_CHANGED = 22` `getVolume` changed.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_AUTO = 1` Playback has automatically transitioned to the next media item.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED = 3` The current media item has changed because of a change in the playlist.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_REPEAT = 0` The media item has been repeated.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_SEEK = 2` A seek to another media item has occurred.
`static final int`

StubExoPlayer

Summary

Public constructors

Public methods

Inherited Constants