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

Side by Side 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 unified diff | Download patch | Annotate | Revision Log

OLD	NEW
1	1

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

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

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

5	5

6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.click_element</strong></big></b ig></font></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.play</strong></big></big></font ></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/actions/click_element.py">telemetry/page/actions/click_elemen t.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/actions/play.py">telemetry/page/actions/play.py</a></font></t d></tr></table>

12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>	12 <p><tt>A Telemetry page_action that performs the&nb sp;"play" action on media elements.<br>

13 # Use of this source code is governed by  a BSD-style license that can be<br>	13  <br>

14 # found in the LICENSE file.</tt></p>	14 Media elements can be specified by a selector  attribute. If no selector is<br>

	15 defined then then the action attempts to play  the first video element or audio<br>

	16 element on the page. A selector can also&nbsp ;be 'all' to play all media elements.<br>

	17  <br>

	18 Other attributes to use are: wait_for_playing and& nbsp;wait_for_ended, which forces<br>

	19 the action to wait until playing and ended&nb sp;events get fired respectively.</tt></p>

15 <p>	20 <p>

16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	21 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

17 <tr bgcolor="#aa55cc">	22 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	23 <td colspan=3 valign=bottom> <br>

19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>	24 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

20	25

21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>	26 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>	27 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>

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

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

24 </td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.pag e.page</a><br>

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

26 </td></tr></table></td></tr></table><p>	31 </td></tr></table></td></tr></table><p>

27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	32 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

28 <tr bgcolor="#ee77aa">	33 <tr bgcolor="#ee77aa">

29 <td colspan=3 valign=bottom> <br>	34 <td colspan=3 valign=bottom> <br>

30 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>	35 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

31	36

32 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	37 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

33 <td width="100%"><dl>	38 <td width="100%"><dl>

34 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__buil tin__.html#object">__builtin__.object</a>)	39 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.ht ml#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__buil tin__.html#object">__builtin__.object</a>)

35 </font></dt><dd>	40 </font></dt><dd>

36 <dl>	41 <dl>

37 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.click_element. html#ClickElementAction">ClickElementAction</a>	42 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.play.html#Play Action">PlayAction</a>

38 </font></dt></dl>	43 </font></dt></dl>

39 </dd>	44 </dd>

40 </dl>	45 </dl>

41 <p>	46 <p>

42 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	47 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

43 <tr bgcolor="#ffc8d8">	48 <tr bgcolor="#ffc8d8">

44 <td colspan=3 valign=bottom> <br>	49 <td colspan=3 valign=bottom> <br>

