PageRenderTime 11ms CodeModel.GetById 1ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/apidocs/echonest.cloud-module.html

http://echo-nest-remix.googlecode.com/
HTML | 266 lines | 219 code | 25 blank | 22 comment | 0 complexity | cb5857432247a9f95a9877565263e4aa 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>echonest.cloud</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/">The Echo Nest Remix API, SVN Revision: 448</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="echonest-module.html">Package&nbsp;echonest</a> ::
 43        Module&nbsp;cloud
 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="echonest.cloud-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 cloud</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.cloud-pysrc.html">source&nbsp;code</a></span></p>
 61<pre class="literalblock">
 62
 63Convenience methods for creating Remix audio objects by searching.
 64Created 2010-04-12 by Jason Sundram
 65
 66See the docs here for how to use the api directly:
 67http://beta.developer.echonest.com/song.html#search
 68
 69</pre>
 70
 71<!-- ==================== FUNCTIONS ==================== -->
 72<a name="section-Functions"></a>
 73<table class="summary" border="1" cellpadding="3"
 74       cellspacing="0" width="100%" bgcolor="white">
 75<tr bgcolor="#70b0f0" class="table-header">
 76  <td colspan="2" class="table-header">
 77    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 78      <tr valign="top">
 79        <td align="left"><span class="table-header">Functions</span></td>
 80        <td align="right" valign="top"
 81         ><span class="options">[<a href="#section-Functions"
 82         class="privatelink" onclick="toggle_private();"
 83         >hide private</a>]</span></td>
 84      </tr>
 85    </table>
 86  </td>
 87</tr>
 88<tr>
 89    <td width="15%" align="right" valign="top" class="summary">
 90      <span class="summary-type">&nbsp;</span>
 91    </td><td class="summary">
 92      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 93        <tr>
 94          <td><span class="summary-sig"><a name="find_track"></a><span class="summary-sig-name">find_track</span>(<span class="summary-sig-arg">artist</span>,
 95        <span class="summary-sig-arg">title</span>,
 96        <span class="summary-sig-arg">catalog</span>)</span><br />
 97      Given an artist and title, uses v4 pyechonest to get a song object,
 98download the track and audio analysis for that song from the given 
 99catalog, and return an AudioData-type thing.</td>
