duckplayer-api/com.duckduckgo.duckplayer.api/DuckPlayer

DuckPlayer

interface DuckPlayer

DuckPlayer interface provides a set of methods for interacting with the DuckPlayer.

Types

DuckPlayerOrigin

enum DuckPlayerOrigin : Enum<DuckPlayer.DuckPlayerOrigin>

DuckPlayerState

enum DuckPlayerState : Enum<DuckPlayer.DuckPlayerState>

OpenDuckPlayerInNewTab

interface OpenDuckPlayerInNewTab

UserPreferences

data class UserPreferences(val overlayInteracted: Boolean, val privatePlayerMode: PrivatePlayerMode)

Data class representing user preferences for Duck Player.

Functions

createDuckPlayerUriFromYoutubeNoCookie

abstract fun createDuckPlayerUriFromYoutubeNoCookie(uri: Uri): String?

Creates a DuckPlayer URI from a YouTube no-cookie URI.

createYoutubeWatchUrlFromDuckPlayer

abstract fun createYoutubeWatchUrlFromDuckPlayer(uri: Uri): String?

Creates a YouTube URI from a DuckPlayer URI.

duckPlayerNavigatedToYoutube

abstract fun duckPlayerNavigatedToYoutube()

Notifies the DuckPlayer that the user navigated to YouTube successfully, so subsequent requests would redirect to Duck Player

duckPlayerOverlayHidden

abstract fun duckPlayerOverlayHidden()

Notifies the DuckPlayer that the overlay was hidden after navigating back from Duck Player

getDuckPlayerState

abstract fun getDuckPlayerState(): DuckPlayer.DuckPlayerState

Retrieves the current state of the DuckPlayer.

getUserPreferences

abstract fun getUserPreferences(): DuckPlayer.UserPreferences

Retrieves the user preferences.

intercept

abstract suspend fun intercept(request: WebResourceRequest, url: Uri, webView: WebView): WebResourceResponse?

Notify Duck Player of a resource request and allow Duck Player to return the data.

isDuckPlayerUri

abstract fun isDuckPlayerUri(uri: String): Boolean

Checks if a string is a DuckPlayer URI.

isSimulatedYoutubeNoCookie

abstract fun isSimulatedYoutubeNoCookie(uri: Uri): Boolean

Checks if a URI is a simulated YouTube no-cookie URI.

isYouTubeUrl

abstract fun isYouTubeUrl(uri: Uri): Boolean

Checks if a URI is a YouTube URL.

isYoutubeWatchUrl

abstract fun isYoutubeWatchUrl(uri: Uri): Boolean

Checks if a URI is a YouTube watch URL.

observeShouldOpenInNewTab

abstract fun observeShouldOpenInNewTab(): Flow<DuckPlayer.OpenDuckPlayerInNewTab>

Observes whether a duck Player will be opened in a new tab based on RC flag and user settings

observeUserPreferences

abstract fun observeUserPreferences(): Flow<DuckPlayer.UserPreferences>

Retrieves a flow of user preferences.

sendDuckPlayerPixel

abstract suspend fun sendDuckPlayerPixel(pixelName: String, pixelData: Map<String, String>)

Sends a pixel with the given name and data.

setDuckPlayerOrigin

abstract fun setDuckPlayerOrigin(origin: DuckPlayer.DuckPlayerOrigin)

Sets the DuckPlayer origin.

setUserPreferences

abstract suspend fun setUserPreferences(overlayInteracted: Boolean, privatePlayerMode: String)

Sets the user preferences.

shouldHideDuckPlayerOverlay

abstract fun shouldHideDuckPlayerOverlay(): Boolean

Checks if the DuckPlayer overlay should be hidden after navigating back from Duck Player

shouldOpenDuckPlayerInNewTab

abstract fun shouldOpenDuckPlayerInNewTab(): DuckPlayer.OpenDuckPlayerInNewTab

Checks whether a duck Player will be opened in a new tab based on RC flag and user settings

showDuckPlayerPrimeModal

abstract fun showDuckPlayerPrimeModal(configuration: Configuration, fragmentManager: FragmentManager, fromDuckPlayerPage: Boolean)

Shows the Duck Player Prime modal.

wasUsedBefore

abstract suspend fun wasUsedBefore(): Boolean

Returns true if Duck Player was ever used before.

willNavigateToDuckPlayer

abstract fun willNavigateToDuckPlayer(destinationUrl: Uri): Boolean

Checks whether a URL will trigger Duck Player loading based on URL and user settings