<doc>
  <legacy_id>1792</legacy_id>
  <name>playRate</name>
  <type>property</type>
  <syntax>
    <example>set the playRate of <i>player</i> to <i>rate</i></example>
  </syntax>
  <library></library>
  <objects>
    <player/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Images &amp; Multimedia</category>
  </classification>
  <references>
    <property tag="looping">looping Property</property>
    <property tag="callbacks">callbacks Property</property>
    <property tag="startTime">startTime Property</property>
    <command tag="play">play Command</command>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies how fast a <keyword tag="player">player</keyword> plays a movie.</summary>
  <examples>
    <example>set the playRate of player 17 to 0.5 <code><i>-- half-speed</i></code></example>
  </examples>
  <description>
    <p>Use the <b>playRate</b> <glossary tag="property">property</glossary> to speed up or slow down playback of a movie or sound.</p><p/><p><b>Value:</b></p><p>The <b>playRate</b> of a <keyword tag="player">player</keyword> is a <glossary tag="real number">real number</glossary>.</p><p/><p>By default, the <b>playRate</b> <glossary tag="property">property</glossary> of a newly created <keyword tag="player">player</keyword> is set to 1.</p><p/><p><b>Comments:</b></p><p>The <b>playRate</b> is the ratio between the desired playback rate and the natural rate of the movie or sound. A <b>playRate</b> of 1 plays the movie or sound at normal speed; a <b>playRate</b> greater than one speeds up the playback; a <b>playRate</b> less than one slows down the playback.</p><p/><p>A negative <b>playRate</b> plays the movie or sound backward.</p><p/><p>If the <b>playRate</b> is zero, the movie or sound is paused.</p>
  </description>
</doc>