1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.internal.actions.seek</title> 4 <meta charset="utf-8"> 5 </head><body bgcolor="#f0f0f8"> 6 7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8 <tr bgcolor="#7799ee"> 9 <td valign=bottom> <br> 10 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.actions.html"><font color="#ffffff">actions</font></a>.seek</strong></big></big></font></td 11 ><td align=right valign=bottom 12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/actions/seek.py">telemetry/internal/actions/seek.py</a></font></td></tr></table> 13 <p><tt>A Telemetry page_action that performs the "seek" action on media elements.<br> 14 <br> 15 Action parameters are:<br> 16 - seconds: The media time to seek to. Test fails if not provided.<br> 17 - selector: If no selector is defined then the action attempts to seek the first<br> 18 media element on the page. If 'all' then seek all media elements.<br> 19 - timeout_in_seconds: Maximum waiting time for the "seeked" event<br> 20 (dispatched when the seeked operation completes)<br> 21 to be fired. 0 means do not wait.<br> 22 - log_time: If true the seek time is recorded, otherwise media<br> 23 measurement will not be aware of the seek action. Used to<br> 24 perform multiple seeks. Default true.<br> 25 - label: A suffix string to name the seek perf measurement.</tt></p> 26 <p> 27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 28 <tr bgcolor="#aa55cc"> 29 <td colspan=3 valign=bottom> <br> 30 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 31 32 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 33 <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> 34 </td><td width="25%" valign=top><a href="telemetry.internal.actions.media_action.html">telemetry.internal.actions.media_action</a><br> 35 </td><td width="25%" valign=top><a href="telemetry.internal.actions.page_action.html">telemetry.internal.actions.page_action</a><br> 36 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> 37 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 38 <tr bgcolor="#ee77aa"> 39 <td colspan=3 valign=bottom> <br> 40 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 41 42 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 43 <td width="100%"><dl> 44 <dt><font face="helvetica, arial"><a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a>(<a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a>) 45 </font></dt><dd> 46 <dl> 47 <dt><font face="helvetica, arial"><a href="telemetry.internal.actions.seek.html#SeekAction">SeekAction</a> 48 </font></dt></dl> 49 </dd> 50 </dl> 51 <p> 52 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 53 <tr bgcolor="#ffc8d8"> 54 <td colspan=3 valign=bottom> <br> 55 <font color="#000000" face="helvetica, arial"><a name="SeekAction">class <strong>SeekAction</strong></a>(<a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a>)</font></td></tr> 56 57 <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 58 <td width="100%"><dl><dt>Method resolution order:</dt> 59 <dd><a href="telemetry.internal.actions.seek.html#SeekAction">SeekAction</a></dd> 60 <dd><a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a></dd> 61 <dd><a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a></dd> 62 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 63 </dl> 64 <hr> 65 Methods defined here:<br> 66 <dl><dt><a name="SeekAction-RunAction"><strong>RunAction</strong></a>(self, tab)</dt></dl> 67 68 <dl><dt><a name="SeekAction-WillRunAction"><strong>WillRunAction</strong></a>(self, tab)</dt><dd><tt>Load the media metrics JS code prior to running the action.</tt></dd></dl> 69 70 <dl><dt><a name="SeekAction-__init__"><strong>__init__</strong></a>(self, seconds, selector<font color="#909090">=None</font>, timeout_in_seconds<font color="#909090">=0</font>, log_time<font color="#909090">=True</font>, label<font color="#909090">=''</font>)</dt></dl> 71 72 <hr> 73 Methods inherited from <a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a>:<br> 74 <dl><dt><a name="SeekAction-HasEventCompletedOrError"><strong>HasEventCompletedOrError</strong></a>(self, tab, selector, event_name)</dt></dl> 75 76 <dl><dt><a name="SeekAction-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> 77 78 <dl><dt><a name="SeekAction-WaitForEvent"><strong>WaitForEvent</strong></a>(self, tab, selector, event_name, timeout_in_seconds)</dt><dd><tt>Halts media action until the selector's event is fired.<br> 79 <br> 80 Args:<br> 81 tab: The tab to check for event on.<br> 82 selector: Media element selector.<br> 83 event_name: Name of the event to check if fired or not.<br> 84 timeout_in_seconds: Timeout to check for event, throws an exception if<br> 85 not fired.</tt></dd></dl> 86 87 <hr> 88 Methods inherited from <a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a>:<br> 89 <dl><dt><a name="SeekAction-CleanUp"><strong>CleanUp</strong></a>(self, tab)</dt></dl> 90 91 <hr> 92 Data descriptors inherited from <a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a>:<br> 93 <dl><dt><strong>__dict__</strong></dt> 94 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 95 </dl> 96 <dl><dt><strong>__weakref__</strong></dt> 97 <dd><tt>list of weak references to the object (if defined)</tt></dd> 98 </dl> 99 </td></tr></table></td></tr></table> 100 </body></html>
