PageRenderTime 110ms CodeModel.GetById 60ms app.highlight 36ms RepoModel.GetById 5ms app.codeStats 1ms

/apidocs/pyechonest.song.Song-class.html

http://echo-nest-remix.googlecode.com/
HTML | 780 lines | 718 code | 39 blank | 23 comment | 0 complexity | 1ec1f457964f62048debf8adbb454301 MD5 | raw file
  1<?xml version="1.0" encoding="ascii"?>
  2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3          "DTD/xhtml1-transitional.dtd">
  4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5<head>
  6  <title>pyechonest.song.Song</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
 43        <a href="pyechonest.song-module.html">Module&nbsp;song</a> ::
 44        Class&nbsp;Song
 45      </span>
 46    </td>
 47    <td>
 48      <table cellpadding="0" cellspacing="0">
 49        <!-- hide/show private -->
 50        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 51    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 52        <tr><td align="right"><span class="options"
 53            >[<a href="frames.html" target="_top">frames</a
 54            >]&nbsp;|&nbsp;<a href="pyechonest.song.Song-class.html"
 55            target="_top">no&nbsp;frames</a>]</span></td></tr>
 56      </table>
 57    </td>
 58  </tr>
 59</table>
 60<!-- ==================== CLASS DESCRIPTION ==================== -->
 61<h1 class="epydoc">Class Song</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.song-pysrc.html#Song">source&nbsp;code</a></span></p>
 62<center>
 63
 64</center>
 65<hr />
 66<p>A Song object</p>
 67<dl class="rst-docutils">
 68<dt>Create a song object like so:</dt>
 69<dd>s = song.Song('SOXZYYG127F3E1B7A2')</dd>
 70<dt>Attributes: (<strong>attributes</strong> are guaranteed to exist as soon as an artist object exists)</dt>
 71<dd><strong>id</strong>: Echo Nest Song ID
 72<strong>title</strong>: Song Title
 73<strong>artist_name</strong>: Artist Name
 74<strong>artist_id</strong>: Artist ID
 75audio_summary: An Audio Summary Result object
 76song_hotttnesss: A float representing a song's hotttnesss
 77artist_hotttnesss: A float representing a song's parent artist's hotttnesss
 78artist_familiarity: A float representing a song's parent artist's familiarity
 79artist_location: A string specifying a song's parent artist's location
 80tracks: A list of track result objects</dd>
 81</dl>
 82
 83<!-- ==================== INSTANCE METHODS ==================== -->
 84<a name="section-InstanceMethods"></a>
 85<table class="summary" border="1" cellpadding="3"
 86       cellspacing="0" width="100%" bgcolor="white">
 87<tr bgcolor="#70b0f0" class="table-header">
 88  <td colspan="2" class="table-header">
 89    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 90      <tr valign="top">
 91        <td align="left"><span class="table-header">Instance Methods</span></td>
 92        <td align="right" valign="top"
 93         ><span class="options">[<a href="#section-InstanceMethods"
 94         class="privatelink" onclick="toggle_private();"
 95         >hide private</a>]</span></td>
 96      </tr>
 97    </table>
 98  </td>
 99</tr>