100          <td align="right" valign="top">
101            <span class="codelink"><a href="echonest.cloud-pysrc.html#find_track">source&nbsp;code</a></span>
102            
103          </td>
104        </tr>
105      </table>
106      
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 href="echonest.cloud-module.html#make_track" class="summary-sig-name">make_track</a>(<span class="summary-sig-arg">s</span>,
116        <span class="summary-sig-arg">catalog</span>)</span><br />
117      Takes a song object, created by manipulating v4 pyechonest.</td>
118          <td align="right" valign="top">
119            <span class="codelink"><a href="echonest.cloud-pysrc.html#make_track">source&nbsp;code</a></span>
120            
121          </td>
122        </tr>
123      </table>
124      
125    </td>
126  </tr>
127<tr>
128    <td width="15%" align="right" valign="top" class="summary">
129      <span class="summary-type">&nbsp;</span>
130    </td><td class="summary">
131      <table width="100%" cellpadding="0" cellspacing="0" border="0">
132        <tr>
133          <td><span class="summary-sig"><a name="download"></a><span class="summary-sig-name">download</span>(<span class="summary-sig-arg">url</span>)</span><br />
134      Copy the contents of a file from a given URL to a local file in the current directory and returns the filename</td>
135          <td align="right" valign="top">
136            <span class="codelink"><a href="echonest.cloud-pysrc.html#download">source&nbsp;code</a></span>
137            
138          </td>
139        </tr>
140      </table>
141      
142    </td>
143  </tr>
144</table>
145<!-- ==================== VARIABLES ==================== -->
146<a name="section-Variables"></a>
147<table class="summary" border="1" cellpadding="3"
148       cellspacing="0" width="100%" bgcolor="white">
149<tr bgcolor="#70b0f0" class="table-header">
150  <td colspan="2" class="table-header">
151    <table border="0" cellpadding="0" cellspacing="0" width="100%">
152      <tr valign="top">
153        <td align="left"><span class="table-header">Variables</span></td>
154        <td align="right" valign="top"
155         ><span class="options">[<a href="#section-Variables"
156         class="privatelink" onclick="toggle_private();"
157         >hide private</a>]</span></td>
158      </tr>
159    </table>
160  </td>
161</tr>
162<tr>
163    <td width="15%" align="right" valign="top" class="summary">
164      <span class="summary-type">&nbsp;</span>
165    </td><td class="summary">
166        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'echonest'"><code class="variable-quote">'</code><code class="variable-string">echonest</code><code class="variable-quote">'</code></code>
167    </td>
168  </tr>
169</table>
170<!-- ==================== FUNCTION DETAILS ==================== -->
171<a name="section-FunctionDetails"></a>
172<table class="details" border="1" cellpadding="3"
173       cellspacing="0" width="100%" bgcolor="white">
174<tr bgcolor="#70b0f0" class="table-header">
175  <td colspan="2" class="table-header">
176    <table border="0" cellpadding="0" cellspacing="0" width="100%">
177      <tr valign="top">
178        <td align="left"><span class="table-header">Function Details</span></td>
179        <td align="right" valign="top"
180         ><span class="options">[<a href="#section-FunctionDetails"
181         class="privatelink" onclick="toggle_private();"
182         >hide private</a>]</span></td>
183      </tr>
184    </table>
185  </td>
186</tr>
187</table>
188<a name="make_track"></a>
189<div>
190<table class="details" border="1" cellpadding="3"
191       cellspacing="0" width="100%" bgcolor="white">
192<tr><td>
193  <table width="100%" cellpadding="0" cellspacing="0" border="0">
194  <tr valign="top"><td>
195  <h3 class="epydoc"><span class="sig"><span class="sig-name">make_track</span>(<span class="sig-arg">s</span>,
196        <span class="sig-arg">catalog</span>)</span>
197  </h3>
198  </td><td align="right" valign="top"
199    ><span class="codelink"><a href="echonest.cloud-pysrc.html#make_track">source&nbsp;code</a></span>&nbsp;
200    </td>
201  </tr></table>
202  
203  <pre class="literalblock">
204
205Takes a song object, created by manipulating v4 pyechonest.
206Downloads the audio for the song, as well as the full analysis.
207Synthesizes those into the return value, a remix AudioData object.
208
209returns None if either the audio or the analysis could not be found.
210
211Catalog specifies the audio source.
212
213</pre>
214  <dl class="fields">
215  </dl>
216</td></tr></table>
217</div>
218<br />
219<!-- ==================== NAVIGATION BAR ==================== -->
220<table class="navbar" border="0" width="100%" cellpadding="0"
221       bgcolor="#a0c0ff" cellspacing="0">
222  <tr valign="middle">
223
224  <!-- Tree link -->
225      <th>&nbsp;&nbsp;&nbsp;<a
226        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
227
228  <!-- Index link -->
229      <th>&nbsp;&nbsp;&nbsp;<a
230        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
231
232  <!-- Help link -->
233      <th>&nbsp;&nbsp;&nbsp;<a
234        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
235
236  <!-- Project homepage -->
237      <th class="navbar" align="right" width="100%">
238        <table border="0" cellpadding="0" cellspacing="0">
239          <tr><th class="navbar" align="center"
240            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
241          </tr></table></th>
242  </tr>
243</table>
244<table border="0" cellpadding="0" cellspacing="0" width="100%%">
245  <tr>
246    <td align="left" class="footer">
247    Generated by Epydoc 3.0.1 on Wed May 26 12:17:55 2010
248    </td>
249    <td align="right" class="footer">
250      <a target="mainFrame" href="http://epydoc.sourceforge.net"
251        >http://epydoc.sourceforge.net</a>
252    </td>
253  </tr>
254</table>
255
256<script type="text/javascript">
257  <!--
258  // Private objects are initially displayed (because if
259  // javascript is turned off then we want them to be
260  // visible); but by default, we want to hide them.  So hide
261  // them unless we have a cookie that says to show them.
262  checkCookie();
263  // -->
264</script>
265</body>
266</html>