/apidocs/echonest.action.Playback-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 338 lines · 293 code · 23 blank · 22 comment · 0 complexity · b7eb775f1586df2b745fd1f570e3bbd9 MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>echonest.action.Playback</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17. 

  18.   <!-- Tree link -->
    19. 

  19.       <th>&nbsp;&nbsp;&nbsp;<a
    20. 

  20.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    21. 

  21. 

  22.   <!-- Index link -->
    23. 

  23.       <th>&nbsp;&nbsp;&nbsp;<a
    24. 

  24.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    25. 

  25. 

  26.   <!-- Help link -->
    27. 

  27.       <th>&nbsp;&nbsp;&nbsp;<a
    28. 

  28.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    29. 

  29. 

  30.   <!-- Project homepage -->
    31. 

  31.       <th class="navbar" align="right" width="100%">
    32. 

  32.         <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33.           <tr><th class="navbar" align="center"
    34. 

  34.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
    35. 

  35.           </tr></table></th>
    36. 

  36.   </tr>
    37. 

  37. </table>
    38. 

  38. <table width="100%" cellpadding="0" cellspacing="0">
    39. 

  39.   <tr valign="top">
    40. 

  40.     <td width="100%">
    41. 

  41.       <span class="breadcrumbs">
    42. 

  42.         <a href="echonest-module.html">Package&nbsp;echonest</a> ::
    43. 

  43.         <a href="echonest.action-module.html">Module&nbsp;action</a> ::
    44. 

  44.         Class&nbsp;Playback
    45. 

  45.       </span>
    46. 

  46.     </td>
    47. 

  47.     <td>
    48. 

  48.       <table cellpadding="0" cellspacing="0">
    49. 

  49.         <!-- hide/show private -->
    50. 

  50.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    51. 

  51.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    52. 

  52.         <tr><td align="right"><span class="options"
    53. 

  53.             >[<a href="frames.html" target="_top">frames</a
    54. 

  54.             >]&nbsp;|&nbsp;<a href="echonest.action.Playback-class.html"
    55. 

  55.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    56. 

  56.       </table>
    57. 

  57.     </td>
    58. 

  58.   </tr>
    59. 

  59. </table>
    60. 

  60. <!-- ==================== CLASS DESCRIPTION ==================== -->
    61. 

  61. <h1 class="epydoc">Class Playback</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.action-pysrc.html#Playback">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. A snippet of the given track with start and duration. Volume leveling may be applied.
    67. 

  67. 

  68. <!-- ==================== INSTANCE METHODS ==================== -->
    69. 

  69. <a name="section-InstanceMethods"></a>
    70. 

  70. <table class="summary" border="1" cellpadding="3"
    71. 

  71.        cellspacing="0" width="100%" bgcolor="white">
    72. 

  72. <tr bgcolor="#70b0f0" class="table-header">
    73. 

  73.   <td colspan="2" class="table-header">
    74. 

  74.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    75. 

  75.       <tr valign="top">
    76. 

  76.         <td align="left"><span class="table-header">Instance Methods</span></td>
    77. 

  77.         <td align="right" valign="top"
    78. 

  78.          ><span class="options">[<a href="#section-InstanceMethods"
    79. 

  79.          class="privatelink" onclick="toggle_private();"
    80. 

  80.          >hide private</a>]</span></td>
    81. 

  81.       </tr>
    82. 

  82.     </table>
    83. 

  83.   </td>
    84. 

  84. </tr>
    85. 

  85. <tr>
    86. 

  86.     <td width="15%" align="right" valign="top" class="summary">
    87. 

  87.       <span class="summary-type">&nbsp;</span>
    88. 

  88.     </td><td class="summary">
    89. 

  89.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    90. 

  90.         <tr>
    91. 

  91.           <td><span class="summary-sig"><a href="echonest.action.Playback-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    92. 

  92.         <span class="summary-sig-arg">track</span>,
    93. 

  93.         <span class="summary-sig-arg">start</span>,
    94. 

  94.         <span class="summary-sig-arg">duration</span>)</span><br />
    95. 

  95.       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
    96. 

  96.           <td align="right" valign="top">
    97. 

  97.             <span class="codelink"><a href="echonest.action-pysrc.html#Playback.__init__">source&nbsp;code</a></span>
    98. 

  98.             
    99. 

  99.           </td>
    100. 

  100.         </tr>
    101. 

  101.       </table>
    102. 

  102.       
    103. 

  103.     </td>
    104. 

  104.   </tr>
    105. 

  105. <tr>
    106. 

  106.     <td width="15%" align="right" valign="top" class="summary">
    107. 

  107.       <span class="summary-type">&nbsp;</span>
    108. 

  108.     </td><td class="summary">
    109. 

  109.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    110. 

  110.         <tr>
    111. 

  111.           <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>)</span></td>
    112. 

  112.           <td align="right" valign="top">
    113. 

  113.             <span class="codelink"><a href="echonest.action-pysrc.html#Playback.render">source&nbsp;code</a></span>
    114. 

  114.             
    115. 

  115.           </td>
    116. 

  116.         </tr>
    117. 

  117.       </table>
    118. 

  118.       
    119. 

  119.     </td>
    120. 

  120.   </tr>
    121. 

  121. <tr>
    122. 

  122.     <td width="15%" align="right" valign="top" class="summary">
    123. 

  123.       <span class="summary-type">&nbsp;</span>
    124. 

  124.     </td><td class="summary">
    125. 

  125.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    126. 

  126.         <tr>
    127. 

  127.           <td><span class="summary-sig"><a href="echonest.action.Playback-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
    128. 

  128.       repr(x)</td>
    129. 

  129.           <td align="right" valign="top">
    130. 

  130.             <span class="codelink"><a href="echonest.action-pysrc.html#Playback.__repr__">source&nbsp;code</a></span>
    131. 

  131.             
    132. 

  132.           </td>
    133. 

  133.         </tr>
    134. 

  134.       </table>
    135. 

  135.       
    136. 

  136.     </td>
    137. 

  137.   </tr>
    138. 

  138. <tr>
    139. 

  139.     <td width="15%" align="right" valign="top" class="summary">
    140. 

  140.       <span class="summary-type">&nbsp;</span>
    141. 

  141.     </td><td class="summary">
    142. 

  142.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    143. 

  143.         <tr>
    144. 

  144.           <td><span class="summary-sig"><a href="echonest.action.Playback-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
    145. 

  145.       str(x)</td>
    146. 

  146.           <td align="right" valign="top">
    147. 

  147.             <span class="codelink"><a href="echonest.action-pysrc.html#Playback.__str__">source&nbsp;code</a></span>
    148. 

  148.             
    149. 

  149.           </td>
    150. 

  150.         </tr>
    151. 

  151.       </table>
    152. 

  152.       
    153. 

  153.     </td>
    154. 

  154.   </tr>
    155. 

  155.   <tr>
    156. 

  156.     <td colspan="2" class="summary">
    157. 

  157.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    158. 

  158.       <code>__delattr__</code>,
    159. 

  159.       <code>__format__</code>,
    160. 

  160.       <code>__getattribute__</code>,
    161. 

  161.       <code>__hash__</code>,
    162. 

  162.       <code>__new__</code>,
    163. 

  163.       <code>__reduce__</code>,
    164. 

  164.       <code>__reduce_ex__</code>,
    165. 

  165.       <code>__setattr__</code>,
    166. 

  166.       <code>__sizeof__</code>,
    167. 

  167.       <code>__subclasshook__</code>
    168. 

  168.       </p>
    169. 

  169.     </td>
    170. 

  170.   </tr>
    171. 

  171. </table>
    172. 

  172. <!-- ==================== PROPERTIES ==================== -->
    173. 

  173. <a name="section-Properties"></a>
    174. 

  174. <table class="summary" border="1" cellpadding="3"
    175. 

  175.        cellspacing="0" width="100%" bgcolor="white">
    176. 

  176. <tr bgcolor="#70b0f0" class="table-header">
    177. 

  177.   <td colspan="2" class="table-header">
    178. 

  178.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    179. 

  179.       <tr valign="top">
    180. 

  180.         <td align="left"><span class="table-header">Properties</span></td>
    181. 

  181.         <td align="right" valign="top"
    182. 

  182.          ><span class="options">[<a href="#section-Properties"
    183. 

  183.          class="privatelink" onclick="toggle_private();"
    184. 

  184.          >hide private</a>]</span></td>
    185. 

  185.       </tr>
    186. 

  186.     </table>
    187. 

  187.   </td>
    188. 

  188. </tr>
    189. 

  189.   <tr>
    190. 

  190.     <td colspan="2" class="summary">
    191. 

  191.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    192. 

  192.       <code>__class__</code>
    193. 

  193.       </p>
    194. 

  194.     </td>
    195. 

  195.   </tr>
    196. 

  196. </table>
    197. 

  197. <!-- ==================== METHOD DETAILS ==================== -->
    198. 

  198. <a name="section-MethodDetails"></a>
    199. 

  199. <table class="details" border="1" cellpadding="3"
    200. 

  200.        cellspacing="0" width="100%" bgcolor="white">
    201. 

  201. <tr bgcolor="#70b0f0" class="table-header">
    202. 

  202.   <td colspan="2" class="table-header">
    203. 

  203.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    204. 

  204.       <tr valign="top">
    205. 

  205.         <td align="left"><span class="table-header">Method Details</span></td>
    206. 

  206.         <td align="right" valign="top"
    207. 

  207.          ><span class="options">[<a href="#section-MethodDetails"
    208. 

  208.          class="privatelink" onclick="toggle_private();"
    209. 

  209.          >hide private</a>]</span></td>
    210. 

  210.       </tr>
    211. 

  211.     </table>
    212. 

  212.   </td>
    213. 

  213. </tr>
    214. 

  214. </table>
    215. 

  215. <a name="__init__"></a>
    216. 

  216. <div>
    217. 

  217. <table class="details" border="1" cellpadding="3"
    218. 

  218.        cellspacing="0" width="100%" bgcolor="white">
    219. 

  219. <tr><td>
    220. 

  220.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    221. 

  221.   <tr valign="top"><td>
    222. 

  222.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    223. 

  223.         <span class="sig-arg">track</span>,
    224. 

  224.         <span class="sig-arg">start</span>,
    225. 

  225.         <span class="sig-arg">duration</span>)</span>
    226. 

  226.     <br /><em class="fname">(Constructor)</em>
    227. 

  227.   </h3>
    228. 

  228.   </td><td align="right" valign="top"
    229. 

  229.     ><span class="codelink"><a href="echonest.action-pysrc.html#Playback.__init__">source&nbsp;code</a></span>&nbsp;
    230. 

  230.     </td>
    231. 

  231.   </tr></table>
    232. 

  232.   
    233. 

  233.   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
    234. 

  234.   <dl class="fields">
    235. 

  235.     <dt>Overrides:
    236. 

  236.         object.__init__
    237. 

  237.         <dd><em class="note">(inherited documentation)</em></dd>
    238. 

  238.     </dt>
    239. 

  239.   </dl>
    240. 

  240. </td></tr></table>
    241. 

  241. </div>
    242. 

  242. <a name="__repr__"></a>
    243. 

  243. <div>
    244. 

  244. <table class="details" border="1" cellpadding="3"
    245. 

  245.        cellspacing="0" width="100%" bgcolor="white">
    246. 

  246. <tr><td>
    247. 

  247.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    248. 

  248.   <tr valign="top"><td>
    249. 

  249.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
    250. 

  250.     <br /><em class="fname">(Representation operator)</em>
    251. 

  251.   </h3>
    252. 

  252.   </td><td align="right" valign="top"
    253. 

  253.     ><span class="codelink"><a href="echonest.action-pysrc.html#Playback.__repr__">source&nbsp;code</a></span>&nbsp;
    254. 

  254.     </td>
    255. 

  255.   </tr></table>
    256. 

  256.   
    257. 

  257.   repr(x)
    258. 

  258.   <dl class="fields">
    259. 

  259.     <dt>Overrides:
    260. 

  260.         object.__repr__
    261. 

  261.         <dd><em class="note">(inherited documentation)</em></dd>
    262. 

  262.     </dt>
    263. 

  263.   </dl>
    264. 

  264. </td></tr></table>
    265. 

  265. </div>
    266. 

  266. <a name="__str__"></a>
    267. 

  267. <div>
    268. 

  268. <table class="details" border="1" cellpadding="3"
    269. 

  269.        cellspacing="0" width="100%" bgcolor="white">
    270. 

  270. <tr><td>
    271. 

  271.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    272. 

  272.   <tr valign="top"><td>
    273. 

  273.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
    274. 

  274.     <br /><em class="fname">(Informal representation operator)</em>
    275. 

  275.   </h3>
    276. 

  276.   </td><td align="right" valign="top"
    277. 

  277.     ><span class="codelink"><a href="echonest.action-pysrc.html#Playback.__str__">source&nbsp;code</a></span>&nbsp;
    278. 

  278.     </td>
    279. 

  279.   </tr></table>
    280. 

  280.   
    281. 

  281.   str(x)
    282. 

  282.   <dl class="fields">
    283. 

  283.     <dt>Overrides:
    284. 

  284.         object.__str__
    285. 

  285.         <dd><em class="note">(inherited documentation)</em></dd>
    286. 

  286.     </dt>
    287. 

  287.   </dl>
    288. 

  288. </td></tr></table>
    289. 

  289. </div>
    290. 

  290. <br />
    291. 

  291. <!-- ==================== NAVIGATION BAR ==================== -->
    292. 

  292. <table class="navbar" border="0" width="100%" cellpadding="0"
    293. 

  293.        bgcolor="#a0c0ff" cellspacing="0">
    294. 

  294.   <tr valign="middle">
    295. 

  295. 

  296.   <!-- Tree link -->
    297. 

  297.       <th>&nbsp;&nbsp;&nbsp;<a
    298. 

  298.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    299. 

  299. 

  300.   <!-- Index link -->
    301. 

  301.       <th>&nbsp;&nbsp;&nbsp;<a
    302. 

  302.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    303. 

  303. 

  304.   <!-- Help link -->
    305. 

  305.       <th>&nbsp;&nbsp;&nbsp;<a
    306. 

  306.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    307. 

  307. 

  308.   <!-- Project homepage -->
    309. 

  309.       <th class="navbar" align="right" width="100%">
    310. 

  310.         <table border="0" cellpadding="0" cellspacing="0">
    311. 

  311.           <tr><th class="navbar" align="center"
    312. 

  312.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
    313. 

  313.           </tr></table></th>
    314. 

  314.   </tr>
    315. 

  315. </table>
    316. 

  316. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    317. 

  317.   <tr>
    318. 

  318.     <td align="left" class="footer">
    319. 

  319.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    320. 

  320.     </td>
    321. 

  321.     <td align="right" class="footer">
    322. 

  322.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    323. 

  323.         >http://epydoc.sourceforge.net</a>
    324. 

  324.     </td>
    325. 

  325.   </tr>
    326. 

  326. </table>
    327. 

  327. 

  328. <script type="text/javascript">
    329. 

  329.   <!--
    330. 

  330.   // Private objects are initially displayed (because if
    331. 

  331.   // javascript is turned off then we want them to be
    332. 

  332.   // visible); but by default, we want to hide them.  So hide
    333. 

  333.   // them unless we have a cookie that says to show them.
    334. 

  334.   checkCookie();
    335. 

  335.   // -->
    336. 

  336. </script>
    337. 

  337. </body>
    338. 

  338. </html>
    339.