45 <font color="#000000" face="helvetica, arial"><a name="ClickElementAction">class <strong>ClickElementAction</strong></a>(<a href="telemetry.page.actions.page_ac tion.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font>< /td></tr>	50 <font color="#000000" face="helvetica, arial"><a name="PlayAction">class <strong >PlayAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAc tion">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>

46	51

47 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	52 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

49 <dd><a href="telemetry.page.actions.click_element.html#ClickElementAction">Click ElementAction</a></dd>	54 <dd><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a></dd>

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

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

52 </dl>	57 </dl>

53 <hr>	58 <hr>

54 Methods defined here:<br>	59 Methods defined here:<br>

55 <dl><dt><a name="ClickElementAction-RunAction"><strong>RunAction</strong></a>(se lf, page, tab, previous_action)</dt></dl>	60 <dl><dt><a name="PlayAction-HasEventCompleted"><strong>HasEventCompleted</strong ></a>(self, tab, selector, event_name)</dt></dl>

56	61

57 <dl><dt><a name="ClickElementAction-__init__"><strong>__init__</strong></a>(self , attributes<font color="#909090">=None</font>)</dt></dl>	62 <dl><dt><a name="PlayAction-RunAction"><strong>RunAction</strong></a>(self, page , tab, previous_action)</dt></dl>

	63

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

	65

	66 <dl><dt><a name="PlayAction-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab)</dt><dd><tt>Load the media metrics JS co de prior to running the action.</tt></dd></dl>

	67

	68 <dl><dt><a name="PlayAction-__init__"><strong>__init__</strong></a>(self, attrib utes<font color="#909090">=None</font>)</dt></dl>

58	69

59 <hr>	70 <hr>

60 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>	71 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>

61 <dl><dt><a name="ClickElementAction-BindMeasurementJavaScript"><strong>BindMeasu rementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let&nbsp ;this action determine when measurements should st art and stop.<br>	72 <dl><dt><a name="PlayAction-BindMeasurementJavaScript"><strong>BindMeasurementJa vaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this&nb sp;action determine when measurements should start&nbsp ;and stop.<br>

62  <br>	73  <br>

63 A measurement can call this method to provide  the action<br>	74 A measurement can call this method to provide  the action<br>

64 with JavaScript code that starts and stops me asurements. The action<br>	75 with JavaScript code that starts and stops me asurements. The action<br>

65 determines when to execute the provided JavaScript  code, for more accurate<br>	76 determines when to execute the provided JavaScript  code, for more accurate<br>

66 timings.<br>	77 timings.<br>

67  <br>	78  <br>

68 Args:<br>	79 Args:<br>

69   tab: The tab to do everything on.<br>	80   tab: The tab to do everything on.<br>

70   start_js: JavaScript code that starts measu rements.<br>	81   start_js: JavaScript code that starts measu rements.<br>

71   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>	82   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>

72	83

73 <dl><dt><a name="ClickElementAction-CanBeBound"><strong>CanBeBound</strong></a>( self)</dt><dd><tt>If this class implements BindMeasurementJa vaScript, override CanBeBound<br>	84 <dl><dt><a name="PlayAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</d t><dd><tt>If this class implements BindMeasurementJavaScript , override CanBeBound<br>

74 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>	85 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>

75	86

76 <dl><dt><a name="ClickElementAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>	87 <dl><dt><a name="PlayAction-CleanUp"><strong>CleanUp</strong></a>(self, page, ta b)</dt></dl>

77	88

78 <dl><dt><a name="ClickElementAction-CustomizeBrowserOptions"><strong>CustomizeBr owserOptions</strong></a>(self, options)</dt><dd><tt>Override to add&n bsp;action-specific options to the BrowserOptions<br>	89 <dl><dt><a name="PlayAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOpt ions</strong></a>(self, options)</dt><dd><tt>Override to add acti on-specific options to the BrowserOptions<br>

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

80	91

81 <dl><dt><a name="ClickElementAction-RunsPreviousAction"><strong>RunsPreviousActi on</strong></a>(self)</dt><dd><tt>Some actions require some  initialization to be performed before the<br>	92 <dl><dt><a name="PlayAction-RunsPreviousAction"><strong>RunsPreviousAction</stro ng></a>(self)</dt><dd><tt>Some actions require some initiali zation to be performed before the<br>

82 previous action. For example, wait for href c hange needs to record the old<br>	93 previous action. For example, wait for href c hange needs to record the old<br>

83 href before the previous action changes it. T herefore, we allow actions to<br>	94 href before the previous action changes it. T herefore, we allow actions to<br>

84 run the previous action. An action that does& nbsp;this should override this to<br>	95 run the previous action. An action that does& nbsp;this should override this to<br>

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

86	97

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

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

89

90 <hr>	98 <hr>

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

92 <dl><dt><strong>__dict__</strong></dt>	100 <dl><dt><strong>__dict__</strong></dt>

93 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>	101 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

94 </dl>	102 </dl>

95 <dl><dt><strong>__weakref__</strong></dt>	103 <dl><dt><strong>__weakref__</strong></dt>

96 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	104 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

97 </dl>	105 </dl>

98 </td></tr></table></td></tr></table>	106 </td></tr></table></td></tr></table>

99 </body></html>	107 </body></html>

OLD	NEW

« 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 »