tools/telemetry/docs/telemetry.page.actions.play.html - Issue 19790005: Reland [telemetry] Timeline model cleanups

Unified Diff: tools/telemetry/docs/telemetry.page.actions.play.html

Issue 19790005: Reland [telemetry] Timeline model cleanups (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 7 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: tools/telemetry/docs/telemetry.page.actions.play.html

diff --git a/tools/telemetry/docs/telemetry.page.actions.click_element.html b/tools/telemetry/docs/telemetry.page.actions.play.html

similarity index 57%

copy from tools/telemetry/docs/telemetry.page.actions.click_element.html

copy to tools/telemetry/docs/telemetry.page.actions.play.html

index a55f8fc5b663c44352ba9b0cd4113a6d3c54e810..88ece2442907d8b044ddad9240dcff5080f4245a 100644

--- a/tools/telemetry/docs/telemetry.page.actions.click_element.html

+++ b/tools/telemetry/docs/telemetry.page.actions.play.html

@@ -1,17 +1,22 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.page.actions.click_element</title>

+<html><head><title>Python: module telemetry.page.actions.play</title>

</head><body bgcolor="#f0f0f8">

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.page.html">page</a>.<a href="telemetry.page.actions.html">actions</a>.click_element</big></big></td

+  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.page.html">page</a>.<a href="telemetry.page.actions.html">actions</a>.play</big></big></td

><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/page/actions/click_element.py">telemetry/page/actions/click_element.py</a></td></tr></table>

- <tt># Copyright (c) 2012 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.</tt>

+><a href=".">index</a> <a href="../telemetry/page/actions/play.py">telemetry/page/actions/play.py</a></td></tr></table>

+ <tt>A Telemetry page_action that performs the "play" action on media elements.

+

+Media elements can be specified by a selector attribute. If no selector is

+defined then then the action attempts to play the first video element or audio

+element on the page. A selector can also be 'all' to play all media elements.

+

+Other attributes to use are: wait_for_playing and wait_for_ended, which forces

+the action to wait until playing and ended events get fired respectively.</tt>

@@ -20,8 +25,8 @@

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a>

+</td><td width="25%" valign=top><a href="os.html">os</a>

</td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a>

-</td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.page.page</a>

</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a>

</td></tr></table></td></tr></table>

@@ -34,7 +39,7 @@

<dt><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

</dt><dd>

<dl>

-<dt><a href="telemetry.page.actions.click_element.html#ClickElementAction">ClickElementAction</a>

+<dt><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a>

</dt></dl>

</dd>

</dl>

@@ -42,23 +47,29 @@

-<a name="ClickElementAction">class ClickElementAction</a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</td></tr>

+<a name="PlayAction">class PlayAction</a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</td></tr>

<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.page.actions.click_element.html#ClickElementAction">ClickElementAction</a></dd>

+<dd><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a></dd>

<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd>

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

</dl>

<hr>

Methods defined here:

-<dl><dt><a name="ClickElementAction-RunAction">RunAction</a>(self, page, tab, previous_action)</dt></dl>

+<dl><dt><a name="PlayAction-HasEventCompleted">HasEventCompleted</a>(self, tab, selector, event_name)</dt></dl>

+<dl><dt><a name="PlayAction-RunAction">RunAction</a>(self, page, tab, previous_action)</dt></dl>

-<dl><dt><a name="ClickElementAction-__init__">__init__</a>(self, attributes=None)</dt></dl>

+<dl><dt><a name="PlayAction-WaitForEvent">WaitForEvent</a>(self, tab, selector, event_name, timeout)</dt><dd><tt>Halts play action until the selector's event is fired.</tt></dd></dl>

+<dl><dt><a name="PlayAction-WillRunAction">WillRunAction</a>(self, page, tab)</dt><dd><tt>Load the media metrics JS code prior to running the action.</tt></dd></dl>

+<dl><dt><a name="PlayAction-__init__">__init__</a>(self, attributes=None)</dt></dl>

<hr>

Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:

-<dl><dt><a name="ClickElementAction-BindMeasurementJavaScript">BindMeasurementJavaScript</a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.

+<dl><dt><a name="PlayAction-BindMeasurementJavaScript">BindMeasurementJavaScript</a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.

A measurement can call this method to provide the action

with JavaScript code that starts and stops measurements. The action

@@ -70,23 +81,20 @@ Args:

start_js: JavaScript code that starts measurements.

stop_js: JavaScript code that stops measurements.</tt></dd></dl>

-<dl><dt><a name="ClickElementAction-CanBeBound">CanBeBound</a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound

+<dl><dt><a name="PlayAction-CanBeBound">CanBeBound</a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound

to return True so that a test knows it can bind measurements.</tt></dd></dl>

-<dl><dt><a name="ClickElementAction-CleanUp">CleanUp</a>(self, page, tab)</dt></dl>

+<dl><dt><a name="PlayAction-CleanUp">CleanUp</a>(self, page, tab)</dt></dl>

-<dl><dt><a name="ClickElementAction-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions

+<dl><dt><a name="PlayAction-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions

object.</tt></dd></dl>

-<dl><dt><a name="ClickElementAction-RunsPreviousAction">RunsPreviousAction</a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the

+<dl><dt><a name="PlayAction-RunsPreviousAction">RunsPreviousAction</a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the

previous action. For example, wait for href change needs to record the old

href before the previous action changes it. Therefore, we allow actions to

run the previous action. An action that does this should override this to

return True in order to prevent the previous action from being run twice.</tt></dd></dl>

-<dl><dt><a name="ClickElementAction-WillRunAction">WillRunAction</a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before

-Test.WillRunAction is called.</tt></dd></dl>

<hr>

Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.html ('k') | tools/telemetry/docs/telemetry.page.cloud_storage.html » ('j') | no next file with comments »