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

DuckPlayer

interface DuckPlayer

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

Types

DuckPlayerState

enum DuckPlayerState : Enum<DuckPlayer.DuckPlayerState>

UserPreferences

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

Data class representing user preferences for Duck Player.

Functions

createDuckPlayerUriFromYoutubeNoCookie

abstract suspend fun createDuckPlayerUriFromYoutubeNoCookie(uri: Uri): String?

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

createYoutubeWatchUrlFromDuckPlayer

abstract suspend 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 suspend fun getDuckPlayerState(): DuckPlayer.DuckPlayerState

Retrieves the current state of the DuckPlayer.

getUserPreferences

abstract suspend 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 suspend fun isSimulatedYoutubeNoCookie(uri: Uri): Boolean

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

abstract suspend fun isSimulatedYoutubeNoCookie(uri: String): Boolean

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

isYouTubeUrl

abstract fun isYouTubeUrl(uri: Uri): Boolean

Checks if a URI is a YouTube URL.

isYoutubeWatchUrl

abstract suspend fun isYoutubeWatchUrl(uri: Uri): Boolean

Checks if a URI is a YouTube watch URL.

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.

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

showDuckPlayerPrimeModal

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

Shows the Duck Player Prime modal.

willNavigateToDuckPlayer

abstract suspend fun willNavigateToDuckPlayer(destinationUrl: Uri): Boolean

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