mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-22 01:35:35 +00:00
ea566d079b
We'd like to add telemetry to help inform the decision as to how enabling block autoplay will affect video playback in the wild. Our data science team would also like some input to help them estimate the rate at which our shield study would receive pings, and the telemetry collected here will help them estimate that. We'd like to collect the following, on a per session basis: * Count of the number of top level content documents loaded, as denominator for other stats collected here. * Count of the number of top level content documents which contained (directly or in a descendant document) playback of an audible media element. * Count of the number of top level content documents which contained (directly or in a descendant document) a muted media element that was paused by the autoplay policy because it tried to unmute and it wasn't allowed to autoplay audibly. * Count of the total number of audible autoplay videos that would have not been allowed to play if block autoplay was enabled. We'd either prompt for permission on these videos, or block outright depending on user's settings. * Count of the total number of audible autoplay videos that would have been allowed to play if block autoplay was enabled. MozReview-Commit-ID: vHWJPyqHjT --HG-- extra : rebase_source : e1f22ec83fda8b65d78f1de9f02cf060d424019c
61 lines
2.1 KiB
C++
61 lines
2.1 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim:set ts=2 sw=2 sts=2 et cindent: */
|
|
/* 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/. */
|
|
|
|
#if !defined(AutoplayPolicy_h_)
|
|
#define AutoplayPolicy_h_
|
|
|
|
#include "mozilla/NotNull.h"
|
|
|
|
class nsIDocument;
|
|
|
|
namespace mozilla {
|
|
|
|
class AutoplayPermissionManager;
|
|
|
|
namespace dom {
|
|
|
|
class HTMLMediaElement;
|
|
class AudioContext;
|
|
|
|
/**
|
|
* AutoplayPolicy is used to manage autoplay logic for all kinds of media,
|
|
* including MediaElement, Web Audio and Web Speech.
|
|
*
|
|
* Autoplay could be disable by setting the pref "media.autoplay.default"
|
|
* to anything but nsIAutoplay::Allowed. Once user disables autoplay, media
|
|
* could only be played if one of following conditions is true.
|
|
* 1) Owner document is activated by user gestures
|
|
* We restrict user gestures to "mouse click", "keyboard press" and "touch".
|
|
* 2) Muted media content or video without audio content.
|
|
* 3) Document's origin has the "autoplay-media" permission.
|
|
*/
|
|
class AutoplayPolicy
|
|
{
|
|
public:
|
|
// Returns whether a given media element is allowed to play.
|
|
static uint32_t IsAllowedToPlay(const HTMLMediaElement& aElement);
|
|
|
|
// Returns true if a given media element would be allowed to play
|
|
// if block autoplay was enabled. If this returns false, it means we would
|
|
// either block or ask for permission.
|
|
// Note: this is for telemetry purposes, and doesn't check the prefs
|
|
// which enable/disable block autoplay. Do not use for blocking logic!
|
|
static bool WouldBeAllowedToPlayIfAutoplayDisabled(const HTMLMediaElement& aElement);
|
|
|
|
// Returns whether a given AudioContext is allowed to play.
|
|
static bool IsAudioContextAllowedToPlay(NotNull<AudioContext*> aContext);
|
|
|
|
// Returns the AutoplayPermissionManager that a given document must request on
|
|
// for autoplay permission.
|
|
static already_AddRefed<AutoplayPermissionManager> RequestFor(
|
|
const nsIDocument& aDocument);
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif
|