/src/pyechonest/doc/build/html/song.html

http://echo-nest-remix.googlecode.com/ · HTML · 478 lines · 456 code · 22 blank · 0 comment · 0 complexity · e7b07fa2fc3c30e74a9db4aad4f7a6d0 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>Song – song 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="Track – track methods" href="track.html" />
    25. 

  25.     <link rel="prev" title="Artist – artist methods" href="artist.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="track.html" title="Track – track methods"
    39. 

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

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

  41.           <a href="artist.html" title="Artist – artist 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="song-song-methods">
    53. 

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

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

  55. <dt id="pyechonest.song.Song">
    56. 

  56. <em class="property">class </em><tt class="descclassname">pyechonest.song.</tt><tt class="descname">Song</tt><big>(</big><em>id</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song" title="Permalink to this definition">ś</a></dt>
    57. 

  57. <dd><p>A Song object</p>
    58. 

  58. <dl class="docutils">
    59. 

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

  60. <dd><p class="first">id (str): Echo Nest Song ID</p>
    61. 

  61. <p>title (str): Song Title</p>
    62. 

  62. <p>artist_name (str): Artist Name</p>
    63. 

  63. <p>artist_id (str): Artist ID</p>
    64. 

  64. <p>audio_summary (dict): An Audio Summary dict</p>
    65. 

  65. <p>song_hotttnesss (float): A float representing a song&#8217;s hotttnesss</p>
    66. 

  66. <p>artist_hotttnesss (float): A float representing a song&#8217;s parent artist&#8217;s hotttnesss</p>
    67. 

  67. <p>artist_familiarity (float): A float representing a song&#8217;s parent artist&#8217;s familiarity</p>
    68. 

  68. <p class="last">artist_location (dict): A dictionary of strings specifying a song&#8217;s parent artist&#8217;s location, lattitude and longitude</p>
    69. 

  69. </dd>
    70. 

  70. </dl>
    71. 

  71. <p>Create a song object like so:</p>
    72. 

  72. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOPEXHZ12873FD2AC7&#39;</span><span class="p">)</span>
    73. 

  73. </pre></div>
    74. 

  74. </div>
    75. 

  75. <dl class="method">
    76. 

  76. <dt id="pyechonest.song.Song.__init__">
    77. 

  77. <tt class="descname">__init__</tt><big>(</big><em>id</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.__init__" title="Permalink to this definition">ś</a></dt>
    78. 

  78. <dd><p>Song class</p>
    79. 

  79. <dl class="docutils">
    80. 

  80. <dt>Args:</dt>
    81. 

  81. <dd>id (str): a song ID</dd>
    82. 

  82. <dt>Kwargs:</dt>
    83. 

  83. <dd>buckets (list): A list of strings specifying which buckets to retrieve</dd>
    84. 

  84. <dt>Returns:</dt>
    85. 

  85. <dd>A Song object</dd>
    86. 

  86. </dl>
    87. 

  87. <p>Example:</p>
    88. 

  88. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOPEXHZ12873FD2AC7&#39;</span><span class="p">,</span> <span class="n">buckets</span><span class="o">=</span><span class="p">[</span><span class="s">&#39;song_hotttnesss&#39;</span><span class="p">,</span> <span class="s">&#39;artist_hotttnesss&#39;</span><span class="p">])</span>
    89. 

  89. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">song_hotttnesss</span>
    90. 

  90. <span class="go">0.58602500000000002</span>
    91. 

  91. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">artist_hotttnesss</span>
    92. 

  92. <span class="go">0.80329715999999995</span>
    93. 

  93. <span class="gp">&gt;&gt;&gt; </span>
    94. 

  94. </pre></div>
    95. 

  95. </div>
    96. 

  96. </dd></dl>
    97. 

  97. 

  98. <dl class="method">
    99. 

  99. <dt id="pyechonest.song.Song.__repr__">
    100. 

  100. <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.song.Song.__repr__" title="Permalink to this definition">ś</a></dt>
    101. 

  101. <dd></dd></dl>
    102. 

  102. 

  103. <dl class="method">
    104. 

  104. <dt id="pyechonest.song.Song.__str__">
    105. 

  105. <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.song.Song.__str__" title="Permalink to this definition">ś</a></dt>
    106. 

  106. <dd></dd></dl>
    107. 

  107. 

  108. <dl class="method">
    109. 

  109. <dt id="pyechonest.song.Song.get_artist_familiarity">
    110. 

  110. <tt class="descname">get_artist_familiarity</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_artist_familiarity" title="Permalink to this definition">ś</a></dt>
    111. 

  111. <dd><p>Get our numerical estimation of how familiar a song&#8217;s artist currently is to the world</p>
    112. 

  112. <dl class="docutils">
    113. 

  113. <dt>Args:</dt>
    114. 

  114. <dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
    115. 

  115. <dt>Returns:</dt>
    116. 

  116. <dd>A float representing familiarity.</dd>
    117. 

  117. <dt>Example:</dt>
    118. 

  118. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOQKVPH12A58A7AF4D&#39;</span><span class="p">)</span>
    119. 

  119. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">get_artist_familiarity</span><span class="p">()</span>
    120. 

  120. <span class="go">0.639626025843539</span>
    121. 

  121. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">artist_familiarity</span>
    122. 

  122. <span class="go">0.639626025843539</span>
    123. 

  123. <span class="gp">&gt;&gt;&gt; </span>
    124. 

  124. </pre></div>
    125. 

  125. </div>
    126. 

  126. </dd>
    127. 

  127. </dl>
    128. 

  128. </dd></dl>
    129. 

  129. 

  130. <dl class="method">
    131. 

  131. <dt id="pyechonest.song.Song.get_artist_hotttnesss">
    132. 

  132. <tt class="descname">get_artist_hotttnesss</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_artist_hotttnesss" title="Permalink to this definition">ś</a></dt>
    133. 

  133. <dd><p>Get our numerical description of how hottt a song&#8217;s artist currently is</p>
    134. 

  134. <p>Args:</p>
    135. 

  135. <dl class="docutils">
    136. 

  136. <dt>Kwargs:</dt>
    137. 

  137. <dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
    138. 

  138. <dt>Returns:</dt>
    139. 

  139. <dd>A float representing hotttnesss.</dd>
    140. 

  140. <dt>Example:</dt>
    141. 

  141. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOOLGAZ127F3E1B87C&#39;</span><span class="p">)</span>
    142. 

  142. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">artist_hotttnesss</span>
    143. 

  143. <span class="go">0.45645633000000002</span>
    144. 

  144. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">get_artist_hotttnesss</span><span class="p">()</span>
    145. 

  145. <span class="go">0.45645633000000002</span>
    146. 

  146. <span class="gp">&gt;&gt;&gt; </span>
    147. 

  147. </pre></div>
    148. 

  148. </div>
    149. 

  149. </dd>
    150. 

  150. </dl>
    151. 

  151. </dd></dl>
    152. 

  152. 

  153. <dl class="method">
    154. 

  154. <dt id="pyechonest.song.Song.get_artist_location">
    155. 

  155. <tt class="descname">get_artist_location</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_artist_location" title="Permalink to this definition">ś</a></dt>
    156. 

  156. <dd><p>Get the location of a song&#8217;s artist.</p>
    157. 

  157. <dl class="docutils">
    158. 

  158. <dt>Args:</dt>
    159. 

  159. <dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
    160. 

  160. <dt>Returns:</dt>
    161. 

  161. <dd>An artist location object.</dd>
    162. 

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

  163. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOQKVPH12A58A7AF4D&#39;</span><span class="p">)</span>
    164. 

  164. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">artist_location</span>
    165. 

  165. <span class="go">{u&#39;latitude&#39;: 34.053489999999996, u&#39;location&#39;: u&#39;Los Angeles, CA&#39;, u&#39;longitude&#39;: -118.24532000000001}</span>
    166. 

  166. <span class="gp">&gt;&gt;&gt; </span>
    167. 

  167. </pre></div>
    168. 

  168. </div>
    169. 

  169. </dd>
    170. 

  170. </dl>
    171. 

  171. </dd></dl>
    172. 

  172. 

  173. <dl class="method">
    174. 

  174. <dt id="pyechonest.song.Song.get_audio_summary">
    175. 

  175. <tt class="descname">get_audio_summary</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_audio_summary" title="Permalink to this definition">ś</a></dt>
    176. 

  176. <dd><p>Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, danceability, energy, and analysis_url.</p>
    177. 

  177. <p>Args:</p>
    178. 

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

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

  180. <dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
    181. 

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

  182. <dd>A dictionary containing mode, tempo, key, duration, time signature, loudness, danceability, energy and analysis_url keys.</dd>
    183. 

  183. <dt>Example:</dt>
    184. 

  184. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOGNMKX12B0B806320&#39;</span><span class="p">)</span>
    185. 

  185. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">audio_summary</span>
    186. 

  186. <span class="go">{u&#39;analysis_url&#39;: u&#39;https://echonest-analysis.s3.amazonaws.com:443/TR/TRCPUOG123E85891F2/3/full.json?Signature=wcML1ZKsl%2F2FU4k68euHJcF7Jbc%3D&amp;Expires=1287518562&amp;AWSAccessKeyId=AKIAIAFEHLM3KJ2XMHRA&#39;,</span>
    187. 

  187. <span class="go"> u&#39;danceability&#39;: 0.20964757782725996,</span>
    188. 

  188. <span class="go"> u&#39;duration&#39;: 472.63301999999999,</span>
    189. 

  189. <span class="go"> u&#39;energy&#39;: 0.64265230549809549,</span>
    190. 

  190. <span class="go"> u&#39;key&#39;: 0,</span>
    191. 

  191. <span class="go"> u&#39;loudness&#39;: -9.6820000000000004,</span>
    192. 

  192. <span class="go"> u&#39;mode&#39;: 1,</span>
    193. 

  193. <span class="go"> u&#39;tempo&#39;: 126.99299999999999,</span>
    194. 

  194. <span class="go"> u&#39;time_signature&#39;: 4}</span>
    195. 

  195. <span class="gp">&gt;&gt;&gt; </span>
    196. 

  196. </pre></div>
    197. 

  197. </div>
    198. 

  198. </dd>
    199. 

  199. </dl>
    200. 

  200. </dd></dl>
    201. 

  201. 

  202. <dl class="method">
    203. 

  203. <dt id="pyechonest.song.Song.get_foreign_id">
    204. 

  204. <tt class="descname">get_foreign_id</tt><big>(</big><em>idspace=''</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_foreign_id" title="Permalink to this definition">ś</a></dt>
    205. 

  205. <dd><p>Get the foreign id for this song for a specific id space</p>
    206. 

  206. <p>Args:</p>
    207. 

  207. <dl class="docutils">
    208. 

  208. <dt>Kwargs:</dt>
    209. 

  209. <dd>idspace (str): A string indicating the idspace to fetch a foreign id for.</dd>
    210. 

  210. <dt>Returns:</dt>
    211. 

  211. <dd>A foreign ID string</dd>
    212. 

  212. </dl>
    213. 

  213. <p>Example:</p>
    214. 

  214. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOYRVMR12AF729F8DC&#39;</span><span class="p">)</span>
    215. 

  215. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">get_foreign_id</span><span class="p">(</span><span class="s">&#39;CAGPXKK12BB06F9DE9&#39;</span><span class="p">)</span>
    216. 

  216. </pre></div>
    217. 

  217. </div>
    218. 

  218. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span>
    219. 

  219. </pre></div>
    220. 

  220. </div>
    221. 

  221. </dd></dl>
    222. 

  222. 

  223. <dl class="method">
    224. 

  224. <dt id="pyechonest.song.Song.get_song_hotttnesss">
    225. 

  225. <tt class="descname">get_song_hotttnesss</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_song_hotttnesss" title="Permalink to this definition">ś</a></dt>
    226. 

  226. <dd><p>Get our numerical description of how hottt a song currently is</p>
    227. 

  227. <p>Args:</p>
    228. 

  228. <dl class="docutils">
    229. 

  229. <dt>Kwargs:</dt>
    230. 

  230. <dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
    231. 

  231. <dt>Returns:</dt>
    232. 

  232. <dd>A float representing hotttnesss.</dd>
    233. 

  233. <dt>Example:</dt>
    234. 

  234. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOLUHKP129F0698D49&#39;</span><span class="p">)</span>
    235. 

  235. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">get_song_hotttnesss</span><span class="p">()</span>
    236. 

  236. <span class="go">0.57344379999999995</span>
    237. 

  237. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">song_hotttnesss</span>
    238. 

  238. <span class="go">0.57344379999999995</span>
    239. 

  239. <span class="gp">&gt;&gt;&gt; </span>
    240. 

  240. </pre></div>
    241. 

  241. </div>
    242. 

  242. </dd>
    243. 

  243. </dl>
    244. 

  244. </dd></dl>
    245. 

  245. 

  246. <dl class="method">
    247. 

  247. <dt id="pyechonest.song.Song.get_tracks">
    248. 

  248. <tt class="descname">get_tracks</tt><big>(</big><em>catalog</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.song.Song.get_tracks" title="Permalink to this definition">ś</a></dt>
    249. 

  249. <dd><p>Get the tracks for a song given a catalog.</p>
    250. 

  250. <dl class="docutils">
    251. 

  251. <dt>Args:</dt>
    252. 

  252. <dd>catalog (str): a string representing the catalog whose track you want to retrieve.</dd>
    253. 

  253. <dt>Returns:</dt>
    254. 

  254. <dd>A list of Track dicts.</dd>
    255. 

  255. <dt>Example:</dt>
    256. 

  256. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">Song</span><span class="p">(</span><span class="s">&#39;SOWDASQ12A6310F24F&#39;</span><span class="p">)</span>
    257. 

  257. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">get_tracks</span><span class="p">(</span><span class="s">&#39;7digital&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
    258. 

  258. <span class="go">{u&#39;catalog&#39;: u&#39;7digital&#39;,</span>
    259. 

  259. <span class="go"> u&#39;foreign_id&#39;: u&#39;7digital:track:8445818&#39;,</span>
    260. 

  260. <span class="go"> u&#39;id&#39;: u&#39;TRJGNNY12903CC625C&#39;,</span>
    261. 

  261. <span class="go"> u&#39;preview_url&#39;: u&#39;http://previews.7digital.com/clips/34/8445818.clip.mp3&#39;,</span>
    262. 

  262. <span class="go"> u&#39;release_image&#39;: u&#39;http://cdn.7static.com/static/img/sleeveart/00/007/628/0000762838_200.jpg&#39;}</span>
    263. 

  263. <span class="gp">&gt;&gt;&gt; </span>
    264. 

  264. </pre></div>
    265. 

  265. </div>
    266. 

  266. </dd>
    267. 

  267. </dl>
    268. 

  268. </dd></dl>
    269. 

  269. 

  270. </dd></dl>
    271. 

  271. 

  272. <dl class="staticmethod">
    273. 

  273. <dt id="pyechonest.song.identify">
    274. 

  274. <em class="property">static </em><tt class="descclassname">song.</tt><tt class="descname">identify</tt><big>(</big><em>filename=None</em>, <em>query_obj=None</em>, <em>code=None</em>, <em>artist=None</em>, <em>title=None</em>, <em>release=None</em>, <em>duration=None</em>, <em>genre=None</em>, <em>buckets=None</em>, <em>codegen_start=0</em>, <em>codegen_duration=30</em><big>)</big><a class="headerlink" href="#pyechonest.song.identify" title="Permalink to this definition">ś</a></dt>
    275. 

  275. <dd><p>Identify a song.</p>
    276. 

  276. <p>Args:</p>
    277. 

  277. <dl class="docutils">
    278. 

  278. <dt>Kwargs:</dt>
    279. 

  279. <dd><p class="first">filename (str): The path of the file you want to analyze (requires codegen binary!)</p>
    280. 

  280. <p>query_obj (dict or list): A dict or list of dicts containing a &#8216;code&#8217; element with an fp code</p>
    281. 

  281. <p>code (str): A fingerprinter code</p>
    282. 

  282. <p>artist (str): An artist name</p>
    283. 

  283. <p>title (str): A song title</p>
    284. 

  284. <p>release (str): A release name</p>
    285. 

  285. <p>duration (int): A song duration</p>
    286. 

  286. <p>genre (str): A string representing the genre</p>
    287. 

  287. <p>buckets (list): A list of strings specifying which buckets to retrieve</p>
    288. 

  288. <p>codegen_start (int): The point (in seconds) where the codegen should start</p>
    289. 

  289. <p class="last">codegen_duration (int): The duration (in seconds) the codegen should analyze</p>
    290. 

  290. </dd>
    291. 

  291. <dt>Example:</dt>
    292. 

  292. <dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">qo</span>
    293. 

  293. <span class="go">{&#39;code&#39;: &#39;eJxlldehHSEMRFsChAjlAIL-S_CZvfaXXxAglEaBTen300Qu__lAyoJYhVQdXTvXrmvXdTsKZOqoU1q63QNydBGfOd1cGX3scpb1jEiWRLaPcJureC6RVkXE69jL8pGHjpP48pLI1m7r9oiEyBXvoVv45Q-5IhylYLkIRxGO4rp18ZpEOmpFPopwfJjL0u3WceO3HB1DIvJRnkQeO1PCLIsIjBWEzYaShq4pV9Z0KzDiQ8SbSNuSyBZPOOxIJKR7dauEmXwotxDCqllEAVZlrX6F8Y-IJ0e169i_HQaqslaVtTq1W-1vKeupImzrxWWVI5cPlw-XDxckN-3kyeXDm3jKmqv6PtB1gfH1Eey5qu8qvAuMC4zLfPv1l3aqviylJhytFhF0mzqs6aYpYU04mlqgKWtNjppwNKWubR2FowlHUws0gWmPi668dSHq6rOuPuhqgRcVKKM8s-fZS937nBe23iz3Uctx9607z-kLph1i8YZ8f_TfzLXseBh7nXy9nn1YBAg4Nwjp4AzTL23M_U3Rh0-sdDFtyspNOb1bYeZZqz2Y6TaHmXeuNmfFdTueLuvdsbOU9luvtIkl4vI5F_92PVprM1-sdJ_o9_Guc0b_WimpD_Rt1DFg0sY3wyw08e6jlqhjH3o76naYvzWqhX9rOv15Y7Ww_MIF8dXzw30s_uHO5PPDfUonnzq_NJ8J93mngAkIz5jA29SqxGwwvxQsih-sozX0zVk__RFaf_qyG9hb8dktZZXd4a8-1ljB-c5bllXOe1HqHplzeiN4E7q9ZRdmJuI73gBEJ_HcAxUm74PAVDNL47D6OAfzTHI0mHpXAmY60QNmlqjDfIPzwUDYhVnoXqtvZGrBdMi3ClQUQ8D8rX_1JE_In94CBXER4lrrw0H867ei8x-OVz8c-Osh5plzTOySpKIROmFkbn5xVuK784vTyPpS3OlcSjHpL16saZnm4Bk66hte9sd80Dcj02f7xDVrExjk32cssKXjmflU_SxXmn4Y9Ttued10YM552h5Wtt_WeVR4U6LPWfbIdW31J4JOXnpn4qhH7yE_pdBH9E_sMwbNFr0z0IW5NA8aOZhLmOh3zSVNRZwxiZc5pb8fikGzIf-ampJnCSb3r-ZPfjPuvLm7CY_Vfa_k7SCzdwHNg5mICTSHDxyBWmaOSyLQpPmCSXyF-eL7MHo7zNd668JMb_N-AJJRuMwrX0jNx7a8-Rj5oN6nyWoL-jRv4pu7Ue821TzU3MhvpD9Fo-XI&#39;,</span>
    294. 

  294. <span class="go"> &#39;code_count&#39;: 151,</span>
    295. 

  295. <span class="go"> &#39;low_rank&#39;: 0,</span>
    296. 

  296. <span class="go"> &#39;metadata&#39;: {&#39;artist&#39;: &#39;Harmonic 313&#39;,</span>
    297. 

  297. <span class="go">              &#39;bitrate&#39;: 198,</span>
    298. 

  298. <span class="go">              &#39;codegen_time&#39;: 0.57198400000000005,</span>
    299. 

  299. <span class="go">              &#39;decode_time&#39;: 0.37954599999999999,</span>
    300. 

  300. <span class="go">              &#39;duration&#39;: 226,</span>
    301. 

  301. <span class="go">              &#39;filename&#39;: &#39;koln.mp3&#39;,</span>
    302. 

  302. <span class="go">              &#39;genre&#39;: &#39;Electronic&#39;,</span>
    303. 

  303. <span class="go">              &#39;given_duration&#39;: 30,</span>
    304. 

  304. <span class="go">              &#39;release&#39;: &#39;When Machines Exceed Human Intelligence&#39;,</span>
    305. 

  305. <span class="go">              &#39;sample_rate&#39;: 44100,</span>
    306. 

  306. <span class="go">              &#39;samples_decoded&#39;: 661816,</span>
    307. 

  307. <span class="go">              &#39;start_offset&#39;: 0,</span>
    308. 

  308. <span class="go">              &#39;title&#39;: &#39;kln&#39;,</span>
    309. 

  309. <span class="go">              &#39;version&#39;: 3.1499999999999999},</span>
    310. 

  310. <span class="go"> &#39;tag&#39;: 0}</span>
    311. 

  311. <span class="gp">&gt;&gt;&gt; </span><span class="n">song</span><span class="o">.</span><span class="n">identify</span><span class="p">(</span><span class="n">query_obj</span><span class="o">=</span><span class="n">qo</span><span class="p">)</span>
    312. 

  312. <span class="go">[&lt;song - Köln&gt;]</span>
    313. 

  313. <span class="gp">&gt;&gt;&gt; </span>
    314. 

  314. </pre></div>
    315. 

  315. </div>
    316. 

  316. </dd>
    317. 

  317. </dl>
    318. 

  318. </dd></dl>
    319. 

  319. 

  320. <dl class="staticmethod">
    321. 

  321. <dt id="pyechonest.song.search">
    322. 

  322. <em class="property">static </em><tt class="descclassname">song.</tt><tt class="descname">search</tt><big>(</big><em>title=None</em>, <em>artist=None</em>, <em>artist_id=None</em>, <em>combined=None</em>, <em>description=None</em>, <em>style=None</em>, <em>mood=None</em>, <em>results=None</em>, <em>start=None</em>, <em>max_tempo=None</em>, <em>min_tempo=None</em>, <em>max_duration=None</em>, <em>min_duration=None</em>, <em>max_loudness=None</em>, <em>min_loudness=None</em>, <em>artist_max_familiarity=None</em>, <em>artist_min_familiarity=None</em>, <em>artist_max_hotttnesss=None</em>, <em>artist_min_hotttnesss=None</em>, <em>song_max_hotttnesss=None</em>, <em>song_min_hotttnesss=None</em>, <em>mode=None</em>, <em>min_energy=None</em>, <em>max_energy=None</em>, <em>min_danceability=None</em>, <em>max_danceability=None</em>, <em>key=None</em>, <em>max_latitude=None</em>, <em>min_latitude=None</em>, <em>max_longitude=None</em>, <em>min_longitude=None</em>, <em>sort=None</em>, <em>buckets=None</em>, <em>limit=False</em>, <em>test_new_things=None</em>, <em>rank_type=None</em><big>)</big><a class="headerlink" href="#pyechonest.song.search" title="Permalink to this definition">ś</a></dt>
    323. 

  323. <dd><p>Search for songs by name, description, or constraint.</p>
    324. 

  324. <p>Args:</p>
    325. 

  325. <dl class="docutils">
    326. 

  326. <dt>Kwargs:</dt>
    327. 

  327. <dd><p class="first">title (str): the name of a song</p>
    328. 

  328. <p>artist (str): the name of an artist</p>
    329. 

  329. <p>artist_id (str): the artist_id</p>
    330. 

  330. <p>combined (str): the artist name and song title</p>
    331. 

  331. <p>description (str): A string describing the artist and song</p>
    332. 

  332. <p>style (str): A string describing the style/genre of the artist and song</p>
    333. 

  333. <p>mood (str): A string describing the mood of the artist and song</p>
    334. 

  334. <p>results (int): An integer number of results to return</p>
    335. 

  335. <p>max_tempo (float): The max tempo of song results</p>
    336. 

  336. <p>min_tempo (float): The min tempo of song results</p>
    337. 

  337. <p>max_duration (float): The max duration of song results</p>
    338. 

  338. <p>min_duration (float): The min duration of song results</p>
    339. 

  339. <p>max_loudness (float): The max loudness of song results</p>
    340. 

  340. <p>min_loudness (float): The min loudness of song results</p>
    341. 

  341. <p>artist_max_familiarity (float): A float specifying the max familiarity of artists to search for</p>
    342. 

  342. <p>artist_min_familiarity (float): A float specifying the min familiarity of artists to search for</p>
    343. 

  343. <p>artist_max_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p>
    344. 

  344. <p>artist_min_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p>
    345. 

  345. <p>song_max_hotttnesss (float): A float specifying the max hotttnesss of songs to search for</p>
    346. 

  346. <p>song_min_hotttnesss (float): A float specifying the max hotttnesss of songs to search for</p>
    347. 

  347. <p>max_energy (float): The max energy of song results</p>
    348. 

  348. <p>min_energy (float): The min energy of song results</p>
    349. 

  349. <p>max_dancibility (float): The max dancibility of song results</p>
    350. 

  350. <p>min_dancibility (float): The min dancibility of song results</p>
    351. 

  351. <p>mode (int): 0 or 1 (minor or major)</p>
    352. 

  352. <p>key (int): 0-11 (c, c-sharp, d, e-flat, e, f, f-sharp, g, a-flat, a, b-flat, b)</p>
    353. 

  353. <p>max_latitude (float): A float specifying the max latitude of artists to search for</p>
    354. 

  354. <p>min_latitude (float): A float specifying the min latitude of artists to search for</p>
    355. 

  355. <p>max_longitude (float): A float specifying the max longitude of artists to search for</p>
    356. 

  356. <p>min_longitude (float): A float specifying the min longitude of artists to search for</p>
    357. 

  357. <p>sort (str): A string indicating an attribute and order for sorting the results</p>
    358. 

  358. <p>buckets (list): A list of strings specifying which buckets to retrieve</p>
    359. 

  359. <p>limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</p>
    360. 

  360. <p class="last">rank_type (str): A string denoting the desired ranking for description searches, either &#8216;relevance&#8217; or &#8216;familiarity&#8217;</p>
    361. 

  361. </dd>
    362. 

  362. <dt>Returns:</dt>
    363. 

  363. <dd>A list of Song objects</dd>
    364. 

  364. </dl>
    365. 

  365. <p>Example:</p>
    366. 

  366. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">results</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">artist</span><span class="o">=</span><span class="s">&#39;shakira&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s">&#39;she wolf&#39;</span><span class="p">,</span> <span class="n">buckets</span><span class="o">=</span><span class="p">[</span><span class="s">&#39;id:7digital&#39;</span><span class="p">,</span> <span class="s">&#39;tracks&#39;</span><span class="p">],</span> <span class="n">limit</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">results</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
    367. 

  367. <span class="gp">&gt;&gt;&gt; </span><span class="n">results</span>
    368. 

  368. <span class="go">[&lt;song - She Wolf&gt;]</span>
    369. 

  369. <span class="gp">&gt;&gt;&gt; </span><span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get_tracks</span><span class="p">(</span><span class="s">&#39;7digital&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
    370. 

  370. <span class="go">{u&#39;catalog&#39;: u&#39;7digital&#39;,</span>
    371. 

  371. <span class="go"> u&#39;foreign_id&#39;: u&#39;7digital:track:7854109&#39;,</span>
    372. 

  372. <span class="go"> u&#39;id&#39;: u&#39;TRTOBSE12903CACEC4&#39;,</span>
    373. 

  373. <span class="go"> u&#39;preview_url&#39;: u&#39;http://previews.7digital.com/clips/34/7854109.clip.mp3&#39;,</span>
    374. 

  374. <span class="go"> u&#39;release_image&#39;: u&#39;http://cdn.7static.com/static/img/sleeveart/00/007/081/0000708184_200.jpg&#39;}</span>
    375. 

  375. <span class="gp">&gt;&gt;&gt; </span>
    376. 

  376. </pre></div>
    377. 

  377. </div>
    378. 

  378. </dd></dl>
    379. 

  379. 

  380. <dl class="staticmethod">
    381. 

  381. <dt id="pyechonest.song.profile">
    382. 

  382. <em class="property">static </em><tt class="descclassname">song.</tt><tt class="descname">profile</tt><big>(</big><em>ids</em>, <em>buckets=None</em>, <em>limit=False</em><big>)</big><a class="headerlink" href="#pyechonest.song.profile" title="Permalink to this definition">ś</a></dt>
    383. 

  383. <dd><p>get the profiles for multiple songs at once</p>
    384. 

  384. <dl class="docutils">
    385. 

  385. <dt>Args:</dt>
    386. 

  386. <dd>ids (str or list): a song ID or list of song IDs</dd>
    387. 

  387. <dt>Kwargs:</dt>
    388. 

  388. <dd><p class="first">buckets (list): A list of strings specifying which buckets to retrieve</p>
    389. 

  389. <p class="last">limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</p>
    390. 

  390. </dd>
    391. 

  391. <dt>Returns:</dt>
    392. 

  392. <dd>A list of term document dicts</dd>
    393. 

  393. </dl>
    394. 

  394. <p>Example:</p>
    395. 

  395. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">song_ids</span> <span class="o">=</span> <span class="p">[</span><span class="s">u&#39;SOGNMKX12B0B806320&#39;</span><span class="p">,</span> <span class="s">u&#39;SOLUHKP129F0698D49&#39;</span><span class="p">,</span> <span class="s">u&#39;SOOLGAZ127F3E1B87C&#39;</span><span class="p">,</span> <span class="s">u&#39;SOQKVPH12A58A7AF4D&#39;</span><span class="p">,</span> <span class="s">u&#39;SOHKEEM1288D3ED9F5&#39;</span><span class="p">]</span>
    396. 

  396. <span class="gp">&gt;&gt;&gt; </span><span class="n">songs</span> <span class="o">=</span> <span class="n">song</span><span class="o">.</span><span class="n">profile</span><span class="p">(</span><span class="n">song_ids</span><span class="p">,</span> <span class="n">buckets</span><span class="o">=</span><span class="p">[</span><span class="s">&#39;audio_summary&#39;</span><span class="p">])</span>
    397. 

  397. <span class="go">[&lt;song - chickfactor&gt;,</span>
    398. 

  398. <span class="go"> &lt;song - One Step Closer&gt;,</span>
    399. 

  399. <span class="go"> &lt;song - And I Am Telling You I&#39;m Not Going (Glee Cast Version)&gt;,</span>
    400. 

  400. <span class="go"> &lt;song - In This Temple As In The Hearts Of Man For Whom He Saved The Earth&gt;,</span>
    401. 

  401. <span class="go"> &lt;song - Octet&gt;]</span>
    402. 

  402. <span class="gp">&gt;&gt;&gt; </span><span class="n">songs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">audio_summary</span>
    403. 

  403. <span class="go">{u&#39;analysis_url&#39;: u&#39;https://echonest-analysis.s3.amazonaws.com:443/TR/TRKHTDL123E858AC4B/3/full.json?Signature=sE6OwAzg6UvrtiX6nJJW1t7E6YI%3D&amp;Expires=1287585351&amp;AWSAccessKeyId=AKIAIAFEHLM3KJ2XMHRA&#39;,</span>
    404. 

  404. <span class="go"> u&#39;danceability&#39;: None,</span>
    405. 

  405. <span class="go"> u&#39;duration&#39;: 211.90485000000001,</span>
    406. 

  406. <span class="go"> u&#39;energy&#39;: None,</span>
    407. 

  407. <span class="go"> u&#39;key&#39;: 7,</span>
    408. 

  408. <span class="go"> u&#39;loudness&#39;: -16.736999999999998,</span>
    409. 

  409. <span class="go"> u&#39;mode&#39;: 1,</span>
    410. 

  410. <span class="go"> u&#39;tempo&#39;: 94.957999999999998,</span>
    411. 

  411. <span class="go"> u&#39;time_signature&#39;: 4}</span>
    412. 

  412. <span class="gp">&gt;&gt;&gt; </span>
    413. 

  413. </pre></div>
    414. 

  414. </div>
    415. 

  415. </dd></dl>
    416. 

  416. 

  417. </div>
    418. 

  418. 

  419. 

  420.           </div>
    421. 

  421.         </div>
    422. 

  422.       </div>
    423. 

  423.       <div class="sphinxsidebar">
    424. 

  424.         <div class="sphinxsidebarwrapper">
    425. 

  425.   <h4>Previous topic</h4>
    426. 

  426.   <p class="topless"><a href="artist.html"
    427. 

  427.                         title="previous chapter">Artist &#8211; artist methods</a></p>
    428. 

  428.   <h4>Next topic</h4>
    429. 

  429.   <p class="topless"><a href="track.html"
    430. 

  430.                         title="next chapter">Track &#8211; track methods</a></p>
    431. 

  431.   <h3>This Page</h3>
    432. 

  432.   <ul class="this-page-menu">
    433. 

  433.     <li><a href="_sources/song.txt"
    434. 

  434.            rel="nofollow">Show Source</a></li>
    435. 

  435.   </ul>
    436. 

  436. <div id="searchbox" style="display: none">
    437. 

  437.   <h3>Quick search</h3>
    438. 

  438.     <form class="search" action="search.html" method="get">
    439. 

  439.       <input type="text" name="q" size="18" />
    440. 

  440.       <input type="submit" value="Go" />
    441. 

  441.       <input type="hidden" name="check_keywords" value="yes" />
    442. 

  442.       <input type="hidden" name="area" value="default" />
    443. 

  443.     </form>
    444. 

  444.     <p class="searchtip" style="font-size: 90%">
    445. 

  445.     Enter search terms or a module, class or function name.
    446. 

  446.     </p>
    447. 

  447. </div>
    448. 

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

  449.         </div>
    450. 

  450.       </div>
    451. 

  451.       <div class="clearer"></div>
    452. 

  452.     </div>
    453. 

  453.     <div class="related">
    454. 

  454.       <h3>Navigation</h3>
    455. 

  455.       <ul>
    456. 

  456.         <li class="right" style="margin-right: 10px">
    457. 

  457.           <a href="genindex.html" title="General Index"
    458. 

  458.              >index</a></li>
    459. 

  459.         <li class="right" >
    460. 

  460.           <a href="py-modindex.html" title="Python Module Index"
    461. 

  461.              >modules</a> |</li>
    462. 

  462.         <li class="right" >
    463. 

  463.           <a href="track.html" title="Track – track methods"
    464. 

  464.              >next</a> |</li>
    465. 

  465.         <li class="right" >
    466. 

  466.           <a href="artist.html" title="Artist – artist methods"
    467. 

  467.              >previous</a> |</li>
    468. 

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

  469.       </ul>
    470. 

  470.     </div>
    471. 

  471.     <div class="footer">
    472. 

  472.         &copy; Copyright 2010, The Echo Nest.
    473. 

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

  474.     </div>
    475. 

  475.   </body>
    476. 

  476. </html>
    477.