PageRenderTime 326ms CodeModel.GetById 141ms app.highlight 17ms RepoModel.GetById 124ms app.codeStats 0ms

/apidocs/pyechonest.song-module.html

http://echo-nest-remix.googlecode.com/
HTML | 271 lines | 232 code | 17 blank | 22 comment | 0 complexity | 08800f44fb4b66c983865113d6aef8bb 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</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        Module&nbsp;song
 44      </span>
 45    </td>
 46    <td>
 47      <table cellpadding="0" cellspacing="0">
 48        <!-- hide/show private -->
 49        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 50    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 51        <tr><td align="right"><span class="options"
 52            >[<a href="frames.html" target="_top">frames</a
 53            >]&nbsp;|&nbsp;<a href="pyechonest.song-module.html"
 54            target="_top">no&nbsp;frames</a>]</span></td></tr>
 55      </table>
 56    </td>
 57  </tr>
 58</table>
 59<!-- ==================== MODULE DESCRIPTION ==================== -->
 60<h1 class="epydoc">Module song</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.song-pysrc.html">source&nbsp;code</a></span></p>
 61<p>Copyright (c) 2010 The Echo Nest. All rights reserved.
 62Created by Tyler Williams on 2010-04-25.</p>
 63<p>The Song module loosely covers <a class="rst-reference external" href="http://developer.echonest.com/docs/v4/song.html" target="_top">http://developer.echonest.com/docs/v4/song.html</a>
 64Refer to the official api documentation if you are unsure about something.</p>
 65
 66<!-- ==================== CLASSES ==================== -->
 67<a name="section-Classes"></a>
 68<table class="summary" border="1" cellpadding="3"
 69       cellspacing="0" width="100%" bgcolor="white">
 70<tr bgcolor="#70b0f0" class="table-header">
 71  <td colspan="2" class="table-header">
 72    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 73      <tr valign="top">
 74        <td align="left"><span class="table-header">Classes</span></td>
 75        <td align="right" valign="top"
 76         ><span class="options">[<a href="#section-Classes"
 77         class="privatelink" onclick="toggle_private();"
 78         >hide private</a>]</span></td>
 79      </tr>
 80    </table>
 81  </td>
 82</tr>
 83<tr>
 84    <td width="15%" align="right" valign="top" class="summary">
 85      <span class="summary-type">&nbsp;</span>
 86    </td><td class="summary">
 87        <a href="pyechonest.song.Song-class.html" class="summary-name">Song</a><br />
 88      A Song object
 89    </td>
 90  </tr>
 91</table>
 92<!-- ==================== FUNCTIONS ==================== -->
 93<a name="section-Functions"></a>
 94<table class="summary" border="1" cellpadding="3"
 95       cellspacing="0" width="100%" bgcolor="white">
 96<tr bgcolor="#70b0f0" class="table-header">
 97  <td colspan="2" class="table-header">
 98    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 99      <tr valign="top">