100<tr>
101    <td width="15%" align="right" valign="top" class="summary">
102      <span class="summary-type">&nbsp;</span>
103    </td><td class="summary">
104      <table width="100%" cellpadding="0" cellspacing="0" border="0">
105        <tr>
106          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
107        <span class="summary-sig-arg">id</span>,
108        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
109        <span class="summary-sig-arg">**kwargs</span>)</span><br />
110      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
111          <td align="right" valign="top">
112            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__init__">source&nbsp;code</a></span>
113            
114          </td>
115        </tr>
116      </table>
117      
118    </td>
119  </tr>
120<tr>
121    <td width="15%" align="right" valign="top" class="summary">
122      <span class="summary-type">&nbsp;</span>
123    </td><td class="summary">
124      <table width="100%" cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
127      repr(x)</td>
128          <td align="right" valign="top">
129            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__repr__">source&nbsp;code</a></span>
130            
131          </td>
132        </tr>
133      </table>
134      
135    </td>
136  </tr>
137<tr>
138    <td width="15%" align="right" valign="top" class="summary">
139      <span class="summary-type">&nbsp;</span>
140    </td><td class="summary">
141      <table width="100%" cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
144      str(x)</td>
145          <td align="right" valign="top">
146            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__str__">source&nbsp;code</a></span>
147            
148          </td>
149        </tr>
150      </table>
151      
152    </td>
153  </tr>
154<tr>
155    <td width="15%" align="right" valign="top" class="summary">
156      <span class="summary-type">&nbsp;</span>
157    </td><td class="summary">
158      <table width="100%" cellpadding="0" cellspacing="0" border="0">
159        <tr>
160          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_audio_summary" class="summary-sig-name">get_audio_summary</a>(<span class="summary-sig-arg">self</span>,
161        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
162      Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, and analysis_url.</td>
163          <td align="right" valign="top">
164            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_audio_summary">source&nbsp;code</a></span>
165            
166          </td>
167        </tr>
168      </table>
169      
170    </td>
171  </tr>
172<tr>
173    <td width="15%" align="right" valign="top" class="summary">
174      <span class="summary-type">&nbsp;</span>
175    </td><td class="summary">
176      <table width="100%" cellpadding="0" cellspacing="0" border="0">
177        <tr>
178          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_song_hotttnesss" class="summary-sig-name">get_song_hotttnesss</a>(<span class="summary-sig-arg">self</span>,
179        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
180      Get our numerical description of how hottt a song currently is</td>
181          <td align="right" valign="top">
182            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_song_hotttnesss">source&nbsp;code</a></span>
183            
184          </td>
185        </tr>
186      </table>
187      
188    </td>
189  </tr>
190<tr>
191    <td width="15%" align="right" valign="top" class="summary">
192      <span class="summary-type">&nbsp;</span>
193    </td><td class="summary">
194      <table width="100%" cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_hotttnesss" class="summary-sig-name">get_artist_hotttnesss</a>(<span class="summary-sig-arg">self</span>,
197        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
198      Get our numerical description of how hottt a song's artist currently is</td>
199          <td align="right" valign="top">
200            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_hotttnesss">source&nbsp;code</a></span>
201            
202          </td>
203        </tr>
204      </table>
205      
206    </td>
207  </tr>
208<tr>
209    <td width="15%" align="right" valign="top" class="summary">
210      <span class="summary-type">&nbsp;</span>
211    </td><td class="summary">
212      <table width="100%" cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_familiarity" class="summary-sig-name">get_artist_familiarity</a>(<span class="summary-sig-arg">self</span>,
215        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
216      Get our numerical estimation of how familiar a song's artist currently is to the world</td>
217          <td align="right" valign="top">
218            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_familiarity">source&nbsp;code</a></span>
219            
220          </td>
221        </tr>
222      </table>
223      
224    </td>
225  </tr>
226<tr>
227    <td width="15%" align="right" valign="top" class="summary">
228      <span class="summary-type">&nbsp;</span>
229    </td><td class="summary">
230      <table width="100%" cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_location" class="summary-sig-name">get_artist_location</a>(<span class="summary-sig-arg">self</span>,
233        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
234      Get the location of a song's artist.</td>
235          <td align="right" valign="top">
236            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_location">source&nbsp;code</a></span>
237            
238          </td>
239        </tr>
240      </table>
241      
242    </td>
243  </tr>
244<tr>
245    <td width="15%" align="right" valign="top" class="summary">
246      <span class="summary-type">&nbsp;</span>
247    </td><td class="summary">
248      <table width="100%" cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_tracks" class="summary-sig-name">get_tracks</a>(<span class="summary-sig-arg">self</span>,
251        <span class="summary-sig-arg">catalog</span>,
252        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>,
253        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span><br />
254      Get the tracks for a song given a catalog.</td>
255          <td align="right" valign="top">
256            <span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_tracks">source&nbsp;code</a></span>
257            
258          </td>
259        </tr>
260      </table>
261      
262    </td>
263  </tr>
264  <tr>
265    <td colspan="2" class="summary">
266    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyechonest.proxies.SongProxy-class.html">proxies.SongProxy</a></code></b>:
267      <code><a href="pyechonest.proxies.SongProxy-class.html#get_attribute">get_attribute</a></code>
268      </p>
269    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyechonest.proxies.GenericProxy-class.html">proxies.GenericProxy</a></code></b>:
270      <code><a href="pyechonest.proxies.GenericProxy-class.html#post_attribute">post_attribute</a></code>
271      </p>
272    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
273      <code>__delattr__</code>,
274      <code>__format__</code>,
275      <code>__getattribute__</code>,
276      <code>__hash__</code>,
277      <code>__new__</code>,
278      <code>__reduce__</code>,
279      <code>__reduce_ex__</code>,
280      <code>__setattr__</code>,
281      <code>__sizeof__</code>,
282      <code>__subclasshook__</code>
283      </p>
284    </td>
285  </tr>
286</table>
287<!-- ==================== PROPERTIES ==================== -->
288<a name="section-Properties"></a>
289<table class="summary" border="1" cellpadding="3"
290       cellspacing="0" width="100%" bgcolor="white">
291<tr bgcolor="#70b0f0" class="table-header">
292  <td colspan="2" class="table-header">
293    <table border="0" cellpadding="0" cellspacing="0" width="100%">
294      <tr valign="top">
295        <td align="left"><span class="table-header">Properties</span></td>
296        <td align="right" valign="top"
297         ><span class="options">[<a href="#section-Properties"
298         class="privatelink" onclick="toggle_private();"
299         >hide private</a>]</span></td>
300      </tr>
301    </table>
302  </td>
303</tr>
304<tr>
305    <td width="15%" align="right" valign="top" class="summary">
306      <span class="summary-type">&nbsp;</span>
307    </td><td class="summary">
308        <a href="pyechonest.song.Song-class.html#audio_summary" class="summary-name">audio_summary</a><br />
309      Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, and analysis_url.
310    </td>
311  </tr>
312<tr>
313    <td width="15%" align="right" valign="top" class="summary">
314      <span class="summary-type">&nbsp;</span>
315    </td><td class="summary">
316        <a href="pyechonest.song.Song-class.html#song_hotttnesss" class="summary-name">song_hotttnesss</a><br />
317      Get our numerical description of how hottt a song currently is
318    </td>
319  </tr>
320<tr>
321    <td width="15%" align="right" valign="top" class="summary">
322      <span class="summary-type">&nbsp;</span>
323    </td><td class="summary">
324        <a href="pyechonest.song.Song-class.html#artist_hotttnesss" class="summary-name">artist_hotttnesss</a><br />
325      Get our numerical description of how hottt a song's artist currently is
326    </td>
327  </tr>
328<tr>
329    <td width="15%" align="right" valign="top" class="summary">
330      <span class="summary-type">&nbsp;</span>
331    </td><td class="summary">
332        <a href="pyechonest.song.Song-class.html#artist_familiarity" class="summary-name">artist_familiarity</a><br />
333      Get our numerical estimation of how familiar a song's artist currently is to the world
334    </td>
335  </tr>
336<tr>
337    <td width="15%" align="right" valign="top" class="summary">
338      <span class="summary-type">&nbsp;</span>
339    </td><td class="summary">
340        <a href="pyechonest.song.Song-class.html#artist_location" class="summary-name">artist_location</a><br />
341      Get the location of a song's artist.
342    </td>
343  </tr>
344  <tr>
345    <td colspan="2" class="summary">
346    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
347      <code>__class__</code>
348      </p>
349    </td>
350  </tr>
351</table>
352<!-- ==================== METHOD DETAILS ==================== -->
353<a name="section-MethodDetails"></a>
354<table class="details" border="1" cellpadding="3"
355       cellspacing="0" width="100%" bgcolor="white">
356<tr bgcolor="#70b0f0" class="table-header">
357  <td colspan="2" class="table-header">
358    <table border="0" cellpadding="0" cellspacing="0" width="100%">
359      <tr valign="top">
360        <td align="left"><span class="table-header">Method Details</span></td>
361        <td align="right" valign="top"
362         ><span class="options">[<a href="#section-MethodDetails"
363         class="privatelink" onclick="toggle_private();"
364         >hide private</a>]</span></td>
365      </tr>
366    </table>
367  </td>
368</tr>
369</table>
370<a name="__init__"></a>
371<div>
372<table class="details" border="1" cellpadding="3"
373       cellspacing="0" width="100%" bgcolor="white">
374<tr><td>
375  <table width="100%" cellpadding="0" cellspacing="0" border="0">
376  <tr valign="top"><td>
377  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
378        <span class="sig-arg">id</span>,
379        <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
380        <span class="sig-arg">**kwargs</span>)</span>
381    <br /><em class="fname">(Constructor)</em>
382  </h3>
383  </td><td align="right" valign="top"
384    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__init__">source&nbsp;code</a></span>&nbsp;
385    </td>
386  </tr></table>
387  
388  x.__init__(...) initializes x; see x.__class__.__doc__ for signature
389  <dl class="fields">
390    <dt>Overrides:
391        object.__init__
392        <dd><em class="note">(inherited documentation)</em></dd>
393    </dt>
394  </dl>
395</td></tr></table>
396</div>
397<a name="__repr__"></a>
398<div>
399<table class="details" border="1" cellpadding="3"
400       cellspacing="0" width="100%" bgcolor="white">
401<tr><td>
402  <table width="100%" cellpadding="0" cellspacing="0" border="0">
403  <tr valign="top"><td>
404  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
405    <br /><em class="fname">(Representation operator)</em>
406  </h3>
407  </td><td align="right" valign="top"
408    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__repr__">source&nbsp;code</a></span>&nbsp;
409    </td>
410  </tr></table>
411  
412  repr(x)
413  <dl class="fields">
414    <dt>Overrides:
415        object.__repr__
416        <dd><em class="note">(inherited documentation)</em></dd>
417    </dt>
418  </dl>
419</td></tr></table>
420</div>
421<a name="__str__"></a>
422<div>
423<table class="details" border="1" cellpadding="3"
424       cellspacing="0" width="100%" bgcolor="white">
425<tr><td>
426  <table width="100%" cellpadding="0" cellspacing="0" border="0">
427  <tr valign="top"><td>
428  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
429    <br /><em class="fname">(Informal representation operator)</em>
430  </h3>
431  </td><td align="right" valign="top"
432    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.__str__">source&nbsp;code</a></span>&nbsp;
433    </td>
434  </tr></table>
435  
436  str(x)
437  <dl class="fields">
438    <dt>Overrides:
439        object.__str__
440        <dd><em class="note">(inherited documentation)</em></dd>
441    </dt>
442  </dl>
443</td></tr></table>
444</div>
445<a name="get_audio_summary"></a>
446<div>
447<table class="details" border="1" cellpadding="3"
448       cellspacing="0" width="100%" bgcolor="white">
449<tr><td>
450  <table width="100%" cellpadding="0" cellspacing="0" border="0">
451  <tr valign="top"><td>
452  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_audio_summary</span>(<span class="sig-arg">self</span>,
453        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
454  </h3>
455  </td><td align="right" valign="top"
456    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_audio_summary">source&nbsp;code</a></span>&nbsp;
457    </td>
458  </tr></table>
459  
460  <p>Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, and analysis_url.</p>
461<dl class="rst-docutils">
462<dt>Args:</dt>
463<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
464<dt>Returns:</dt>
465<dd>A dictionary containing mode, tempo, key, duration, time signature, loudness, and analysis_url keys.</dd>
466</dl>
467  <dl class="fields">
468  </dl>
469</td></tr></table>
470</div>
471<a name="get_song_hotttnesss"></a>
472<div>
473<table class="details" border="1" cellpadding="3"
474       cellspacing="0" width="100%" bgcolor="white">
475<tr><td>
476  <table width="100%" cellpadding="0" cellspacing="0" border="0">
477  <tr valign="top"><td>
478  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_song_hotttnesss</span>(<span class="sig-arg">self</span>,
479        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
480  </h3>
481  </td><td align="right" valign="top"
482    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_song_hotttnesss">source&nbsp;code</a></span>&nbsp;
483    </td>
484  </tr></table>
485  
486  <p>Get our numerical description of how hottt a song currently is</p>
487<dl class="rst-docutils">
488<dt>Args:</dt>
489<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
490<dt>Returns:</dt>
491<dd>A float representing hotttnesss.</dd>
492</dl>
493  <dl class="fields">
494  </dl>
495</td></tr></table>
496</div>
497<a name="get_artist_hotttnesss"></a>
498<div>
499<table class="details" border="1" cellpadding="3"
500       cellspacing="0" width="100%" bgcolor="white">
501<tr><td>
502  <table width="100%" cellpadding="0" cellspacing="0" border="0">
503  <tr valign="top"><td>
504  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_artist_hotttnesss</span>(<span class="sig-arg">self</span>,
505        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
506  </h3>
507  </td><td align="right" valign="top"
508    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_hotttnesss">source&nbsp;code</a></span>&nbsp;
509    </td>
510  </tr></table>
511  
512  <p>Get our numerical description of how hottt a song's artist currently is</p>
513<dl class="rst-docutils">
514<dt>Args:</dt>
515<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
516<dt>Returns:</dt>
517<dd>A float representing hotttnesss.</dd>
518</dl>
519  <dl class="fields">
520  </dl>
521</td></tr></table>
522</div>
523<a name="get_artist_familiarity"></a>
524<div>
525<table class="details" border="1" cellpadding="3"
526       cellspacing="0" width="100%" bgcolor="white">
527<tr><td>
528  <table width="100%" cellpadding="0" cellspacing="0" border="0">
529  <tr valign="top"><td>
530  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_artist_familiarity</span>(<span class="sig-arg">self</span>,
531        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
532  </h3>
533  </td><td align="right" valign="top"
534    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_familiarity">source&nbsp;code</a></span>&nbsp;
535    </td>
536  </tr></table>
537  
538  <p>Get our numerical estimation of how familiar a song's artist currently is to the world</p>
539<dl class="rst-docutils">
540<dt>Args:</dt>
541<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
542<dt>Returns:</dt>
543<dd>A float representing familiarity.</dd>
544</dl>
545  <dl class="fields">
546  </dl>
547</td></tr></table>
548</div>
549<a name="get_artist_location"></a>
550<div>
551<table class="details" border="1" cellpadding="3"
552       cellspacing="0" width="100%" bgcolor="white">
553<tr><td>
554  <table width="100%" cellpadding="0" cellspacing="0" border="0">
555  <tr valign="top"><td>
556  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_artist_location</span>(<span class="sig-arg">self</span>,
557        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
558  </h3>
559  </td><td align="right" valign="top"
560    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_artist_location">source&nbsp;code</a></span>&nbsp;
561    </td>
562  </tr></table>
563  
564  <p>Get the location of a song's artist.</p>
565<dl class="rst-docutils">
566<dt>Args:</dt>
567<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
568<dt>Returns:</dt>
569<dd>An artist location object.</dd>
570</dl>
571  <dl class="fields">
572  </dl>
573</td></tr></table>
574</div>
575<a name="get_tracks"></a>
576<div>
577<table class="details" border="1" cellpadding="3"
578       cellspacing="0" width="100%" bgcolor="white">
579<tr><td>
580  <table width="100%" cellpadding="0" cellspacing="0" border="0">
581  <tr valign="top"><td>
582  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_tracks</span>(<span class="sig-arg">self</span>,
583        <span class="sig-arg">catalog</span>,
584        <span class="sig-arg">limit</span>=<span class="sig-default">False</span>,
585        <span class="sig-arg">cache</span>=<span class="sig-default">True</span>)</span>
586  </h3>
587  </td><td align="right" valign="top"
588    ><span class="codelink"><a href="pyechonest.song-pysrc.html#Song.get_tracks">source&nbsp;code</a></span>&nbsp;
589    </td>
590  </tr></table>
591  
592  <p>Get the tracks for a song given a catalog.</p>
593<dl class="rst-docutils">
594<dt>Args:</dt>
595<dd>catalog: a string representing the catalog whose track you want to retrieve.</dd>
596<dt>Returns:</dt>
597<dd>A list of Track dicts.</dd>
598</dl>
599  <dl class="fields">
600  </dl>
601</td></tr></table>
602</div>
603<br />
604<!-- ==================== PROPERTY DETAILS ==================== -->
605<a name="section-PropertyDetails"></a>
606<table class="details" border="1" cellpadding="3"
607       cellspacing="0" width="100%" bgcolor="white">
608<tr bgcolor="#70b0f0" class="table-header">
609  <td colspan="2" class="table-header">
610    <table border="0" cellpadding="0" cellspacing="0" width="100%">
611      <tr valign="top">
612        <td align="left"><span class="table-header">Property Details</span></td>
613        <td align="right" valign="top"
614         ><span class="options">[<a href="#section-PropertyDetails"
615         class="privatelink" onclick="toggle_private();"
616         >hide private</a>]</span></td>
617      </tr>
618    </table>
619  </td>
620</tr>
621</table>
622<a name="audio_summary"></a>
623<div>
624<table class="details" border="1" cellpadding="3"
625       cellspacing="0" width="100%" bgcolor="white">
626<tr><td>
627  <h3 class="epydoc">audio_summary</h3>
628  <p>Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, and analysis_url.</p>
629<dl class="rst-docutils">
630<dt>Args:</dt>
631<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
632<dt>Returns:</dt>
633<dd>A dictionary containing mode, tempo, key, duration, time signature, loudness, and analysis_url keys.</dd>
634</dl>
635  <dl class="fields">
636    <dt>Get Method:</dt>
637    <dd class="value"><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_audio_summary" class="summary-sig-name">get_audio_summary</a>(<span class="summary-sig-arg">self</span>,
638        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span>
639        - Get an audio summary of a song containing mode, tempo, key, duration, time signature, loudness, and analysis_url.
640    </dd>
641  </dl>
642</td></tr></table>
643</div>
644<a name="song_hotttnesss"></a>
645<div>
646<table class="details" border="1" cellpadding="3"
647       cellspacing="0" width="100%" bgcolor="white">
648<tr><td>
649  <h3 class="epydoc">song_hotttnesss</h3>
650  <p>Get our numerical description of how hottt a song currently is</p>
651<dl class="rst-docutils">
652<dt>Args:</dt>
653<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
654<dt>Returns:</dt>
655<dd>A float representing hotttnesss.</dd>
656</dl>
657  <dl class="fields">
658    <dt>Get Method:</dt>
659    <dd class="value"><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_song_hotttnesss" class="summary-sig-name">get_song_hotttnesss</a>(<span class="summary-sig-arg">self</span>,
660        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span>
661        - Get our numerical description of how hottt a song currently is
662    </dd>
663  </dl>
664</td></tr></table>
665</div>
666<a name="artist_hotttnesss"></a>
667<div>
668<table class="details" border="1" cellpadding="3"
669       cellspacing="0" width="100%" bgcolor="white">
670<tr><td>
671  <h3 class="epydoc">artist_hotttnesss</h3>
672  <p>Get our numerical description of how hottt a song's artist currently is</p>
673<dl class="rst-docutils">
674<dt>Args:</dt>
675<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
676<dt>Returns:</dt>
677<dd>A float representing hotttnesss.</dd>
678</dl>
679  <dl class="fields">
680    <dt>Get Method:</dt>
681    <dd class="value"><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_hotttnesss" class="summary-sig-name">get_artist_hotttnesss</a>(<span class="summary-sig-arg">self</span>,
682        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span>
683        - Get our numerical description of how hottt a song's artist currently is
684    </dd>
685  </dl>
686</td></tr></table>
687</div>
688<a name="artist_familiarity"></a>
689<div>
690<table class="details" border="1" cellpadding="3"
691       cellspacing="0" width="100%" bgcolor="white">
692<tr><td>
693  <h3 class="epydoc">artist_familiarity</h3>
694  <p>Get our numerical estimation of how familiar a song's artist currently is to the world</p>
695<dl class="rst-docutils">
696<dt>Args:</dt>
697<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
698<dt>Returns:</dt>
699<dd>A float representing familiarity.</dd>
700</dl>
701  <dl class="fields">
702    <dt>Get Method:</dt>
703    <dd class="value"><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_familiarity" class="summary-sig-name">get_artist_familiarity</a>(<span class="summary-sig-arg">self</span>,
704        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span>
705        - Get our numerical estimation of how familiar a song's artist currently is to the world
706    </dd>
707  </dl>
708</td></tr></table>
709</div>
710<a name="artist_location"></a>
711<div>
712<table class="details" border="1" cellpadding="3"
713       cellspacing="0" width="100%" bgcolor="white">
714<tr><td>
715  <h3 class="epydoc">artist_location</h3>
716  <p>Get the location of a song's artist.</p>
717<dl class="rst-docutils">
718<dt>Args:</dt>
719<dd>cache: A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd>
720<dt>Returns:</dt>
721<dd>An artist location object.</dd>
722</dl>
723  <dl class="fields">
724    <dt>Get Method:</dt>
725    <dd class="value"><span class="summary-sig"><a href="pyechonest.song.Song-class.html#get_artist_location" class="summary-sig-name">get_artist_location</a>(<span class="summary-sig-arg">self</span>,
726        <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">True</span>)</span>
727        - Get the location of a song's artist.
728    </dd>
729  </dl>
730</td></tr></table>
731</div>
732<br />
733<!-- ==================== NAVIGATION BAR ==================== -->
734<table class="navbar" border="0" width="100%" cellpadding="0"
735       bgcolor="#a0c0ff" cellspacing="0">
736  <tr valign="middle">
737
738  <!-- Tree link -->
739      <th>&nbsp;&nbsp;&nbsp;<a
740        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
741
742  <!-- Index link -->
743      <th>&nbsp;&nbsp;&nbsp;<a
744        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
745
746  <!-- Help link -->
747      <th>&nbsp;&nbsp;&nbsp;<a
748        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
749
750  <!-- Project homepage -->
751      <th class="navbar" align="right" width="100%">
752        <table border="0" cellpadding="0" cellspacing="0">
753          <tr><th class="navbar" align="center"
754            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
755          </tr></table></th>
756  </tr>
757</table>
758<table border="0" cellpadding="0" cellspacing="0" width="100%%">
759  <tr>
760    <td align="left" class="footer">
761    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:59 2010
762    </td>
763    <td align="right" class="footer">
764      <a target="mainFrame" href="http://epydoc.sourceforge.net"
765        >http://epydoc.sourceforge.net</a>
766    </td>
767  </tr>
768</table>
769
770<script type="text/javascript">
771  <!--
772  // Private objects are initially displayed (because if
773  // javascript is turned off then we want them to be
774  // visible); but by default, we want to hide them.  So hide
775  // them unless we have a cookie that says to show them.
776  checkCookie();
777  // -->
778</script>
779</body>
780</html>