1a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 2a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<html><head><title>Python: module telemetry.page.actions.play</title> 4a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</head><body bgcolor="#f0f0f8"> 5a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 6a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 7a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr bgcolor="#7799ee"> 8a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td valign=bottom> <br> 9a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.play</strong></big></big></font></td 10a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch><td align=right valign=bottom 11a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch><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></td></tr></table> 12a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <p><tt>A Telemetry page_action that performs the "play" action on media elements.<br> 13a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <br> 14a3f7b4e666c476898878fa745f637129375cd889Ben MurdochMedia elements can be specified by a selector attribute. If no selector is<br> 15a3f7b4e666c476898878fa745f637129375cd889Ben Murdochdefined then then the action attempts to play the first video element or audio<br> 16a3f7b4e666c476898878fa745f637129375cd889Ben Murdochelement on the page. A selector can also be 'all' to play all media elements.<br> 17a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <br> 18a3f7b4e666c476898878fa745f637129375cd889Ben MurdochOther attributes to use are: wait_for_playing and wait_for_ended, which forces<br> 19a3f7b4e666c476898878fa745f637129375cd889Ben Murdochthe action to wait until playing and ended events get fired respectively.</tt></p> 20a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<p> 21a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 22a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr bgcolor="#aa55cc"> 23a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td colspan=3 valign=bottom> <br> 24a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 25a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 26a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 27a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> 28a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</td><td width="25%" valign=top><a href="os.html">os</a><br> 29a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> 30a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> 31a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</td></tr></table></td></tr></table><p> 32a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 33a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr bgcolor="#ee77aa"> 34a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td colspan=3 valign=bottom> <br> 35a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 36a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 37a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 38a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td width="100%"><dl> 39a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 40a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</font></dt><dd> 41a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl> 42a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dt><font face="helvetica, arial"><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a> 43a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</font></dt></dl> 44a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</dd> 45a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</dl> 46a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <p> 47a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 48a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr bgcolor="#ffc8d8"> 49a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td colspan=3 valign=bottom> <br> 50a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<font color="#000000" face="helvetica, arial"><a name="PlayAction">class <strong>PlayAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> 51a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 52a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 53a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<td width="100%"><dl><dt>Method resolution order:</dt> 54a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dd><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a></dd> 55a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> 56a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 57a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</dl> 58a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<hr> 59a3f7b4e666c476898878fa745f637129375cd889Ben MurdochMethods defined here:<br> 60a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-HasEventCompleted"><strong>HasEventCompleted</strong></a>(self, tab, selector, event_name)</dt></dl> 61a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 62a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> 63a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 64a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-WaitForEvent"><strong>WaitForEvent</strong></a>(self, tab, selector, event_name, timeout)</dt><dd><tt>Halts play action until the selector's event is fired.</tt></dd></dl> 65a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 66a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Load the media metrics JS code prior to running the action.</tt></dd></dl> 67a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 68a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> 69a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 70a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<hr> 71a3f7b4e666c476898878fa745f637129375cd889Ben MurdochMethods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> 72a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> 73a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <br> 74a3f7b4e666c476898878fa745f637129375cd889Ben MurdochA measurement can call this method to provide the action<br> 75a3f7b4e666c476898878fa745f637129375cd889Ben Murdochwith JavaScript code that starts and stops measurements. The action<br> 76a3f7b4e666c476898878fa745f637129375cd889Ben Murdochdetermines when to execute the provided JavaScript code, for more accurate<br> 77a3f7b4e666c476898878fa745f637129375cd889Ben Murdochtimings.<br> 78a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch <br> 79a3f7b4e666c476898878fa745f637129375cd889Ben MurdochArgs:<br> 80a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch tab: The tab to do everything on.<br> 81a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch start_js: JavaScript code that starts measurements.<br> 82a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch stop_js: JavaScript code that stops measurements.</tt></dd></dl> 83a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 84a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> 85a3f7b4e666c476898878fa745f637129375cd889Ben Murdochto return True so that a test knows it can bind measurements.</tt></dd></dl> 86a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 87a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> 88a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 89a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> 90a3f7b4e666c476898878fa745f637129375cd889Ben Murdochobject.</tt></dd></dl> 91a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 92a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><a name="PlayAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> 93a3f7b4e666c476898878fa745f637129375cd889Ben Murdochprevious action. For example, wait for href change needs to record the old<br> 94a3f7b4e666c476898878fa745f637129375cd889Ben Murdochhref before the previous action changes it. Therefore, we allow actions to<br> 95a3f7b4e666c476898878fa745f637129375cd889Ben Murdochrun the previous action. An action that does this should override this to<br> 96a3f7b4e666c476898878fa745f637129375cd889Ben Murdochreturn True in order to prevent the previous action from being run twice.</tt></dd></dl> 97a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch 98a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<hr> 99a3f7b4e666c476898878fa745f637129375cd889Ben MurdochData descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> 100a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><strong>__dict__</strong></dt> 101a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dd><tt>dictionary for instance variables (if defined)</tt></dd> 102a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</dl> 103a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dl><dt><strong>__weakref__</strong></dt> 104a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch<dd><tt>list of weak references to the object (if defined)</tt></dd> 105a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</dl> 106a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</td></tr></table></td></tr></table> 107a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch</body></html>