Class VideoOverlay

constructor

• new VideoOverlay(
      options: {
          environment: Environment;
          messages: DuckPlayerOverlayMessages;
          settings: OverlaysFeatureSettings;
          ui: UISettings;
          userValues: UserValues;
      },
  ): VideoOverlay

  Parameters

  • options: {
        environment: Environment;
        messages: DuckPlayerOverlayMessages;
        settings: OverlaysFeatureSettings;
        ui: UISettings;
        userValues: UserValues;
    }

  Returns VideoOverlay

appendedMobileVariant

didAllowFirstVideo

environment

lastVideoId

messages

settings

sideEffects

ui

userValues

addSmallDaxOverlay

• addSmallDaxOverlay(params: VideoParams): void

  Parameters

  • params: VideoParams

  Returns void

appendDesktopOverlay

• appendDesktopOverlay(targetElement: Element, params: VideoParams): void

  Parameters

  • targetElement: Element
  • params: VideoParams

  Returns void

appendMobileDrawer

• appendMobileDrawer(
      targetElement: Element,
      drawerTargetElement: Element,
      params: VideoParams,
  ): void

  Parameters

  • targetElement: Element
  • drawerTargetElement: Element
  • params: VideoParams

  Returns void

appendMobileOverlay

• appendMobileOverlay(targetElement: Element, params: VideoParams): void

  Parameters

  • targetElement: Element
  • params: VideoParams

  Returns void

appendThumbnail

• appendThumbnail(overlayElement: HTMLElement): void

  Parameters

  • overlayElement: HTMLElement

  Returns void

bufferingFeedbackEnabled

• bufferingFeedbackEnabled(): boolean

  Returns boolean

buildPosterCandidates

• buildPosterCandidates(video: HTMLVideoElement): PosterCandidate[]

  Poster candidates for the buffering hold, cheapest source first.

  Parameters

  • video: HTMLVideoElement

  Returns PosterCandidate[]

destroy

• destroy(): void

  Remove elements, event listeners etc

  Returns void

dismissOverlay

• dismissOverlay(): void

  Returns void

fullscreenGuardEnabled

• fullscreenGuardEnabled(): boolean

  Returns boolean

handleFirstPageLoad

• handleFirstPageLoad(): void

  Special handling of a first-page, an attempt to load our overlay as quickly as possible

  Returns void

init

• init(trigger: "page-load" | "preferences-changed" | "href-changed"): void

  Parameters

  • trigger: "page-load" | "preferences-changed" | "href-changed"

  Returns void

keepOverlayOutOfFullscreen

• keepOverlayOutOfFullscreen(): void

  A scroll gesture can fullscreen YouTube's player container. Our overlays sit inside #movie_player and stretch to the screen, but #player-control-container is outside that stacking context and hit-tests above them, so every tap lands on YouTube with no chrome left to escape to. Call this after appending, so the first check sees the overlay.

  Returns void

mobileOptIn

• mobileOptIn(remember: boolean, params: VideoParams): Promise<void>

  Parameters

  • remember: boolean
  • params: VideoParams

  Returns Promise<void>

mobileOptOut

• mobileOptOut(remember: boolean): Promise<void>

  Parameters

  • remember: boolean

  Returns Promise<void>

shouldShowDrawerVariant

• shouldShowDrawerVariant(): string | false | undefined

  Returns string | false | undefined

showBufferingFeedbackUntilFirstFrame

• showBufferingFeedbackUntilFirstFrame(): void

  After opt-out the

  Returns void

stopVideoFromPlaying

• stopVideoFromPlaying(): void

  Just brute-force calling video.pause() for as long as the user is seeing the overlay.

  Returns void

userOptIn

• userOptIn(remember: boolean, params: VideoParams): void

  If the checkbox was checked, this action means that we want to 'always' use the private player

  But, if the checkbox was not checked, then we want to keep the state as 'alwaysAsk'

  Parameters

  • remember: boolean
  • params: VideoParams

  Returns void

userOptOut

• userOptOut(remember: boolean, params: VideoParams): void

  Parameters

  • remember: boolean
  • params: VideoParams

  Returns void

watchForVideoBeingAdded

• watchForVideoBeingAdded(
      opts?: { ignoreCache?: boolean; via?: string },
  ): void | null

  Parameters

  • Optionalopts: { ignoreCache?: boolean; via?: string } = {}

  Returns void | null