Record the offscreen playing duration of autoplaying muted videos

third_party/WebKit/Source/core/html/AutoplayUmaHelper.h

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef AutoplayUmaHelper_h
 #define AutoplayUmaHelper_h
 
 #include "core/events/EventListener.h"
 #include "platform/heap/Handle.h"
 
@@ skipping 25 matching lines @@
     static AutoplayUmaHelper* create(HTMLMediaElement*);
 
     ~AutoplayUmaHelper();
 
     bool operator==(const EventListener&) const override;
 
     void onAutoplayInitiated(AutoplaySource);
 
     void recordAutoplayUnmuteStatus(AutoplayUnmuteActionStatus);
 
-    void onVisibilityChangedForVideoMutedPlayMethod(bool isVisible);
-
     void didMoveToNewDocument(Document& oldDocument);
 
     DECLARE_VIRTUAL_TRACE();
 
 private:
     explicit AutoplayUmaHelper(HTMLMediaElement*);
 
     void handleEvent(ExecutionContext*, Event*) override;
 
     void handlePlayingEvent();
+    void handlePauseEvent();
     void handleUnloadEvent();
 
+    void maybeUnregisterUnloadListener();
+
+    void maybeStartRecordingMutedVideoPlayMethodBecomeVisible();
+    void maybeStopRecordingMutedVideoPlayMethodBecomeVisible(bool isVisible);
+
+    void maybeStartRecordingMutedVideoOffscreenDuration();
+    void maybeStopRecordingMutedVideoOffscreenDuration(bool isInfinite);
+
+    void onVisibilityChangedForMutedVideoOffscreenDuration(bool isVisibile);
+    void onVisibilityChangedForMutedVideoPlayMethodBecomeVisible(bool isVisible);
+
+    bool shouldListenToUnloadEvent() const;
+
     // The autoplay source. Use AutoplaySource::NumberOfSources for invalid source.
     AutoplaySource m_source;
     // The media element this UMA helper is attached to. |m_element| owns |this|.
     WeakMember<HTMLMediaElement> m_element;
-    // The observer is used to observe whether a muted video autoplaying by play() method become visible at some point.
-    Member<ElementVisibilityObserver> m_videoMutedPlayMethodVisibilityObserver;
+
+    // The observer is used to observe whether a muted video autoplaying by play()
+    // method become visible at some point.
+    // The UMA is pending for recording as long as this observer is non-null.
+    Member<ElementVisibilityObserver> m_mutedVideoPlayMethodVisibilityObserver;
+
+    // Variables used for recording the duration of autoplay muted video playing offscreen.
+    // The variables are valid when |m_autoplayOffscrenVisibilityObserver| is non-null.
+    // The recording stops whenever the playback pauses or the page is unloaded.
+
+    // The starting time of autoplaying muted video.
+    double m_mutedVideoAutoplayOffscreenStartTimeMS;
+    // The duration an autoplaying muted video has been in offscreen.
+    double m_mutedVideoAutoplayOffscreenDurationMS;
+    // Whether an autoplaying muted video is visible.
+    bool m_isVisible;
+    // The observer is used to observer an autoplaying muted video changing it's visibility,

[mlamouri (slow - plz ping), 2016/08/19 10:00:08]

style: I think it would be better to leave an empty line between members.

[Zhiqiang Zhang (Slow), 2016/08/19 10:50:49]

Done.

+    // which is used for offscreen duration UMA.
+    // The UMA is pending for recording as long as this observer is non-null.
+    Member<ElementVisibilityObserver> m_mutedVideoOffscreenDurationVisibilityObserver;
 };
 
 } // namespace blink
 
 #endif // AutoplayUmaHelper_h