ScrubbingModeContractTest

Artifact: androidx.media3:media3-test-utils-robolectric

View Source

---

Kotlin |Java

@UnstableApi
abstract class ScrubbingModeContractTest

---

A collection of contract tests for Player implementations that support COMMAND_SET_AUDIO_ATTRIBUTES and scrubbing mode.

Subclasses should only include the logic necessary to construct the Player and provide access to relevant methods and internals by overriding createPlayerInfo.

Subclasses shouldn't include any new @Test methods - implementation-specific tests should be in a separate class.

Summary

Nested types
interface ScrubbingModeContractTest.PlayerInfo Interface that allows access to a Player instance, relevant internals, and other methods not implemented within the Player interface required for testing.

Public constructors
ScrubbingModeContractTest()

Public functions
Unit	@Test audioFocusLoss_whileScrubbing_setsPlayWhenReadyToFalse()
Unit	@Test disableScrubbing_afterLossOfAudioFocusWhileScrubbing_handlesDeniedFocusRequest( )
Unit	@Test disableScrubbing_afterTransientAudioFocusLoss_handlesDeniedFocusRequest( )
Unit	@Test disableScrubbing_afterTransientAudioFocusLoss_requestsAudioFocus()
Unit	@Test disableScrubbing_audioFocusLostWhileScrubbingWhenPreviouslyPlaying_playsWithGrantedAudioFocus( )
Unit	@Test disableScrubbing_whilePaused_updatesSuppressionReasonAndDoesNotPlay()
Unit	@Test disableScrubbing_whilePlaying_updatesPlaybackSuppressionReason()
Unit	@Test enableScrubbingMode_updatesPlaybackSuppressionReason()
Unit	@Test recoverAudioFocus_afterTransientLossWhileScrubbing_returnsToScrubbingSuppression( )
Unit	@After tearDown()
Unit	@Test transientAudioFocusLoss_whileScrubbing_onlyUpdatesSuppressionReason()

Protected functions
abstract ScrubbingModeContractTest.PlayerInfo!	@ForOverride createPlayerInfo() Creates and returns the PlayerInfo with which to run the tests.

Public constructors

ScrubbingModeContractTest

ScrubbingModeContractTest()

Public functions

audioFocusLoss_whileScrubbing_setsPlayWhenReadyToFalse

@Test
fun audioFocusLoss_whileScrubbing_setsPlayWhenReadyToFalse(): Unit

Throws
java.lang.Exception

disableScrubbing_afterLossOfAudioFocusWhileScrubbing_handlesDeniedFocusRequest

@Test
fun disableScrubbing_afterLossOfAudioFocusWhileScrubbing_handlesDeniedFocusRequest(

): Unit

Throws
java.lang.Exception

disableScrubbing_afterTransientAudioFocusLoss_handlesDeniedFocusRequest

@Test
fun disableScrubbing_afterTransientAudioFocusLoss_handlesDeniedFocusRequest(

): Unit

Throws
java.lang.Exception

disableScrubbing_afterTransientAudioFocusLoss_requestsAudioFocus

@Test
fun disableScrubbing_afterTransientAudioFocusLoss_requestsAudioFocus(): Unit

Throws
java.lang.Exception

disableScrubbing_audioFocusLostWhileScrubbingWhenPreviouslyPlaying_playsWithGrantedAudioFocus

@Test
fun disableScrubbing_audioFocusLostWhileScrubbingWhenPreviouslyPlaying_playsWithGrantedAudioFocus(

): Unit

Throws
java.lang.Exception

disableScrubbing_whilePaused_updatesSuppressionReasonAndDoesNotPlay

@Test
fun disableScrubbing_whilePaused_updatesSuppressionReasonAndDoesNotPlay(): Unit

disableScrubbing_whilePlaying_updatesPlaybackSuppressionReason

@Test
fun disableScrubbing_whilePlaying_updatesPlaybackSuppressionReason(): Unit

enableScrubbingMode_updatesPlaybackSuppressionReason

@Test
fun enableScrubbingMode_updatesPlaybackSuppressionReason(): Unit

recoverAudioFocus_afterTransientLossWhileScrubbing_returnsToScrubbingSuppression

@Test
fun recoverAudioFocus_afterTransientLossWhileScrubbing_returnsToScrubbingSuppression(

): Unit

Throws
java.lang.Exception

tearDown

@After
fun tearDown(): Unit

transientAudioFocusLoss_whileScrubbing_onlyUpdatesSuppressionReason

@Test
fun transientAudioFocusLoss_whileScrubbing_onlyUpdatesSuppressionReason(): Unit

Throws
java.lang.Exception

Protected functions

createPlayerInfo

@ForOverride
protected abstract fun createPlayerInfo(): ScrubbingModeContractTest.PlayerInfo!

Creates and returns the PlayerInfo with which to run the tests.

The player must have audio focus handling and scrubbing mode initially disabled.