ExoPlayerTestRunner (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.testutil.ExoPlayerTestRunner

All Implemented Interfaces:: Player.EventListener, ActionSchedule.Callback

public final class ExoPlayerTestRunner
extends Object
implements Player.EventListener, ActionSchedule.Callback

Helper class to run an ExoPlayer test.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ExoPlayerTestRunner.Builder
Builder to set-up a ExoPlayerTestRunner.

Nested Classes
Modifier and Type	Class	Description
`static class`	`ExoPlayerTestRunner.Builder`	Builder to set-up a `ExoPlayerTestRunner`.

Field Summary

Fields
Modifier and Type	Field	Description
`static Format`	`AUDIO_FORMAT`	A generic audio `Format` which can be used to set up a `FakeMediaSource`.
`static Format`	`VIDEO_FORMAT`	A generic video `Format` which can be used to set up a `FakeMediaSource`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`assertMediaItemsTransitionedSame(MediaItem... mediaItems)`	Asserts that the media items reported by `Player.EventListener.onMediaItemTransition(MediaItem, int)` are the same as the provided media items.
`void`	`assertMediaItemsTransitionReasonsEqual(Integer... reasons)`	Asserts that the media item transition reasons reported by `Player.EventListener.onMediaItemTransition(MediaItem, int)` are the same as the provided reasons.
`void`	`assertNoPositionDiscontinuities()`	Asserts that `Player.EventListener.onPositionDiscontinuity(int)` was not called.
`void`	`assertPlaybackStatesEqual(Integer... states)`	Asserts that the playback states reported by `Player.EventListener.onPlaybackStateChanged(int)` are equal to the provided playback states.
`void`	`assertPlayedPeriodIndices(Integer... periodIndices)`	Asserts that the indices of played periods is equal to the provided list of periods.
`void`	`assertPositionDiscontinuityReasonsEqual(Integer... discontinuityReasons)`	Asserts that the discontinuity reasons reported by `Player.EventListener.onPositionDiscontinuity(int)` are equal to the provided values.
`void`	`assertTimelineChangeReasonsEqual(Integer... reasons)`	Asserts that the timeline change reasons reported by `Player.EventListener.onTimelineChanged(Timeline, int)` are equal to the provided timeline change reasons.
`void`	`assertTimelinesSame(Timeline... timelines)`	Asserts that the timelines reported by `Player.EventListener.onTimelineChanged(Timeline, int)` are the same to the provided timelines.
`void`	`assertTrackGroupsEqual(TrackGroupArray trackGroupArray)`	Asserts that the last track group array reported by `Player.EventListener.onTracksChanged(TrackGroupArray, TrackSelectionArray)` is equal to the provided track group array.
`ExoPlayerTestRunner`	`blockUntilActionScheduleFinished(long timeoutMs)`	Blocks the current thread until the action schedule finished.
`ExoPlayerTestRunner`	`blockUntilEnded(long timeoutMs)`	Blocks the current thread until the test runner finishes.
`void`	`onActionScheduleFinished()`	Called when action schedule finished executing all its actions.
`void`	`onMediaItemTransition(MediaItem mediaItem, int reason)`	Called when playback transitions to a media item or starts repeating a media item according to the current `repeat mode`.
`void`	`onPlaybackStateChanged(int playbackState)`	Called when the value returned from `Player.getPlaybackState()` changes.
`void`	`onPlayerError(ExoPlaybackException error)`	Called when an error occurs.
`void`	`onPositionDiscontinuity(int reason)`	Called when a position discontinuity occurs without a change to the timeline.
`void`	`onTimelineChanged(Timeline timeline, int reason)`	Called when the timeline has been refreshed.
`void`	`onTracksChanged(TrackGroupArray trackGroups, TrackSelectionArray trackSelections)`	Called when the available or selected tracks change.
`ExoPlayerTestRunner`	`start()`	Starts the test runner on its own thread.
`ExoPlayerTestRunner`	`start(boolean doPrepare)`	Starts the test runner on its own thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.android.exoplayer2.Player.EventListener
onEvents, onExperimentalOffloadSchedulingEnabledChanged, onExperimentalSleepingForOffloadChanged, onIsLoadingChanged, onIsPlayingChanged, onLoadingChanged, onPlaybackParametersChanged, onPlaybackSuppressionReasonChanged, onPlayerStateChanged, onPlayWhenReadyChanged, onRepeatModeChanged, onSeekProcessed, onShuffleModeEnabledChanged, onStaticMetadataChanged, onTimelineChanged

- Field Detail
  - VIDEO_FORMAT
```
public static final Format VIDEO_FORMAT
```
    A generic video Format which can be used to set up a FakeMediaSource.
  - AUDIO_FORMAT
```
public static final Format AUDIO_FORMAT
```
    A generic audio Format which can be used to set up a FakeMediaSource.
- Method Detail
  - start
```
public ExoPlayerTestRunner start()
```
    Starts the test runner on its own thread. This will trigger the creation of the player, the listener registration, the start of the action schedule, the initial set of media items and the preparation of the player.
    
    Returns:
    
    This test runner.
  - start
```
public ExoPlayerTestRunner start(boolean doPrepare)
```
    Starts the test runner on its own thread. This will trigger the creation of the player, the listener registration, the start of the action schedule and the initial set of media items.
    
    Parameters:
    
    doPrepare - Whether the player should be prepared.
    
    Returns:
    
    This test runner.
  - blockUntilEnded
```
public ExoPlayerTestRunner blockUntilEnded(long timeoutMs)
                                    throws Exception
```
    Blocks the current thread until the test runner finishes. A test is deemed to be finished when the playback state transitioned to Player.STATE_ENDED or Player.STATE_IDLE for the specified number of times. The test also finishes when an ExoPlaybackException is thrown.
    
    Parameters:
    
    timeoutMs - The maximum time to wait for the test runner to finish. If this time elapsed the method will throw a TimeoutException.
    
    Returns:
    
    This test runner.
    
    Throws:
    
    Exception - If any exception occurred during playback, release, or due to a timeout.
  - blockUntilActionScheduleFinished
```
public ExoPlayerTestRunner blockUntilActionScheduleFinished(long timeoutMs)
                                                     throws TimeoutException,
                                                            InterruptedException
```
    Blocks the current thread until the action schedule finished. This does not release the test runner and the test must still call blockUntilEnded(long).
    
    Parameters:
    
    timeoutMs - The maximum time to wait for the action schedule to finish.
    
    Returns:
    
    This test runner.
    
    Throws:
    
    TimeoutException - If the action schedule did not finish within the specified timeout.
    
    InterruptedException - If the test thread gets interrupted while waiting.
  - assertTimelinesSame
```
public void assertTimelinesSame(Timeline... timelines)
```
    Asserts that the timelines reported by Player.EventListener.onTimelineChanged(Timeline, int) are the same to the provided timelines. This assert differs from testing equality by not comparing period ids which may be different due to id mapping of child source period ids.
    
    Parameters:
    
    timelines - A list of expected Timelines.
  - assertTimelineChangeReasonsEqual
```
public void assertTimelineChangeReasonsEqual(Integer... reasons)
```
    Asserts that the timeline change reasons reported by Player.EventListener.onTimelineChanged(Timeline, int) are equal to the provided timeline change reasons.
  - assertMediaItemsTransitionedSame
```
public void assertMediaItemsTransitionedSame(MediaItem... mediaItems)
```
    Asserts that the media items reported by Player.EventListener.onMediaItemTransition(MediaItem, int) are the same as the provided media items.
    
    Parameters:
    
    mediaItems - A list of expected media items.
  - assertMediaItemsTransitionReasonsEqual
```
public void assertMediaItemsTransitionReasonsEqual(Integer... reasons)
```
    Asserts that the media item transition reasons reported by Player.EventListener.onMediaItemTransition(MediaItem, int) are the same as the provided reasons.
    
    Parameters:
    
    reasons - A list of expected transition reasons.
  - assertPlaybackStatesEqual
```
public void assertPlaybackStatesEqual(Integer... states)
```
    Asserts that the playback states reported by Player.EventListener.onPlaybackStateChanged(int) are equal to the provided playback states.
  - assertTrackGroupsEqual
```
public void assertTrackGroupsEqual(TrackGroupArray trackGroupArray)
```
    Asserts that the last track group array reported by Player.EventListener.onTracksChanged(TrackGroupArray, TrackSelectionArray) is equal to the provided track group array.
    
    Parameters:
    
    trackGroupArray - The expected TrackGroupArray.
  - assertNoPositionDiscontinuities
```
public void assertNoPositionDiscontinuities()
```
    Asserts that Player.EventListener.onPositionDiscontinuity(int) was not called.
  - assertPositionDiscontinuityReasonsEqual
```
public void assertPositionDiscontinuityReasonsEqual(Integer... discontinuityReasons)
```
    Asserts that the discontinuity reasons reported by Player.EventListener.onPositionDiscontinuity(int) are equal to the provided values.
    
    Parameters:
    
    discontinuityReasons - The expected discontinuity reasons.
  - assertPlayedPeriodIndices
```
public void assertPlayedPeriodIndices(Integer... periodIndices)
```
    Asserts that the indices of played periods is equal to the provided list of periods. A period is considered to be played if it was the current period after a position discontinuity or a media source preparation. When the same period is repeated automatically due to enabled repeat modes, it is reported twice. Seeks within the current period are not reported.
    
    Parameters:
    
    periodIndices - A list of expected period indices.
  - onTimelineChanged
```
public void onTimelineChanged(Timeline timeline,
                              @TimelineChangeReason
                              int reason)
```
    Description copied from interface: Player.EventListener
    
    Called when the timeline has been refreshed.
    Note that if the timeline has changed then a position discontinuity may also have occurred. For example, the current period index may have changed as a result of periods being added or removed from the timeline. This will not be reported via a separate call to Player.EventListener.onPositionDiscontinuity(int).
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onTimelineChanged in interface Player.EventListener
    
    Parameters:
    
    timeline - The latest timeline. Never null, but may be empty.
    
    reason - The Player.TimelineChangeReason responsible for this timeline change.
  - onMediaItemTransition
```
public void onMediaItemTransition(@Nullable
                                  MediaItem mediaItem,
                                  @MediaItemTransitionReason
                                  int reason)
```
    Description copied from interface: Player.EventListener
    
    Called when playback transitions to a media item or starts repeating a media item according to the current repeat mode.
    Note that this callback is also called when the playlist becomes non-empty or empty as a consequence of a playlist change.
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onMediaItemTransition in interface Player.EventListener
    
    Parameters:
    
    mediaItem - The MediaItem. May be null if the playlist becomes empty.
    
    reason - The reason for the transition.
  - onTracksChanged
```
public void onTracksChanged(TrackGroupArray trackGroups,
                            TrackSelectionArray trackSelections)
```
    Description copied from interface: Player.EventListener
    
    Called when the available or selected tracks change.
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onTracksChanged in interface Player.EventListener
    
    Parameters:
    
    trackGroups - The available tracks. Never null, but may be of length zero.
    
    trackSelections - The track selections for each renderer. Never null and always of length Player.getRendererCount(), but may contain null elements.
  - onPlaybackStateChanged
```
public void onPlaybackStateChanged(@State
                                   int playbackState)
```
    Description copied from interface: Player.EventListener
    
    Called when the value returned from Player.getPlaybackState() changes.
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onPlaybackStateChanged in interface Player.EventListener
    
    Parameters:
    
    playbackState - The new playback state.
  - onPlayerError
```
public void onPlayerError(ExoPlaybackException error)
```
    Description copied from interface: Player.EventListener
    
    Called when an error occurs. The playback state will transition to Player.STATE_IDLE immediately after this method is called. The player instance can still be used, and Player.release() must still be called on the player should it no longer be required.
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onPlayerError in interface Player.EventListener
    
    Parameters:
    
    error - The error.
  - onPositionDiscontinuity
```
public void onPositionDiscontinuity(@DiscontinuityReason
                                    int reason)
```
    Description copied from interface: Player.EventListener
    
    Called when a position discontinuity occurs without a change to the timeline. A position discontinuity occurs when the current window or period index changes (as a result of playback transitioning from one period in the timeline to the next), or when the playback position jumps within the period currently being played (as a result of a seek being performed, or when the source introduces a discontinuity internally).
    When a position discontinuity occurs as a result of a change to the timeline this method is not called. Player.EventListener.onTimelineChanged(Timeline, int) is called in this case.
    Player.EventListener.onEvents(Player, Events) will also be called to report this event along with other events that happen in the same Looper message queue iteration.
    
    Specified by:
    
    onPositionDiscontinuity in interface Player.EventListener
    
    Parameters:
    
    reason - The Player.DiscontinuityReason responsible for the discontinuity.
  - onActionScheduleFinished
```
public void onActionScheduleFinished()
```
    Description copied from interface: ActionSchedule.Callback
    
    Called when action schedule finished executing all its actions.
    
    Specified by:
    
    onActionScheduleFinished in interface ActionSchedule.Callback

Class ExoPlayerTestRunner

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.android.exoplayer2.Player.EventListener

Field Detail

VIDEO_FORMAT

AUDIO_FORMAT

Method Detail

start

start

blockUntilEnded

blockUntilActionScheduleFinished

assertTimelinesSame

assertTimelineChangeReasonsEqual

assertMediaItemsTransitionedSame

assertMediaItemsTransitionReasonsEqual

assertPlaybackStatesEqual

assertTrackGroupsEqual

assertNoPositionDiscontinuities

assertPositionDiscontinuityReasonsEqual

assertPlayedPeriodIndices

onTimelineChanged

onMediaItemTransition

onTracksChanged

onPlaybackStateChanged

onPlayerError

onPositionDiscontinuity

onActionScheduleFinished