100        <td align="left"><span class="table-header">Functions</span></td>
101        <td align="right" valign="top"
102         ><span class="options">[<a href="#section-Functions"
103         class="privatelink" onclick="toggle_private();"
104         >hide private</a>]</span></td>
105      </tr>
106    </table>
107  </td>
108</tr>
109<tr>
110    <td width="15%" align="right" valign="top" class="summary">
111      <span class="summary-type">&nbsp;</span>
112    </td><td class="summary">
113      <table width="100%" cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td><span class="summary-sig"><a name="identify"></a><span class="summary-sig-name">identify</span>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
116        <span class="summary-sig-arg">query_obj</span>=<span class="summary-sig-default">None</span>,
117        <span class="summary-sig-arg">code</span>=<span class="summary-sig-default">None</span>,
118        <span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
119        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default">None</span>,
120        <span class="summary-sig-arg">release</span>=<span class="summary-sig-default">None</span>,
121        <span class="summary-sig-arg">duration</span>=<span class="summary-sig-default">None</span>,
122        <span class="summary-sig-arg">genre</span>=<span class="summary-sig-default">None</span>,
123        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
124        <span class="summary-sig-arg">alt</span>=<span class="summary-sig-default">None</span>,
125        <span class="summary-sig-arg">codegen_start</span>=<span class="summary-sig-default">0</span>,
126        <span class="summary-sig-arg">codegen_duration</span>=<span class="summary-sig-default">30</span>)</span></td>
127          <td align="right" valign="top">
128            <span class="codelink"><a href="pyechonest.song-pysrc.html#identify">source&nbsp;code</a></span>
129            
130          </td>
131        </tr>
132      </table>
133      
134    </td>
135  </tr>
136<tr>
137    <td width="15%" align="right" valign="top" class="summary">
138      <span class="summary-type">&nbsp;</span>
139    </td><td class="summary">
140      <table width="100%" cellpadding="0" cellspacing="0" border="0">
141        <tr>
142          <td><span class="summary-sig"><a name="search"></a><span class="summary-sig-name">search</span>(<span class="summary-sig-arg">title</span>=<span class="summary-sig-default">None</span>,
143        <span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
144        <span class="summary-sig-arg">artist_id</span>=<span class="summary-sig-default">None</span>,
145        <span class="summary-sig-arg">combined</span>=<span class="summary-sig-default">None</span>,
146        <span class="summary-sig-arg">description</span>=<span class="summary-sig-default">None</span>,
147        <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">None</span>,
148        <span class="summary-sig-arg">max_tempo</span>=<span class="summary-sig-default">None</span>,
149        <span class="summary-sig-arg">min_tempo</span>=<span class="summary-sig-default">None</span>,
150        <span class="summary-sig-arg">max_duration</span>=<span class="summary-sig-default">None</span>,
151        <span class="summary-sig-arg">min_duration</span>=<span class="summary-sig-default">None</span>,
152        <span class="summary-sig-arg">max_loudness</span>=<span class="summary-sig-default">None</span>,
153        <span class="summary-sig-arg">min_loudness</span>=<span class="summary-sig-default">None</span>,
154        <span class="summary-sig-arg">artist_max_familiarity</span>=<span class="summary-sig-default">None</span>,
155        <span class="summary-sig-arg">artist_min_familiarity</span>=<span class="summary-sig-default">None</span>,
156        <span class="summary-sig-arg">artist_max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
157        <span class="summary-sig-arg">artist_min_hotttnesss</span>=<span class="summary-sig-default">None</span>,
158        <span class="summary-sig-arg">song_max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
159        <span class="summary-sig-arg">song_min_hotttnesss</span>=<span class="summary-sig-default">None</span>,
160        <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">None</span>,
161        <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>,
162        <span class="summary-sig-arg">max_latitude</span>=<span class="summary-sig-default">None</span>,
163        <span class="summary-sig-arg">min_latitude</span>=<span class="summary-sig-default">None</span>,
164        <span class="summary-sig-arg">max_longitude</span>=<span class="summary-sig-default">None</span>,
165        <span class="summary-sig-arg">min_longitude</span>=<span class="summary-sig-default">None</span>,
166        <span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">None</span>,
167        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
168        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
169      search for songs</td>
170          <td align="right" valign="top">
171            <span class="codelink"><a href="pyechonest.song-pysrc.html#search">source&nbsp;code</a></span>
172            
173          </td>
174        </tr>
175      </table>
176      
177    </td>
178  </tr>
179<tr>
180    <td width="15%" align="right" valign="top" class="summary">
181      <span class="summary-type">&nbsp;</span>
182    </td><td class="summary">
183      <table width="100%" cellpadding="0" cellspacing="0" border="0">
184        <tr>
185          <td><span class="summary-sig"><a name="profile"></a><span class="summary-sig-name">profile</span>(<span class="summary-sig-arg">ids</span>,
186        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
187        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
188      get the profiles for multiple songs at once</td>
189          <td align="right" valign="top">
190            <span class="codelink"><a href="pyechonest.song-pysrc.html#profile">source&nbsp;code</a></span>
191            
192          </td>
193        </tr>
194      </table>
195      
196    </td>
197  </tr>
198</table>
199<!-- ==================== VARIABLES ==================== -->
200<a name="section-Variables"></a>
201<table class="summary" border="1" cellpadding="3"
202       cellspacing="0" width="100%" bgcolor="white">
203<tr bgcolor="#70b0f0" class="table-header">
204  <td colspan="2" class="table-header">
205    <table border="0" cellpadding="0" cellspacing="0" width="100%">
206      <tr valign="top">
207        <td align="left"><span class="table-header">Variables</span></td>
208        <td align="right" valign="top"
209         ><span class="options">[<a href="#section-Variables"
210         class="privatelink" onclick="toggle_private();"
211         >hide private</a>]</span></td>
212      </tr>
213    </table>
214  </td>
215</tr>
216<tr>
217    <td width="15%" align="right" valign="top" class="summary">
218      <span class="summary-type">&nbsp;</span>
219    </td><td class="summary">
220        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pyechonest'"><code class="variable-quote">'</code><code class="variable-string">pyechonest</code><code class="variable-quote">'</code></code>
221    </td>
222  </tr>
223</table>
224<!-- ==================== NAVIGATION BAR ==================== -->
225<table class="navbar" border="0" width="100%" cellpadding="0"
226       bgcolor="#a0c0ff" cellspacing="0">
227  <tr valign="middle">
228
229  <!-- Tree link -->
230      <th>&nbsp;&nbsp;&nbsp;<a
231        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
232
233  <!-- Index link -->
234      <th>&nbsp;&nbsp;&nbsp;<a
235        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
236
237  <!-- Help link -->
238      <th>&nbsp;&nbsp;&nbsp;<a
239        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
240
241  <!-- Project homepage -->
242      <th class="navbar" align="right" width="100%">
243        <table border="0" cellpadding="0" cellspacing="0">
244          <tr><th class="navbar" align="center"
245            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
246          </tr></table></th>
247  </tr>
248</table>
249<table border="0" cellpadding="0" cellspacing="0" width="100%%">
250  <tr>
251    <td align="left" class="footer">
252    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
253    </td>
254    <td align="right" class="footer">
255      <a target="mainFrame" href="http://epydoc.sourceforge.net"
256        >http://epydoc.sourceforge.net</a>
257    </td>
258  </tr>
259</table>
260
261<script type="text/javascript">
262  <!--
263  // Private objects are initially displayed (because if
264  // javascript is turned off then we want them to be
265  // visible); but by default, we want to hide them.  So hide
266  // them unless we have a cookie that says to show them.
267  checkCookie();
268  // -->
269</script>
270</body>
271</html>