Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(43)

Side by Side Diff: tools/telemetry/docs/telemetry.core.platform.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 6 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 1
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <html><head><title>Python: package telemetry.core.platform</title> 3 <html><head><title>Python: package telemetry.core.platform</title>
4 </head><body bgcolor="#f0f0f8"> 4 </head><body bgcolor="#f0f0f8">
5 5
6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7 <tr bgcolor="#7799ee"> 7 <tr bgcolor="#7799ee">
8 <td valign=bottom>&nbsp;<br> 8 <td valign=bottom>&nbsp;<br>
9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.platform</strong></big></big>< /font></td 9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.platform</strong></big></big>< /font></td
10 ><td align=right valign=bottom 10 ><td align=right valign=bottom
11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/platform/__init__.py">telemetry/core/platform/__init__.py</a> </font></td></tr></table> 11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/platform/__init__.py">telemetry/core/platform/__init__.py</a> </font></td></tr></table>
12 <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Autho rs.&nbsp;All&nbsp;rights&nbsp;reserved.<br> 12 <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Autho rs.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by &nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br> 13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by &nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p> 14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
15 <p> 15 <p>
16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
17 <tr bgcolor="#aa55cc"> 17 <tr bgcolor="#aa55cc">
18 <td colspan=3 valign=bottom>&nbsp;<br> 18 <td colspan=3 valign=bottom>&nbsp;<br>
19 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</str ong></big></font></td></tr> 19 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</str ong></big></font></td></tr>
20 20
21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.platform.android_platform_backend.html">android_platf orm_backend</a><br> 22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.platform.android_platform_backend.html">android_platf orm_backend</a><br>
23 <a href="telemetry.core.platform.android_platform_backend_unittest.html">android _platform_backend_unittest</a><br>
23 <a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backe nd</a><br> 24 <a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backe nd</a><br>
24 <a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_bac kend</a><br> 25 <a href="telemetry.core.platform.desktop_platform_backend.html">desktop_platform _backend</a><br>
25 </td><td width="25%" valign=top><a href="telemetry.core.platform.mac_platform_ba ckend.html">mac_platform_backend</a><br> 26 <a href="telemetry.core.platform.factory.html">factory</a><br>
27 </td><td width="25%" valign=top><a href="telemetry.core.platform.linux_platform_ backend.html">linux_platform_backend</a><br>
28 <a href="telemetry.core.platform.mac_platform_backend.html">mac_platform_backend </a><br>
29 <a href="telemetry.core.platform.mac_platform_backend_unittest.html">mac_platfor m_backend_unittest</a><br>
26 <a href="telemetry.core.platform.platform_backend.html">platform_backend</a><br> 30 <a href="telemetry.core.platform.platform_backend.html">platform_backend</a><br>
27 <a href="telemetry.core.platform.posix_platform_backend.html">posix_platform_bac kend</a><br> 31 <a href="telemetry.core.platform.platform_backend_unittest.html">platform_backen d_unittest</a><br>
28 </td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_ backend_unittest.html">posix_platform_backend_unittest</a><br> 32 </td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_ backend.html">posix_platform_backend</a><br>
29 <a href="telemetry.core.platform.profiler.html"><strong>profiler</strong>&nbsp;( package)</a><br> 33 <a href="telemetry.core.platform.posix_platform_backend_unittest.html">posix_pla tform_backend_unittest</a><br>
34 <a href="telemetry.core.platform.power_monitor.html"><strong>power_monitor</stro ng>&nbsp;(package)</a><br>
35 <a href="telemetry.core.platform.proc_supporting_platform_backend.html">proc_sup porting_platform_backend</a><br>
36 <a href="telemetry.core.platform.proc_supporting_platform_backend_unittest.html" >proc_supporting_platform_backend_unittest</a><br>
37 </td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.html"> <strong>profiler</strong>&nbsp;(package)</a><br>
38 <a href="telemetry.core.platform.ps_util.html">ps_util</a><br>
30 <a href="telemetry.core.platform.win_platform_backend.html">win_platform_backend </a><br> 39 <a href="telemetry.core.platform.win_platform_backend.html">win_platform_backend </a><br>
31 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> 40 </td></tr></table></td></tr></table><p>
32 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
33 <tr bgcolor="#ee77aa"> 42 <tr bgcolor="#ee77aa">
34 <td colspan=3 valign=bottom>&nbsp;<br> 43 <td colspan=3 valign=bottom>&nbsp;<br>
35 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr> 44 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>
36 45
37 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 46 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
38 <td width="100%"><dl> 47 <td width="100%"><dl>
39 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a> 48 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>
40 </font></dt><dd> 49 </font></dt><dd>
41 <dl> 50 <dl>
42 <dt><font face="helvetica, arial"><a href="telemetry.core.platform.html#Platform ">Platform</a> 51 <dt><font face="helvetica, arial"><a href="telemetry.core.platform.html#Platform ">Platform</a>
43 </font></dt></dl> 52 </font></dt></dl>
44 </dd> 53 </dd>
45 </dl> 54 </dl>
46 <p> 55 <p>
47 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 56 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
48 <tr bgcolor="#ffc8d8"> 57 <tr bgcolor="#ffc8d8">
49 <td colspan=3 valign=bottom>&nbsp;<br> 58 <td colspan=3 valign=bottom>&nbsp;<br>
50 <font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>P latform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</ font></td></tr> 59 <font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>P latform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</ font></td></tr>
51 60
52 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td> 61 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
53 <td colspan=2><tt>The&nbsp;platform&nbsp;that&nbsp;the&nbsp;target&nbsp;browser& nbsp;is&nbsp;running&nbsp;on.<br> 62 <td colspan=2><tt>The&nbsp;platform&nbsp;that&nbsp;the&nbsp;target&nbsp;browser& nbsp;is&nbsp;running&nbsp;on.<br>
54 &nbsp;<br> 63 &nbsp;<br>
55 Provides&nbsp;a&nbsp;limited&nbsp;interface&nbsp;to&nbsp;interact&nbsp;with&nbsp ;the&nbsp;platform&nbsp;itself,&nbsp;where<br> 64 Provides&nbsp;a&nbsp;limited&nbsp;interface&nbsp;to&nbsp;interact&nbsp;with&nbsp ;the&nbsp;platform&nbsp;itself,&nbsp;where<br>
56 possible.&nbsp;It's&nbsp;important&nbsp;to&nbsp;note&nbsp;that&nbsp;platforms&nb sp;may&nbsp;not&nbsp;provide&nbsp;a&nbsp;specific<br> 65 possible.&nbsp;It's&nbsp;important&nbsp;to&nbsp;note&nbsp;that&nbsp;platforms&nb sp;may&nbsp;not&nbsp;provide&nbsp;a&nbsp;specific<br>
57 API,&nbsp;so&nbsp;check&nbsp;with&nbsp;IsFooBar()&nbsp;for&nbsp;availability.<br >&nbsp;</tt></td></tr> 66 API,&nbsp;so&nbsp;check&nbsp;with&nbsp;IsFooBar()&nbsp;for&nbsp;availability.<br >&nbsp;</tt></td></tr>
58 <tr><td>&nbsp;</td> 67 <tr><td>&nbsp;</td>
59 <td width="100%">Methods defined here:<br> 68 <td width="100%">Methods defined here:<br>
69 <dl><dt><a name="Platform-CanCaptureVideo"><strong>CanCaptureVideo</strong></a>( self)</dt><dd><tt>Returns&nbsp;a&nbsp;bool&nbsp;indicating&nbsp;whether&nbsp;the &nbsp;platform&nbsp;supports&nbsp;video&nbsp;capture.</tt></dd></dl>
70
71 <dl><dt><a name="Platform-CanFlushIndividualFilesFromSystemCache"><strong>CanFlu shIndividualFilesFromSystemCache</strong></a>(self)</dt><dd><tt>Returns&nbsp;tru e&nbsp;if&nbsp;the&nbsp;disk&nbsp;cache&nbsp;can&nbsp;be&nbsp;flushed&nbsp;for&n bsp;specific&nbsp;files.</tt></dd></dl>
72
73 <dl><dt><a name="Platform-CanLaunchApplication"><strong>CanLaunchApplication</st rong></a>(self, application)</dt><dd><tt>Returns&nbsp;whether&nbsp;the&nbsp;plat form&nbsp;can&nbsp;launch&nbsp;the&nbsp;given&nbsp;application.</tt></dd></dl>
74
75 <dl><dt><a name="Platform-CanMonitorPowerAsync"><strong>CanMonitorPowerAsync</st rong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;iff&nbsp;power&nbsp;can&nbsp; be&nbsp;monitored&nbsp;asynchronously&nbsp;via<br>
76 <a href="#Platform-StartMonitoringPowerAsync">StartMonitoringPowerAsync</a>()&nb sp;and&nbsp;<a href="#Platform-StopMonitoringPowerAsync">StopMonitoringPowerAsyn c</a>().</tt></dd></dl>
77
78 <dl><dt><a name="Platform-CanMonitorPowerSync"><strong>CanMonitorPowerSync</stro ng></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;iff&nbsp;power&nbsp;can&nbsp;be &nbsp;monitored&nbsp;synchronously&nbsp;via<br>
79 <a href="#Platform-MonitorPowerSync">MonitorPowerSync</a>().</tt></dd></dl>
80
60 <dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermal Throttling</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp;able&n bsp;to&nbsp;detect&nbsp;thermal&nbsp;throttling.<br> 81 <dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermal Throttling</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp;able&n bsp;to&nbsp;detect&nbsp;thermal&nbsp;throttling.<br>
61 &nbsp;<br> 82 &nbsp;<br>
62 Some&nbsp;fan-less&nbsp;computers&nbsp;go&nbsp;into&nbsp;a&nbsp;reduced&nbsp;per formance&nbsp;mode&nbsp;when&nbsp;their&nbsp;heat<br> 83 Some&nbsp;fan-less&nbsp;computers&nbsp;go&nbsp;into&nbsp;a&nbsp;reduced&nbsp;per formance&nbsp;mode&nbsp;when&nbsp;their&nbsp;heat<br>
63 exceeds&nbsp;a&nbsp;certain&nbsp;threshold.&nbsp;Performance&nbsp;tests&nbsp;in& nbsp;particular&nbsp;should&nbsp;use&nbsp;this<br> 84 exceeds&nbsp;a&nbsp;certain&nbsp;threshold.&nbsp;Performance&nbsp;tests&nbsp;in& nbsp;particular&nbsp;should&nbsp;use&nbsp;this<br>
64 API&nbsp;to&nbsp;detect&nbsp;if&nbsp;this&nbsp;has&nbsp;happened&nbsp;and&nbsp;i nterpret&nbsp;results&nbsp;accordingly.</tt></dd></dl> 85 API&nbsp;to&nbsp;detect&nbsp;if&nbsp;this&nbsp;has&nbsp;happened&nbsp;and&nbsp;i nterpret&nbsp;results&nbsp;accordingly.</tt></dd></dl>
65 86
87 <dl><dt><a name="Platform-FlushEntireSystemCache"><strong>FlushEntireSystemCache </strong></a>(self)</dt><dd><tt>Flushes&nbsp;the&nbsp;OS's&nbsp;file&nbsp;cache& nbsp;completely.<br>
88 &nbsp;<br>
89 This&nbsp;function&nbsp;may&nbsp;require&nbsp;root&nbsp;or&nbsp;administrator&nb sp;access.</tt></dd></dl>
90
91 <dl><dt><a name="Platform-FlushSystemCacheForDirectory"><strong>FlushSystemCache ForDirectory</strong></a>(self, directory, ignoring<font color="#909090">=None</ font>)</dt><dd><tt>Flushes&nbsp;the&nbsp;OS's&nbsp;file&nbsp;cache&nbsp;for&nbsp ;the&nbsp;specified&nbsp;directory.<br>
92 &nbsp;<br>
93 Any&nbsp;files&nbsp;or&nbsp;directories&nbsp;inside&nbsp;|directory|&nbsp;matchi ng&nbsp;a&nbsp;name&nbsp;in&nbsp;the<br>
94 |ignoring|&nbsp;list&nbsp;will&nbsp;be&nbsp;skipped.<br>
95 &nbsp;<br>
96 This&nbsp;function&nbsp;does&nbsp;not&nbsp;require&nbsp;root&nbsp;or&nbsp;admini strator&nbsp;access.</tt></dd></dl>
97
66 <dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><d d><tt>Returns&nbsp;a&nbsp;string&nbsp;description&nbsp;of&nbsp;the&nbsp;<a href= "#Platform">Platform</a>&nbsp;OS.<br> 98 <dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><d d><tt>Returns&nbsp;a&nbsp;string&nbsp;description&nbsp;of&nbsp;the&nbsp;<a href= "#Platform">Platform</a>&nbsp;OS.<br>
67 &nbsp;<br> 99 &nbsp;<br>
68 Examples:&nbsp;WIN,&nbsp;MAC,&nbsp;LINUX,&nbsp;CHROMEOS</tt></dd></dl> 100 Examples:&nbsp;WIN,&nbsp;MAC,&nbsp;LINUX,&nbsp;CHROMEOS</tt></dd></dl>
69 101
70 <dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a >(self)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;description&nbsp;of&nbsp;the &nbsp;<a href="#Platform">Platform</a>&nbsp;OS&nbsp;version.<br> 102 <dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a >(self)</dt><dd><tt>Returns&nbsp;a&nbsp;logically&nbsp;sortable,&nbsp;string-lik e&nbsp;description&nbsp;of&nbsp;the&nbsp;<a href="#Platform">Platform</a>&nbsp;O S<br>
103 version.<br>
71 &nbsp;<br> 104 &nbsp;<br>
72 Examples:&nbsp;VISTA,&nbsp;WIN7,&nbsp;LION,&nbsp;MOUNTAINLION</tt></dd></dl> 105 Examples:&nbsp;VISTA,&nbsp;WIN7,&nbsp;LION,&nbsp;MOUNTAINLION</tt></dd></dl>
73 106
74 <dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisp layFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list &nbsp;of&nbsp;RawDisplayFrameRateMeasurement.</tt></dd></dl> 107 <dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisp layFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list &nbsp;of&nbsp;RawDisplayFrameRateMeasurement.</tt></dd></dl>
75 108
76 <dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThr ottled</strong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;de vice&nbsp;has&nbsp;been&nbsp;thermally&nbsp;throttled.</tt></dd></dl> 109 <dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThr ottled</strong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;de vice&nbsp;has&nbsp;been&nbsp;thermally&nbsp;throttled.</tt></dd></dl>
77 110
111 <dl><dt><a name="Platform-InstallApplication"><strong>InstallApplication</strong ></a>(self, application)</dt><dd><tt>Installs&nbsp;the&nbsp;given&nbsp;applicati on.</tt></dd></dl>
112
113 <dl><dt><a name="Platform-IsApplicationRunning"><strong>IsApplicationRunning</st rong></a>(self, application)</dt><dd><tt>Returns&nbsp;whether&nbsp;an&nbsp;appli cation&nbsp;is&nbsp;currently&nbsp;running.</tt></dd></dl>
114
78 <dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFr ameRateSupported</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp; able&nbsp;to&nbsp;collect&nbsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl> 115 <dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFr ameRateSupported</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp; able&nbsp;to&nbsp;collect&nbsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl>
79 116
80 <dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</st rong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;device&nbsp; is&nbsp;currently&nbsp;thermally&nbsp;throttled.</tt></dd></dl> 117 <dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</st rong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;device&nbsp; is&nbsp;currently&nbsp;thermally&nbsp;throttled.</tt></dd></dl>
81 118
119 <dl><dt><a name="Platform-LaunchApplication"><strong>LaunchApplication</strong>< /a>(self, application, parameters<font color="#909090">=None</font>, elevate_pri vilege<font color="#909090">=False</font>)</dt><dd><tt>"Launches&nbsp;the&nbsp;g iven&nbsp;|application|&nbsp;with&nbsp;a&nbsp;list&nbsp;of&nbsp;|parameters|&nbs p;on&nbsp;the&nbsp;OS.<br>
120 &nbsp;<br>
121 Set&nbsp;|elevate_privilege|&nbsp;to&nbsp;launch&nbsp;the&nbsp;application&nbsp; with&nbsp;root&nbsp;or&nbsp;admin&nbsp;rights.<br>
122 &nbsp;<br>
123 Returns:<br>
124 &nbsp;&nbsp;A&nbsp;popen&nbsp;style&nbsp;process&nbsp;handle&nbsp;for&nbsp;host& nbsp;platforms.</tt></dd></dl>
125
126 <dl><dt><a name="Platform-MonitorPowerSync"><strong>MonitorPowerSync</strong></a >(self, duration_ms)</dt><dd><tt>Synchronously&nbsp;monitors&nbsp;power&nbsp;for &nbsp;|duration_ms|.<br>
127 &nbsp;<br>
128 Returns:<br>
129 &nbsp;&nbsp;A&nbsp;dict&nbsp;of&nbsp;power&nbsp;utilization&nbsp;statistics&nbsp ;containing:&nbsp;{<br>
130 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;The&nbsp;instantaneous&nbsp;power&nbsp;(voltage&n bsp;*&nbsp;current)&nbsp;reading&nbsp;in&nbsp;milliwatts&nbsp;at<br>
131 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;each&nbsp;sample.<br>
132 &nbsp;&nbsp;&nbsp;&nbsp;'power_samples_mw':&nbsp;[mw0,&nbsp;mw1,&nbsp;...,&nbsp; mwN],<br>
133 &nbsp;<br>
134 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;The&nbsp;total&nbsp;energy&nbsp;consumption&nbsp; during&nbsp;the&nbsp;sampling&nbsp;period&nbsp;in&nbsp;milliwatt<br>
135 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;hours.&nbsp;May&nbsp;be&nbsp;estimated&nbsp;by&nb sp;integrating&nbsp;power&nbsp;samples&nbsp;or&nbsp;may&nbsp;be&nbsp;exact<br>
136 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;on&nbsp;supported&nbsp;hardware.<br>
137 &nbsp;&nbsp;&nbsp;&nbsp;'energy_consumption_mwh':&nbsp;mwh,<br>
138 &nbsp;<br>
139 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;A&nbsp;platform-specific&nbsp;dictionary&nbsp;of& nbsp;additional&nbsp;details&nbsp;about&nbsp;the<br>
140 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;utilization&nbsp;of&nbsp;individual&nbsp;hardware &nbsp;components.<br>
141 &nbsp;&nbsp;&nbsp;&nbsp;hw_component_utilization:&nbsp;{<br>
142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...<br>
143 &nbsp;&nbsp;&nbsp;&nbsp;}<br>
144 &nbsp;&nbsp;}</tt></dd></dl>
145
82 <dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerforma nceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms&nbsp;may&nbsp;t weak&nbsp;their&nbsp;CPU&nbsp;governor,&nbsp;system&nbsp;status,&nbsp;etc.<br> 146 <dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerforma nceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms&nbsp;may&nbsp;t weak&nbsp;their&nbsp;CPU&nbsp;governor,&nbsp;system&nbsp;status,&nbsp;etc.<br>
83 &nbsp;<br> 147 &nbsp;<br>
84 Most&nbsp;platforms&nbsp;can&nbsp;operate&nbsp;in&nbsp;a&nbsp;battery&nbsp;savin g&nbsp;mode.&nbsp;While&nbsp;good&nbsp;for&nbsp;battery<br> 148 Most&nbsp;platforms&nbsp;can&nbsp;operate&nbsp;in&nbsp;a&nbsp;battery&nbsp;savin g&nbsp;mode.&nbsp;While&nbsp;good&nbsp;for&nbsp;battery<br>
85 life,&nbsp;this&nbsp;can&nbsp;cause&nbsp;confusing&nbsp;performance&nbsp;results &nbsp;and&nbsp;add&nbsp;noise.&nbsp;Turning<br> 149 life,&nbsp;this&nbsp;can&nbsp;cause&nbsp;confusing&nbsp;performance&nbsp;results &nbsp;and&nbsp;add&nbsp;noise.&nbsp;Turning<br>
86 full&nbsp;performance&nbsp;mode&nbsp;on&nbsp;disables&nbsp;these&nbsp;features,& nbsp;which&nbsp;is&nbsp;useful&nbsp;for<br> 150 full&nbsp;performance&nbsp;mode&nbsp;on&nbsp;disables&nbsp;these&nbsp;features,& nbsp;which&nbsp;is&nbsp;useful&nbsp;for<br>
87 performance&nbsp;testing.</tt></dd></dl> 151 performance&nbsp;testing.</tt></dd></dl>
88 152
153 <dl><dt><a name="Platform-StartMonitoringPowerAsync"><strong>StartMonitoringPowe rAsync</strong></a>(self)</dt><dd><tt>Starts&nbsp;monitoring&nbsp;power&nbsp;uti lization&nbsp;statistics.</tt></dd></dl>
154
89 <dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawD isplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start&nbsp;measuring&n bsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl> 155 <dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawD isplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start&nbsp;measuring&n bsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl>
90 156
157 <dl><dt><a name="Platform-StartVideoCapture"><strong>StartVideoCapture</strong>< /a>(self, min_bitrate_mbps)</dt><dd><tt>Starts&nbsp;capturing&nbsp;video.<br>
158 &nbsp;<br>
159 Outer&nbsp;framing&nbsp;may&nbsp;be&nbsp;included&nbsp;(from&nbsp;the&nbsp;OS,&n bsp;browser&nbsp;window,&nbsp;and&nbsp;webcam).<br>
160 &nbsp;<br>
161 Args:<br>
162 &nbsp;&nbsp;min_bitrate_mbps:&nbsp;The&nbsp;minimum&nbsp;capture&nbsp;bitrate&nb sp;in&nbsp;MegaBits&nbsp;Per&nbsp;Second.<br>
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;platform&nbsp;is&nbsp;free&nbsp;to& nbsp;deliver&nbsp;a&nbsp;higher&nbsp;bitrate&nbsp;if&nbsp;it&nbsp;can&nbsp;do&nb sp;so<br>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;without&nbsp;increasing&nbsp;overhead.<br>
165 &nbsp;<br>
166 Raises:<br>
167 &nbsp;&nbsp;ValueError&nbsp;if&nbsp;the&nbsp;required&nbsp;|min_bitrate_mbps|&nb sp;can't&nbsp;be&nbsp;achieved.</tt></dd></dl>
168
169 <dl><dt><a name="Platform-StopMonitoringPowerAsync"><strong>StopMonitoringPowerA sync</strong></a>(self)</dt><dd><tt>Stops&nbsp;monitoring&nbsp;power&nbsp;utiliz ation&nbsp;and&nbsp;returns&nbsp;collects&nbsp;stats<br>
170 &nbsp;<br>
171 Returns:<br>
172 &nbsp;&nbsp;A&nbsp;dict&nbsp;of&nbsp;power&nbsp;utilization&nbsp;statistics&nbsp ;containing:&nbsp;{<br>
173 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;An&nbsp;identifier&nbsp;for&nbsp;the&nbsp;data&nb sp;provider.&nbsp;Allows&nbsp;to&nbsp;evaluate&nbsp;the&nbsp;precision<br>
174 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;of&nbsp;the&nbsp;data.&nbsp;Example&nbsp;values:& nbsp;monsoon,&nbsp;powermetrics,&nbsp;ds2784<br>
175 &nbsp;&nbsp;&nbsp;&nbsp;'identifier':&nbsp;identifier,<br>
176 &nbsp;<br>
177 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;The&nbsp;instantaneous&nbsp;power&nbsp;(voltage&n bsp;*&nbsp;current)&nbsp;reading&nbsp;in&nbsp;milliwatts&nbsp;at<br>
178 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;each&nbsp;sample.<br>
179 &nbsp;&nbsp;&nbsp;&nbsp;'power_samples_mw':&nbsp;&nbsp;[mw0,&nbsp;mw1,&nbsp;..., &nbsp;mwN],<br>
180 &nbsp;<br>
181 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;The&nbsp;total&nbsp;energy&nbsp;consumption&nbsp; during&nbsp;the&nbsp;sampling&nbsp;period&nbsp;in&nbsp;milliwatt<br>
182 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;hours.&nbsp;May&nbsp;be&nbsp;estimated&nbsp;by&nb sp;integrating&nbsp;power&nbsp;samples&nbsp;or&nbsp;may&nbsp;be&nbsp;exact<br>
183 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;on&nbsp;supported&nbsp;hardware.<br>
184 &nbsp;&nbsp;&nbsp;&nbsp;'energy_consumption_mwh':&nbsp;mwh,<br>
185 &nbsp;<br>
186 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;A&nbsp;platform-specific&nbsp;dictionary&nbsp;of& nbsp;additional&nbsp;details&nbsp;about&nbsp;the<br>
187 &nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;utilization&nbsp;of&nbsp;individual&nbsp;hardware &nbsp;components.<br>
188 &nbsp;&nbsp;&nbsp;&nbsp;hw_component_utilization:&nbsp;{<br>
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...<br>
190 &nbsp;&nbsp;&nbsp;&nbsp;}<br>
191 &nbsp;&nbsp;}</tt></dd></dl>
192
91 <dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDis playFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop&nbsp;measuring&nbsp ;GL&nbsp;surface&nbsp;stats.</tt></dd></dl> 193 <dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDis playFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop&nbsp;measuring&nbsp ;GL&nbsp;surface&nbsp;stats.</tt></dd></dl>
92 194
195 <dl><dt><a name="Platform-StopVideoCapture"><strong>StopVideoCapture</strong></a >(self)</dt><dd><tt>Stops&nbsp;capturing&nbsp;video.<br>
196 &nbsp;<br>
197 Yields:<br>
198 &nbsp;&nbsp;(time_ms,&nbsp;bitmap)&nbsp;tuples&nbsp;representing&nbsp;each&nbsp; video&nbsp;keyframe.&nbsp;Only&nbsp;the&nbsp;first<br>
199 &nbsp;&nbsp;frame&nbsp;in&nbsp;a&nbsp;run&nbsp;of&nbsp;sequential&nbsp;duplicate &nbsp;bitmaps&nbsp;is&nbsp;included.<br>
200 &nbsp;&nbsp;&nbsp;&nbsp;time_ms&nbsp;is&nbsp;milliseconds&nbsp;relative&nbsp;to& nbsp;the&nbsp;first&nbsp;frame.<br>
201 &nbsp;&nbsp;&nbsp;&nbsp;bitmap&nbsp;is&nbsp;a&nbsp;telemetry.core.Bitmap.</tt></ dd></dl>
202
93 <dl><dt><a name="Platform-__init__"><strong>__init__</strong></a>(self, platform _backend)</dt></dl> 203 <dl><dt><a name="Platform-__init__"><strong>__init__</strong></a>(self, platform _backend)</dt></dl>
94 204
95 <hr> 205 <hr>
96 Data descriptors defined here:<br> 206 Data descriptors defined here:<br>
97 <dl><dt><strong>__dict__</strong></dt> 207 <dl><dt><strong>__dict__</strong></dt>
98 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 208 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd>
99 </dl> 209 </dl>
100 <dl><dt><strong>__weakref__</strong></dt> 210 <dl><dt><strong>__weakref__</strong></dt>
101 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 211 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
102 </dl> 212 </dl>
103 <hr> 213 <hr>
104 Data and other attributes defined here:<br> 214 Data and other attributes defined here:<br>
105 <dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = &lt;class 'telemetry.c ore.platform.RawDisplayFrameRateMeasurement'&gt;</dl> 215 <dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = &lt;class 'telemetry.c ore.platform.RawDisplayFrameRateMeasurement'&gt;</dl>
106 216
107 </td></tr></table></td></tr></table> 217 </td></tr></table></td></tr></table>
108 </body></html> 218 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698