# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Toolkit :: Picture-in-Picture'

pictureinpicture.settings:
  enable_settings:
    type: event
    description: >
      Recorded when Picture-in-Picture is enabled.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.settings.enable#settings.
    bugs:
      - https://bugzil.la/1639774
    data_reviews:
      - https://bugzil.la/1639774
    notification_emails:
      - mconley@mozilla.com
    expires: never

  enable_autotrigger_settings:
    type: event
    description: >
      Recorded when the Picture-in-Picture auto-trigger is enabled.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.settings.enable_autotrigger#settings.
    bugs:
      - https://bugzil.la/1647800
      - https://bugzil.la/1910505
    data_reviews:
      - https://bugzil.la/1647800
      - https://bugzil.la/1910505
    notification_emails:
      - mconley@mozilla.com
    expires: never

  disable_player:
    type: event
    description: >
      Recorded with "settings" object when Picture-in-Picture is disabled
      via settings Recorded with "player" object when Picture-in-Picture
      is disabled via PiP context menu
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.settings.disable#player.
    bugs: &pictureinpicture_settings_disable_bugs
      - https://bugzil.la/1639774
    data_reviews: &pictureinpicture_settings_disable_data_reviews
      - https://bugzil.la/1639774
    notification_emails: &pictureinpicture_settings_disable_emails
      - mconley@mozilla.com
    expires: never

  disable_settings:
    type: event
    description: >
      Recorded with "settings" object when Picture-in-Picture is disabled
      via settings Recorded with "player" object when Picture-in-Picture
      is disabled via PiP context menu
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.settings.disable#settings.
    bugs: *pictureinpicture_settings_disable_bugs
    data_reviews: *pictureinpicture_settings_disable_data_reviews
    notification_emails: *pictureinpicture_settings_disable_emails
    expires: never

