| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module telemetry.page.actions.play</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <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 |
| ><td align=right valign=bottom |
| ><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> |
| <p><tt>A Telemetry page_action that performs the "play" action on media elements.<br> |
| <br> |
| Media elements can be specified by a selector attribute. If no selector is<br> |
| defined then then the action attempts to play the first video element or audio<br> |
| element on the page. A selector can also be 'all' to play all media elements.<br> |
| <br> |
| Other attributes to use are: wait_for_playing and wait_for_ended, which forces<br> |
| the action to wait until playing and ended events get fired respectively.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <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> |
| </td><td width="25%" valign=top><a href="telemetry.page.actions.media_action.html">telemetry.page.actions.media_action</a><br> |
| </td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> |
| </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="PlayAction">class <strong>PlayAction</strong></a>(<a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="telemetry.page.actions.play.html#PlayAction">PlayAction</a></dd> |
| <dd><a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</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:<br> |
| <dl><dt><a name="PlayAction-RunAction"><strong>RunAction</strong></a>(self, page, tab)</dt></dl> |
| |
| <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> |
| |
| <dl><dt><a name="PlayAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> |
| |
| <hr> |
| Methods inherited from <a href="telemetry.page.actions.media_action.html#MediaAction">telemetry.page.actions.media_action.MediaAction</a>:<br> |
| <dl><dt><a name="PlayAction-HasEventCompletedOrError"><strong>HasEventCompletedOrError</strong></a>(self, tab, selector, event_name)</dt></dl> |
| |
| <dl><dt><a name="PlayAction-LoadJS"><strong>LoadJS</strong></a>(self, tab, js_file_name)</dt><dd><tt>Loads and executes a JS file in the tab.</tt></dd></dl> |
| |
| <dl><dt><a name="PlayAction-WaitForEvent"><strong>WaitForEvent</strong></a>(self, tab, selector, event_name, timeout)</dt><dd><tt>Halts media action until the selector's event is fired.<br> |
| <br> |
| Args:<br> |
| tab: The tab to check for event on.<br> |
| selector: Media element selector.<br> |
| event_name: Name of the event to check if fired or not.<br> |
| timeout: Timeout to check for event, throws an exception if not fired.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> |
| <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> |
| <br> |
| A measurement can call this method to provide the action<br> |
| with JavaScript code that starts and stops measurements. The action<br> |
| determines when to execute the provided JavaScript code, for more accurate<br> |
| timings.<br> |
| <br> |
| Args:<br> |
| tab: The tab to do everything on.<br> |
| start_js: JavaScript code that starts measurements.<br> |
| stop_js: JavaScript code that stops measurements.</tt></dd></dl> |
| |
| <dl><dt><a name="PlayAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> |
| to return True so that a test knows it can bind measurements.</tt></dd></dl> |
| |
| <dl><dt><a name="PlayAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> |
| |
| <dl><dt><a name="PlayAction-CustomizeBrowserOptionsForPageSet"><strong>CustomizeBrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> |
| object. These options will be set for the whole page set.<br> |
| <br> |
| If the browser is not being restarted for every page in the page set then<br> |
| all browser options required for the action must be set here. This, however,<br> |
| requires that they do not conflict with options require by other actions<br> |
| used up by the page set.</tt></dd></dl> |
| |
| <dl><dt><a name="PlayAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOnTimeline</strong></a>(self, timeline)</dt></dl> |
| |
| <dl><dt><a name="PlayAction-RunActionAndMaybeWait"><strong>RunActionAndMaybeWait</strong></a>(self, page, tab)</dt></dl> |
| |
| <dl><dt><a name="PlayAction-WillWaitAfterRun"><strong>WillWaitAfterRun</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Static methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> |
| <dl><dt><a name="PlayAction-ResetNextTimelineMarkerId"><strong>ResetNextTimelineMarkerId</strong></a>()</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table></td></tr></table> |
| </body></html> |