/src/pyechonest/doc/build/html/track.html

http://echo-nest-remix.googlecode.com/ · HTML · 289 lines · 272 code · 17 blank · 0 comment · 0 complexity · d8efd05c3969ae4e53e166ae6bc3201a MD5 · raw file 

    

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

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

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

  5.   <head>
    6. 

  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.     
    8. 

  8.     <title>Track – track methods &mdash; pyechonest v4 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="_static/default.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.         URL_ROOT:    '',
    14. 

  14.         VERSION:     '4',
    15. 

  15.         COLLAPSE_INDEX: false,
    16. 

  16.         FILE_SUFFIX: '.html',
    17. 

  17.         HAS_SOURCE:  true
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="_static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="_static/underscore.js"></script>
    22. 

  22.     <script type="text/javascript" src="_static/doctools.js"></script>
    23. 

  23.     <link rel="top" title="pyechonest v4 documentation" href="index.html" />
    24. 

  24.     <link rel="next" title="Playlist – playlist methods" href="playlist.html" />
    25. 

  25.     <link rel="prev" title="Song – song methods" href="song.html" /> 
    26. 

  26.   </head>
    27. 

  27.   <body>
    28. 

  28.     <div class="related">
    29. 

  29.       <h3>Navigation</h3>
    30. 

  30.       <ul>
    31. 

  31.         <li class="right" style="margin-right: 10px">
    32. 

  32.           <a href="genindex.html" title="General Index"
    33. 

  33.              accesskey="I">index</a></li>
    34. 

  34.         <li class="right" >
    35. 

  35.           <a href="py-modindex.html" title="Python Module Index"
    36. 

  36.              >modules</a> |</li>
    37. 

  37.         <li class="right" >
    38. 

  38.           <a href="playlist.html" title="Playlist – playlist methods"
    39. 

  39.              accesskey="N">next</a> |</li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="song.html" title="Song – song methods"
    42. 

  42.              accesskey="P">previous</a> |</li>
    43. 

  43.         <li><a href="index.html">pyechonest v4 documentation</a> &raquo;</li> 
    44. 

  44.       </ul>
    45. 

  45.     </div>  
    46. 

  46. 

  47.     <div class="document">
    48. 

  48.       <div class="documentwrapper">
    49. 

  49.         <div class="bodywrapper">
    50. 

  50.           <div class="body">
    51. 

  51.             
    52. 

  52.   <div class="section" id="track-track-methods">
    53. 

  53. <h1>Track &#8211; track methods<a class="headerlink" href="#track-track-methods" title="Permalink to this headline">ś</a></h1>
    54. 

  54. <dl class="class">
    55. 

  55. <dt id="pyechonest.track.Track">
    56. 

  56. <em class="property">class </em><tt class="descclassname">pyechonest.track.</tt><tt class="descname">Track</tt><big>(</big><em>identifier</em>, <em>md5</em>, <em>properties</em><big>)</big><a class="headerlink" href="#pyechonest.track.Track" title="Permalink to this definition">ś</a></dt>
    57. 

  57. <dd><p>Represents an audio analysis from The Echo Nest.</p>
    58. 

  58. <p>All methods in this module return Track objects.</p>
    59. 

  59. <p>Attributes:</p>
    60. 

  60. <blockquote>
    61. 

  61. <p>analysis_channels       int: the number of audio channels used during analysis</p>
    62. 

  62. <p>analysis_sample_rate    float: the sample rate used during analysis</p>
    63. 

  63. <p>analyzer_version        str: e.g. &#8216;3.01a&#8217;</p>
    64. 

  64. <p>artist                  str or None: artist name</p>
    65. 

  65. <p>bars                    list of dicts: timing of each measure</p>
    66. 

  66. <p>beats                   list of dicts: timing of each beat</p>
    67. 

  67. <p>bitrate                 int: the bitrate of the input mp3 (or other file)</p>
    68. 

  68. <p>danceability            float: relative danceability (0 to 1)</p>
    69. 

  69. <p>duration                float: length of track in seconds</p>
    70. 

  70. <p>energy                  float: relative energy (0 to 1)</p>
    71. 

  71. <p>end_of_fade_in          float: time in seconds track where fade-in ends</p>
    72. 

  72. <p>id                      str: Echo Nest Track ID, e.g. &#8216;TRTOBXJ1296BCDA33B&#8217;</p>
    73. 

  73. <p>key                     int: between 0 (key of C) and 11 (key of B flat) inclusive</p>
    74. 

  74. <p>key_confidence          float: confidence that key detection was accurate</p>
    75. 

  75. <p>loudness                float: overall loudness in decibels (dB)</p>
    76. 

  76. <p>md5                     str: 32-character checksum of the input mp3</p>
    77. 

  77. <p>meta                    dict: other track metainfo</p>
    78. 

  78. <p>mode                    int: 0 (major) or 1 (minor)</p>
    79. 

  79. <p>mode_confidence         float: confidence that mode detection was accurate</p>
    80. 

  80. <p>num_samples             int: total samples in the decoded track</p>
    81. 

  81. <p>release                 str or None: the album name</p>
    82. 

  82. <p>sample_md5              str: 32-character checksum of the decoded audio file</p>
    83. 

  83. <p>samplerate              int: sample rate of input mp3</p>
    84. 

  84. <p>sections                list of dicts: larger sections of song (chorus, bridge, solo, etc.)</p>
    85. 

  85. <p>segments                list of dicts: timing, pitch, loudness and timbre for each segment</p>
    86. 

  86. <p>start_of_fade_out       float: time in seconds where fade out begins</p>
    87. 

  87. <p>status                  str: analysis status, e.g. &#8216;complete&#8217;, &#8216;pending&#8217;, &#8216;error&#8217;</p>
    88. 

  88. <p>tatums                  list of dicts: the smallest metrical unit (subdivision of a beat)</p>
    89. 

  89. <p>tempo                   float: overall BPM (beats per minute)</p>
    90. 

  90. <p>tempo_confidence        float: confidence that tempo detection was accurate</p>
    91. 

  91. <p>title                   str or None: song title</p>
    92. 

  92. </blockquote>
    93. 

  93. <p>Each bar, beat, section, segment and tatum has a start time, a duration, and a confidence,
    94. 

  94. in addition to whatever other data is given.</p>
    95. 

  95. <p>Examples:</p>
    96. 

  96. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_id</span><span class="p">(</span><span class="s">&#39;TRXXHTJ1294CD8F3B3&#39;</span><span class="p">)</span>
    97. 

  97. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    98. 

  98. <span class="go">&lt;track - Neverwas Restored (from Neverwas Soundtrack)&gt;</span>
    99. 

  99. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_md5</span><span class="p">(</span><span class="s">&#39;b8abf85746ab3416adabca63141d8c2d&#39;</span><span class="p">)</span>
    100. 

  100. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    101. 

  101. <span class="go">&lt;track - Neverwas Restored (from Neverwas Soundtrack)&gt;</span>
    102. 

  102. <span class="gp">&gt;&gt;&gt; </span>
    103. 

  103. </pre></div>
    104. 

  104. </div>
    105. 

  105. <dl class="method">
    106. 

  106. <dt id="pyechonest.track.Track.__repr__">
    107. 

  107. <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.track.Track.__repr__" title="Permalink to this definition">ś</a></dt>
    108. 

  108. <dd></dd></dl>
    109. 

  109. 

  110. <dl class="method">
    111. 

  111. <dt id="pyechonest.track.Track.__str__">
    112. 

  112. <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.track.Track.__str__" title="Permalink to this definition">ś</a></dt>
    113. 

  113. <dd></dd></dl>
    114. 

  114. 

  115. </dd></dl>
    116. 

  116. 

  117. <dl class="staticmethod">
    118. 

  118. <dt id="pyechonest.track.track_from_file">
    119. 

  119. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_file</tt><big>(</big><em>file_object</em>, <em>filetype</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_file" title="Permalink to this definition">ś</a></dt>
    120. 

  120. <dd><p>Create a track object from a file-like object.</p>
    121. 

  121. <dl class="docutils">
    122. 

  122. <dt>Args:</dt>
    123. 

  123. <dd>file_object: a file-like Python object
    124. 

  124. filetype: the file type (ex. mp3, ogg, wav)</dd>
    125. 

  125. <dt>Example:</dt>
    126. 

  126. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;Miaow-01-Tempered-song.mp3&quot;</span><span class="p">)</span>
    127. 

  127. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_file</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="s">&#39;mp3&#39;</span><span class="p">)</span>
    128. 

  128. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    129. 

  129. <span class="go">&lt; Track &gt;</span>
    130. 

  130. <span class="go">&gt;&gt;&gt;</span>
    131. 

  131. </pre></div>
    132. 

  132. </div>
    133. 

  133. </dd>
    134. 

  134. </dl>
    135. 

  135. </dd></dl>
    136. 

  136. 

  137. <dl class="staticmethod">
    138. 

  138. <dt id="pyechonest.track.track_from_filename">
    139. 

  139. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_filename</tt><big>(</big><em>filename</em>, <em>filetype=None</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_filename" title="Permalink to this definition">ś</a></dt>
    140. 

  140. <dd><p>Create a track object from a filename.</p>
    141. 

  141. <dl class="docutils">
    142. 

  142. <dt>Args:</dt>
    143. 

  143. <dd>filename: A string containing the path to the input file.
    144. 

  144. filetype: A string indicating the filetype; Defaults to None (type determined by file extension).</dd>
    145. 

  145. <dt>Example:</dt>
    146. 

  146. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_filename</span><span class="p">(</span><span class="s">&quot;Miaow-01-Tempered-song.mp3&quot;</span><span class="p">)</span>
    147. 

  147. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    148. 

  148. <span class="go">&lt; Track &gt;</span>
    149. 

  149. <span class="go">&gt;&gt;&gt;</span>
    150. 

  150. </pre></div>
    151. 

  151. </div>
    152. 

  152. </dd>
    153. 

  153. </dl>
    154. 

  154. </dd></dl>
    155. 

  155. 

  156. <dl class="staticmethod">
    157. 

  157. <dt id="pyechonest.track.track_from_url">
    158. 

  158. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_url</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_url" title="Permalink to this definition">ś</a></dt>
    159. 

  159. <dd><p>Create a track object from a public http URL.</p>
    160. 

  160. <dl class="docutils">
    161. 

  161. <dt>Args:</dt>
    162. 

  162. <dd>url: A string giving the URL to read from. This must be on a public machine accessible by HTTP.</dd>
    163. 

  163. <dt>Example:</dt>
    164. 

  164. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_url</span><span class="p">(</span><span class="s">&quot;http://www.miaowmusic.com/mp3/Miaow-01-Tempered-song.mp3&quot;</span><span class="p">)</span>
    165. 

  165. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    166. 

  166. <span class="go">&lt; Track &gt;</span>
    167. 

  167. <span class="go">&gt;&gt;&gt;</span>
    168. 

  168. </pre></div>
    169. 

  169. </div>
    170. 

  170. </dd>
    171. 

  171. </dl>
    172. 

  172. </dd></dl>
    173. 

  173. 

  174. <dl class="staticmethod">
    175. 

  175. <dt id="pyechonest.track.track_from_id">
    176. 

  176. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_id</tt><big>(</big><em>identifier</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_id" title="Permalink to this definition">ś</a></dt>
    177. 

  177. <dd><p>Create a track object from an Echo Nest track ID.</p>
    178. 

  178. <dl class="docutils">
    179. 

  179. <dt>Args:</dt>
    180. 

  180. <dd>identifier: A string containing the ID of a previously analyzed track.</dd>
    181. 

  181. <dt>Example:</dt>
    182. 

  182. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_id</span><span class="p">(</span><span class="s">&quot;TRWFIDS128F92CC4CA&quot;</span><span class="p">)</span>
    183. 

  183. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    184. 

  184. <span class="go">&lt;track - Let The Spirit&gt;</span>
    185. 

  185. <span class="go">&gt;&gt;&gt;</span>
    186. 

  186. </pre></div>
    187. 

  187. </div>
    188. 

  188. </dd>
    189. 

  189. </dl>
    190. 

  190. </dd></dl>
    191. 

  191. 

  192. <dl class="staticmethod">
    193. 

  193. <dt id="pyechonest.track.track_from_md5">
    194. 

  194. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_md5</tt><big>(</big><em>md5</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_md5" title="Permalink to this definition">ś</a></dt>
    195. 

  195. <dd><p>Create a track object from an md5 hash.</p>
    196. 

  196. <dl class="docutils">
    197. 

  197. <dt>Args:</dt>
    198. 

  198. <dd>md5: A string 32 characters long giving the md5 checksum of a track already analyzed.</dd>
    199. 

  199. <dt>Example:</dt>
    200. 

  200. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_md5</span><span class="p">(</span><span class="s">&#39;b8abf85746ab3416adabca63141d8c2d&#39;</span><span class="p">)</span>
    201. 

  201. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    202. 

  202. <span class="go">&lt;track - Neverwas Restored (from Neverwas Soundtrack)&gt;</span>
    203. 

  203. <span class="go">&gt;&gt;&gt;</span>
    204. 

  204. </pre></div>
    205. 

  205. </div>
    206. 

  206. </dd>
    207. 

  207. </dl>
    208. 

  208. </dd></dl>
    209. 

  209. 

  210. <dl class="staticmethod">
    211. 

  211. <dt id="pyechonest.track.track_from_reanalyzing_md5">
    212. 

  212. <em class="property">static </em><tt class="descclassname">track.</tt><tt class="descname">track_from_reanalyzing_md5</tt><big>(</big><em>md5</em><big>)</big><a class="headerlink" href="#pyechonest.track.track_from_reanalyzing_md5" title="Permalink to this definition">ś</a></dt>
    213. 

  213. <dd><p>Create a track object from an md5 hash, reanalyzing the track first.</p>
    214. 

  214. <dl class="docutils">
    215. 

  215. <dt>Args:</dt>
    216. 

  216. <dd>md5 (str): A string containing the md5 of a previously analyzed track</dd>
    217. 

  217. <dt>Example:</dt>
    218. 

  218. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">track</span><span class="o">.</span><span class="n">track_from_reanalyzing_md5</span><span class="p">(</span><span class="s">&#39;b8abf85746ab3416adabca63141d8c2d&#39;</span><span class="p">)</span>
    219. 

  219. <span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
    220. 

  220. <span class="go">&lt;track - Neverwas Restored&gt;</span>
    221. 

  221. <span class="go">&gt;&gt;&gt;</span>
    222. 

  222. </pre></div>
    223. 

  223. </div>
    224. 

  224. </dd>
    225. 

  225. </dl>
    226. 

  226. </dd></dl>
    227. 

  227. 

  228. </div>
    229. 

  229. 

  230. 

  231.           </div>
    232. 

  232.         </div>
    233. 

  233.       </div>
    234. 

  234.       <div class="sphinxsidebar">
    235. 

  235.         <div class="sphinxsidebarwrapper">
    236. 

  236.   <h4>Previous topic</h4>
    237. 

  237.   <p class="topless"><a href="song.html"
    238. 

  238.                         title="previous chapter">Song &#8211; song methods</a></p>
    239. 

  239.   <h4>Next topic</h4>
    240. 

  240.   <p class="topless"><a href="playlist.html"
    241. 

  241.                         title="next chapter">Playlist &#8211; playlist methods</a></p>
    242. 

  242.   <h3>This Page</h3>
    243. 

  243.   <ul class="this-page-menu">
    244. 

  244.     <li><a href="_sources/track.txt"
    245. 

  245.            rel="nofollow">Show Source</a></li>
    246. 

  246.   </ul>
    247. 

  247. <div id="searchbox" style="display: none">
    248. 

  248.   <h3>Quick search</h3>
    249. 

  249.     <form class="search" action="search.html" method="get">
    250. 

  250.       <input type="text" name="q" size="18" />
    251. 

  251.       <input type="submit" value="Go" />
    252. 

  252.       <input type="hidden" name="check_keywords" value="yes" />
    253. 

  253.       <input type="hidden" name="area" value="default" />
    254. 

  254.     </form>
    255. 

  255.     <p class="searchtip" style="font-size: 90%">
    256. 

  256.     Enter search terms or a module, class or function name.
    257. 

  257.     </p>
    258. 

  258. </div>
    259. 

  259. <script type="text/javascript">$('#searchbox').show(0);</script>
    260. 

  260.         </div>
    261. 

  261.       </div>
    262. 

  262.       <div class="clearer"></div>
    263. 

  263.     </div>
    264. 

  264.     <div class="related">
    265. 

  265.       <h3>Navigation</h3>
    266. 

  266.       <ul>
    267. 

  267.         <li class="right" style="margin-right: 10px">
    268. 

  268.           <a href="genindex.html" title="General Index"
    269. 

  269.              >index</a></li>
    270. 

  270.         <li class="right" >
    271. 

  271.           <a href="py-modindex.html" title="Python Module Index"
    272. 

  272.              >modules</a> |</li>
    273. 

  273.         <li class="right" >
    274. 

  274.           <a href="playlist.html" title="Playlist – playlist methods"
    275. 

  275.              >next</a> |</li>
    276. 

  276.         <li class="right" >
    277. 

  277.           <a href="song.html" title="Song – song methods"
    278. 

  278.              >previous</a> |</li>
    279. 

  279.         <li><a href="index.html">pyechonest v4 documentation</a> &raquo;</li> 
    280. 

  280.       </ul>
    281. 

  281.     </div>
    282. 

  282.     <div class="footer">
    283. 

  283.         &copy; Copyright 2010, The Echo Nest.
    284. 

  284.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
    285. 

  285.     </div>
    286. 

  286.   </body>
    287. 

  287. </html>
    288.