pictureinpicture:
  create_player:
    type: event
    description: >
      Recorded when the Picture-in-Picture player window is created.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.create#player.
    bugs:
      - https://bugzil.la/1560590
      - https://bugzil.la/1678202
      - https://bugzil.la/1730039
      - https://bugzil.la/1756703
    data_reviews:
      - https://bugzil.la/1560590
      - https://bugzil.la/1678202
      - https://bugzil.la/1730039
      - https://bugzil.la/1756703
    notification_emails:
      - mconley@mozilla.com
    expires: never
    extra_keys:
      value:
        description: >
          The `value` of the event. Mirrors to the Legacy Telemetry
          event's `value` parameter.
        type: string
      width:
        description: >
          The width that the window was created at
        type: quantity
      height:
        description: >
          The height that the window was created at
        type: quantity
      screenX:
        description: >
          The screen X coordinate that the window was created at
        type: quantity
      screenY:
        description: >
          The screen Y coordinate that the window was created at
        type: quantity
      ccEnabled:
        description: >
          Are subtitles enabled for PiP
        type: boolean
      webVTTSubtitles:
        description: >
          Are the subtitles WebVTT
        type: boolean

  resize_player:
    type: event
    description: >
      Recorded when the Picture-in-Picture player window is resized.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.resize#player.
    bugs:
      - https://bugzil.la/1560590
      - https://bugzil.la/1678202
      - https://bugzil.la/1730039
    data_reviews:
      - https://bugzil.la/1560590
      - https://bugzil.la/1678202
      - https://bugzil.la/1730039
    notification_emails:
      - mconley@mozilla.com
    expires: never
    extra_keys:
      value:
        description: >
          The `value` of the event. Mirrors to the Legacy Telemetry
          event's `value` parameter.
        type: string
      width:
        description: >
          The width that the window was resized to
        type: quantity
      height:
        description: >
          The height that the window was resize to
        type: quantity

  saw_toggle_toggle:
    type: event
    description: >
      Recorded when the Picture-in-Picture toggle is shown
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.saw_toggle#toggle.
    bugs:
      - https://bugzil.la/1749585
    data_reviews:
      - https://bugzil.la/1749585
    notification_emails:
      - mconley@mozilla.com
    expires: never
    extra_keys:
      firstTime:
        description: >
          If the user has used Picture-in-Picture before
        type: boolean

  opened_method_toggle:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.opened_method#toggle.
    bugs: &pictureinpicture_opened_method_bugs
      - https://bugzil.la/1749585
      - https://bugzil.la/1834554
      - https://bugzil.la/1858471
    data_reviews: &pictureinpicture_opened_method_data_reviews
      - https://bugzil.la/1749585
      - https://bugzil.la/1834554
      - https://bugzil.la/1858471
    notification_emails: &pictureinpicture_opened_method_emails
      - mconley@mozilla.com
    expires: never
    extra_keys: &pictureinpicture_opened_method_extra
      firstTimeToggle:
        description: >
          If the user has used Picture-in-Picture before
        type: boolean
      disableDialog:
        description: >
          True when urlbar button opens the disable PiP dialog
        type: boolean
      callout:
        description: >
          Boolean. True if PiP is being shown for the first time within 48 hours of a feature callout message highlighting the urlbar toggle.

        type: boolean

  opened_method_context_menu:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.opened_method#contextMenu.
    bugs: *pictureinpicture_opened_method_bugs
    data_reviews: *pictureinpicture_opened_method_data_reviews
    notification_emails: *pictureinpicture_opened_method_emails
    expires: never
    extra_keys: *pictureinpicture_opened_method_extra

  opened_method_url_bar:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.opened_method#urlBar.
    bugs: *pictureinpicture_opened_method_bugs
    data_reviews: *pictureinpicture_opened_method_data_reviews
    notification_emails: *pictureinpicture_opened_method_emails
    expires: never
    extra_keys: *pictureinpicture_opened_method_extra

  opened_method_shortcut:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.opened_method#shortcut.
    bugs: *pictureinpicture_opened_method_bugs
    data_reviews: *pictureinpicture_opened_method_data_reviews
    notification_emails: *pictureinpicture_opened_method_emails
    expires: never
    extra_keys: *pictureinpicture_opened_method_extra

  opened_method_auto_pip:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.opened_method#autoPip.
    bugs: *pictureinpicture_opened_method_bugs
    data_reviews: *pictureinpicture_opened_method_data_reviews
    notification_emails: *pictureinpicture_opened_method_emails
    expires: never
    extra_keys: *pictureinpicture_opened_method_extra

  opened_method_api:
    type: event
    description: >
      Records the method for opening the Picture-in-Picture window.
    bugs: *pictureinpicture_opened_method_bugs
    data_reviews: *pictureinpicture_opened_method_data_reviews
    notification_emails: *pictureinpicture_opened_method_emails
    expires: never
    extra_keys: *pictureinpicture_opened_method_extra

  closed_method_close_button:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#closeButton.
    bugs: &pictureinpicture_closed_method_bugs
      - https://bugzil.la/1756703
      - https://bugzil.la/1834554
    data_reviews: &pictureinpicture_closed_method_data_reviews
      - https://bugzil.la/1756703
      - https://bugzil.la/1834554
    notification_emails: &pictureinpicture_closed_method_emails
      - mconley@mozilla.com
      - mtigley@mozilla.com
      - mhowell@mozilla.com
    expires: never

  closed_method_unpip:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#unpip.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_pagehide:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#pagehide.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_foregrounded:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#foregrounded.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_fullscreen:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#fullscreen.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_setup_failure:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#setupFailure.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_close_player_shortcut:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#closePlayerShortcut.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_context_menu:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#contextMenu.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_video_el_remove:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#videoElRemove.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_video_el_emptied:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#videoElEmptied.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_url_bar:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#urlBar.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_shortcut:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#shortcut.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_browser_crash:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#browserCrash.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  closed_method_api:
    type: event
    description: >
      Records the method for closing the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.closed_method#programmatic.
    bugs: *pictureinpicture_closed_method_bugs
    data_reviews: *pictureinpicture_closed_method_data_reviews
    notification_emails: *pictureinpicture_closed_method_emails
    expires: never

  subtitles_shown_subtitles:
    type: event
    description: >
      Records if subtitles are shown in the Picture-in-Picture window.
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.subtitles_shown#subtitles.
    bugs:
      - https://bugzil.la/1772546
    data_reviews:
      - https://bugzil.la/1772546
    notification_emails:
      - mconley@mozilla.com
      - mhowell@mozilla.com
    expires: never
    extra_keys:
      webVTTSubtitles:
        description: >
          Will be true or false
        type: boolean

  fullscreen_player:
    type: event
    description: >
      Recorded when the user clicks the fullscreen button
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.fullscreen#player.
    bugs:
      - https://bugzil.la/1822395
    data_reviews:
      - https://bugzil.la/1822395
    notification_emails:
      - mconley@mozilla.com
      - mhowell@mozilla.com
    expires: never
    extra_keys:
      value:
        description: >
          The `value` of the event. Mirrors to the Legacy Telemetry
          event's `value` parameter.
        type: string
      enter:
        description: >
          true if entering fullscreen, false if exiting fullscreen
        type: boolean

  disrespect_disable_url_bar:
    type: event
    description: >
      Recorded when the user chooses to enable PiP anyway on a PiP
      disabled video
      This event was generated to correspond to the Legacy Telemetry event
      pictureinpicture.disrespect_disable#urlBar.
    bugs:
      - https://bugzil.la/1834554
    data_reviews:
      - https://bugzil.la/1834554
    notification_emails:
      - mconley@mozilla.com
      - mhowell@mozilla.com
    expires: never

  most_concurrent_players:
    type: quantity
    description: >
      The most concurrent Picture-in-Picture players the user had open at
      any one time.
      This metric was generated to correspond to the Legacy Telemetry
      scalar pictureinpicture.most_concurrent_players.
    bugs:
      - https://bugzil.la/1677107
      - https://bugzil.la/1706843
      - https://bugzil.la/1736690
    data_reviews:
      - https://bugzil.la/1677107
      - https://bugzil.la/1706843
      - https://bugzil.la/1736690
    notification_emails:
      - mconley@mozilla.com
    expires: never
    unit: Picture-in-Picture players

  toggle_enabled:
    type: boolean
    description: >
      Whether the user has Picture-in-Picture enabled.
      This metric was generated to correspond to the Legacy Telemetry
      scalar pictureinpicture.toggle_enabled.
    bugs:
      - https://bugzil.la/1639774
    data_reviews:
      - https://bugzil.la/1639774
    notification_emails:
      - mconley@mozilla.com
    expires: never

  window_open_duration:
    type: timing_distribution
    description: >
      The length of time (in seconds) that a Picture-in-Picture window was open.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram FX_PICTURE_IN_PICTURE_WINDOW_OPEN_DURATION.
    time_unit: second
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1560590
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683100
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1756703
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1560590
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683100
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1756703
    notification_emails:
      - mconley@mozilla.com
    expires: never

  background_tab_playing_duration:
    type: timing_distribution
    description: >
      The length of time (in seconds) that a video was in Picture-in-Picture
      mode in a background tab.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram
      FX_PICTURE_IN_PICTURE_BACKGROUND_TAB_PLAYING_DURATION.
    time_unit: second
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817042
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817042
    notification_emails:
      - mconley@mozilla.com
    expires: never

  foreground_tab_playing_duration:
    type: timing_distribution
    description: >
      The length of time (in seconds) that a video was in Picture-in-Picture
      mode in a foreground tab.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram
      FX_PICTURE_IN_PICTURE_FOREGROUND_TAB_PLAYING_DURATION.
    time_unit: second
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817042
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817042
    notification_emails:
      - mconley@mozilla.com
    expires: never