Home | History | Annotate | Download | only in pydoc
      1 
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      3 <html><head><title>Python: module telemetry.web_perf.metrics.webrtc_rendering_timeline</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.web_perf.html"><font color="#ffffff">web_perf</font></a>.<a href="telemetry.web_perf.metrics.html"><font color="#ffffff">metrics</font></a>.webrtc_rendering_timeline</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/web_perf/metrics/webrtc_rendering_timeline.py">telemetry/web_perf/metrics/webrtc_rendering_timeline.py</a></font></td></tr></table>
     13     <p><tt>#&nbsp;Copyright&nbsp;2015&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
     14 #&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>
     15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
     16 <p>
     17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     18 <tr bgcolor="#aa55cc">
     19 <td colspan=3 valign=bottom>&nbsp;<br>
     20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
     21     
     22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.value.improvement_direction.html">telemetry.value.improvement_direction</a><br>
     24 <a href="telemetry.value.list_of_scalar_values.html">telemetry.value.list_of_scalar_values</a><br>
     25 </td><td width="25%" valign=top><a href="telemetry.value.scalar.html">telemetry.value.scalar</a><br>
     26 <a href="telemetry.web_perf.metrics.webrtc_rendering_stats.html">telemetry.web_perf.metrics.webrtc_rendering_stats</a><br>
     27 </td><td width="25%" valign=top><a href="telemetry.web_perf.metrics.timeline_based_metric.html">telemetry.web_perf.metrics.timeline_based_metric</a><br>
     28 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
     29 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     30 <tr bgcolor="#ee77aa">
     31 <td colspan=3 valign=bottom>&nbsp;<br>
     32 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     33     
     34 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     35 <td width="100%"><dl>
     36 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
     37 </font></dt><dd>
     38 <dl>
     39 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.webrtc_rendering_timeline.html#WebRtcRenderingTimelineMetric">WebRtcRenderingTimelineMetric</a>
     40 </font></dt></dl>
     41 </dd>
     42 </dl>
     43  <p>
     44 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     45 <tr bgcolor="#ffc8d8">
     46 <td colspan=3 valign=bottom>&nbsp;<br>
     47 <font color="#000000" face="helvetica, arial"><a name="WebRtcRenderingTimelineMetric">class <strong>WebRtcRenderingTimelineMetric</strong></a>(<a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>)</font></td></tr>
     48     
     49 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
     50 <td colspan=2><tt>WebrtcRenderingTimelineMetric&nbsp;calculates&nbsp;metric&nbsp;for&nbsp;WebMediaPlayerMS.<br>
     51 &nbsp;<br>
     52 The&nbsp;following&nbsp;metrics&nbsp;are&nbsp;added&nbsp;to&nbsp;the&nbsp;results:<br>
     53 &nbsp;&nbsp;WebRTCRendering_drift_time&nbsp;us<br>
     54 &nbsp;&nbsp;WebRTCRendering_percent_badly_out_of_sync&nbsp;%<br>
     55 &nbsp;&nbsp;WebRTCRendering_percent_out_of_sync&nbsp;%<br>
     56 &nbsp;&nbsp;WebRTCRendering_fps&nbsp;FPS<br>
     57 &nbsp;&nbsp;WebRTCRendering_smoothness_score&nbsp;%<br>
     58 &nbsp;&nbsp;WebRTCRendering_freezing_score&nbsp;%<br>
     59 &nbsp;&nbsp;WebRTCRendering_rendering_length_error&nbsp;%<br>&nbsp;</tt></td></tr>
     60 <tr><td>&nbsp;</td>
     61 <td width="100%"><dl><dt>Method resolution order:</dt>
     62 <dd><a href="telemetry.web_perf.metrics.webrtc_rendering_timeline.html#WebRtcRenderingTimelineMetric">WebRtcRenderingTimelineMetric</a></dd>
     63 <dd><a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a></dd>
     64 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
     65 </dl>
     66 <hr>
     67 Methods defined here:<br>
     68 <dl><dt><a name="WebRtcRenderingTimelineMetric-AddResults"><strong>AddResults</strong></a>(self, model, renderer_thread, interactions, results)</dt><dd><tt>Adding&nbsp;metrics&nbsp;to&nbsp;the&nbsp;results.</tt></dd></dl>
     69 
     70 <dl><dt><a name="WebRtcRenderingTimelineMetric-__init__"><strong>__init__</strong></a>(self)</dt></dl>
     71 
     72 <hr>
     73 Static methods defined here:<br>
     74 <dl><dt><a name="WebRtcRenderingTimelineMetric-IsMediaPlayerMSEvent"><strong>IsMediaPlayerMSEvent</strong></a>(event)</dt><dd><tt>Verify&nbsp;that&nbsp;the&nbsp;event&nbsp;is&nbsp;a&nbsp;webmediaplayerMS&nbsp;event.</tt></dd></dl>
     75 
     76 <hr>
     77 Methods inherited from <a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>:<br>
     78 <dl><dt><a name="WebRtcRenderingTimelineMetric-AddWholeTraceResults"><strong>AddWholeTraceResults</strong></a>(self, model, results)</dt><dd><tt>Computes&nbsp;and&nbsp;adds&nbsp;metrics&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;entire&nbsp;trace.<br>
     79 &nbsp;<br>
     80 Override&nbsp;this&nbsp;method&nbsp;to&nbsp;compute&nbsp;results&nbsp;that&nbsp;correspond&nbsp;to&nbsp;the&nbsp;whole&nbsp;trace.<br>
     81 &nbsp;<br>
     82 Args:<br>
     83 &nbsp;&nbsp;model:&nbsp;An&nbsp;instance&nbsp;of&nbsp;telemetry.timeline.model.TimelineModel.<br>
     84 &nbsp;&nbsp;results:&nbsp;An&nbsp;instance&nbsp;of&nbsp;page.PageTestResults.</tt></dd></dl>
     85 
     86 <dl><dt><a name="WebRtcRenderingTimelineMetric-VerifyNonOverlappedRecords"><strong>VerifyNonOverlappedRecords</strong></a>(self, interaction_records)</dt><dd><tt>This&nbsp;raises&nbsp;exceptions&nbsp;if&nbsp;interaction_records&nbsp;contain&nbsp;overlapped&nbsp;ranges.</tt></dd></dl>
     87 
     88 <hr>
     89 Data descriptors inherited from <a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>:<br>
     90 <dl><dt><strong>__dict__</strong></dt>
     91 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
     92 </dl>
     93 <dl><dt><strong>__weakref__</strong></dt>
     94 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
     95 </dl>
     96 </td></tr></table></td></tr></table><p>
     97 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     98 <tr bgcolor="#55aa55">
     99 <td colspan=3 valign=bottom>&nbsp;<br>
    100 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    101     
    102 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    103 <td width="100%"><strong>WEB_MEDIA_PLAYER_MS_EVENT</strong> = 'WebMediaPlayerMS::UpdateCurrentFrame'</td></tr></table>
    104 </body></html>