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