1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module telemetry.internal.actions.play</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>&nbsp;<br>
10<font color="#ffffff" face="helvetica, arial">&nbsp;<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>.play</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/play.py">telemetry/internal/actions/play.py</a></font></td></tr></table>
13    <p><tt>A&nbsp;Telemetry&nbsp;page_action&nbsp;that&nbsp;performs&nbsp;the&nbsp;"play"&nbsp;action&nbsp;on&nbsp;media&nbsp;elements.<br>
14&nbsp;<br>
15Media&nbsp;elements&nbsp;can&nbsp;be&nbsp;specified&nbsp;by&nbsp;a&nbsp;selector&nbsp;argument.&nbsp;If&nbsp;no&nbsp;selector&nbsp;is<br>
16defined&nbsp;then&nbsp;then&nbsp;the&nbsp;action&nbsp;attempts&nbsp;to&nbsp;play&nbsp;the&nbsp;first&nbsp;video&nbsp;element&nbsp;or&nbsp;audio<br>
17element&nbsp;on&nbsp;the&nbsp;page.&nbsp;A&nbsp;selector&nbsp;can&nbsp;also&nbsp;be&nbsp;'all'&nbsp;to&nbsp;play&nbsp;all&nbsp;media&nbsp;elements.<br>
18&nbsp;<br>
19Other&nbsp;arguments&nbsp;to&nbsp;use&nbsp;are:&nbsp;playing_event_timeout_in_seconds&nbsp;and<br>
20ended_event_timeout_in_seconds,&nbsp;which&nbsp;forces&nbsp;the&nbsp;action&nbsp;to&nbsp;wait&nbsp;until<br>
21playing&nbsp;and&nbsp;ended&nbsp;events&nbsp;get&nbsp;fired&nbsp;respectively.</tt></p>
22<p>
23<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
24<tr bgcolor="#aa55cc">
25<td colspan=3 valign=bottom>&nbsp;<br>
26<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
27
28<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
29<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>
30</td><td width="25%" valign=top><a href="telemetry.internal.actions.media_action.html">telemetry.internal.actions.media_action</a><br>
31</td><td width="25%" valign=top><a href="telemetry.internal.actions.page_action.html">telemetry.internal.actions.page_action</a><br>
32</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
33<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
34<tr bgcolor="#ee77aa">
35<td colspan=3 valign=bottom>&nbsp;<br>
36<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
37
38<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
39<td width="100%"><dl>
40<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>)
41</font></dt><dd>
42<dl>
43<dt><font face="helvetica, arial"><a href="telemetry.internal.actions.play.html#PlayAction">PlayAction</a>
44</font></dt></dl>
45</dd>
46</dl>
47 <p>
48<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
49<tr bgcolor="#ffc8d8">
50<td colspan=3 valign=bottom>&nbsp;<br>
51<font color="#000000" face="helvetica, arial"><a name="PlayAction">class <strong>PlayAction</strong></a>(<a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a>)</font></td></tr>
52
53<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
54<td width="100%"><dl><dt>Method resolution order:</dt>
55<dd><a href="telemetry.internal.actions.play.html#PlayAction">PlayAction</a></dd>
56<dd><a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a></dd>
57<dd><a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a></dd>
58<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
59</dl>
60<hr>
61Methods defined here:<br>
62<dl><dt><a name="PlayAction-RunAction"><strong>RunAction</strong></a>(self, tab)</dt></dl>
63
64<dl><dt><a name="PlayAction-WillRunAction"><strong>WillRunAction</strong></a>(self, tab)</dt><dd><tt>Load&nbsp;the&nbsp;media&nbsp;metrics&nbsp;JS&nbsp;code&nbsp;prior&nbsp;to&nbsp;running&nbsp;the&nbsp;action.</tt></dd></dl>
65
66<dl><dt><a name="PlayAction-__init__"><strong>__init__</strong></a>(self, selector<font color="#909090">=None</font>, playing_event_timeout_in_seconds<font color="#909090">=0</font>, ended_event_timeout_in_seconds<font color="#909090">=0</font>)</dt></dl>
67
68<hr>
69Methods inherited from <a href="telemetry.internal.actions.media_action.html#MediaAction">telemetry.internal.actions.media_action.MediaAction</a>:<br>
70<dl><dt><a name="PlayAction-HasEventCompletedOrError"><strong>HasEventCompletedOrError</strong></a>(self, tab, selector, event_name)</dt></dl>
71
72<dl><dt><a name="PlayAction-LoadJS"><strong>LoadJS</strong></a>(self, tab, js_file_name)</dt><dd><tt>Loads&nbsp;and&nbsp;executes&nbsp;a&nbsp;JS&nbsp;file&nbsp;in&nbsp;the&nbsp;tab.</tt></dd></dl>
73
74<dl><dt><a name="PlayAction-WaitForEvent"><strong>WaitForEvent</strong></a>(self, tab, selector, event_name, timeout_in_seconds)</dt><dd><tt>Halts&nbsp;media&nbsp;action&nbsp;until&nbsp;the&nbsp;selector's&nbsp;event&nbsp;is&nbsp;fired.<br>
75&nbsp;<br>
76Args:<br>
77&nbsp;&nbsp;tab:&nbsp;The&nbsp;tab&nbsp;to&nbsp;check&nbsp;for&nbsp;event&nbsp;on.<br>
78&nbsp;&nbsp;selector:&nbsp;Media&nbsp;element&nbsp;selector.<br>
79&nbsp;&nbsp;event_name:&nbsp;Name&nbsp;of&nbsp;the&nbsp;event&nbsp;to&nbsp;check&nbsp;if&nbsp;fired&nbsp;or&nbsp;not.<br>
80&nbsp;&nbsp;timeout_in_seconds:&nbsp;Timeout&nbsp;to&nbsp;check&nbsp;for&nbsp;event,&nbsp;throws&nbsp;an&nbsp;exception&nbsp;if<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;not&nbsp;fired.</tt></dd></dl>
82
83<hr>
84Methods inherited from <a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a>:<br>
85<dl><dt><a name="PlayAction-CleanUp"><strong>CleanUp</strong></a>(self, tab)</dt></dl>
86
87<hr>
88Data descriptors inherited from <a href="telemetry.internal.actions.page_action.html#PageAction">telemetry.internal.actions.page_action.PageAction</a>:<br>
89<dl><dt><strong>__dict__</strong></dt>
90<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
91</dl>
92<dl><dt><strong>__weakref__</strong></dt>
93<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
94</dl>
95</td></tr></table></td></tr></table>
96</body></html>