aboutsummaryrefslogtreecommitdiff
path: root/subsonic-site/src/main/webapp/api-download.jsp
blob: 63b55a00771040a93d406b5ac6c1876bfeb50e51 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<h2 class="div"><a name="download"></a>download</h2>

<p>
    <code>http://your-server/rest/download.view</code>
    <br>Since <a href="#versions">1.0.0</a>
</p>

<p>
    Downloads a given media file. Similar to <code>stream</code>, but this method returns the original media data
    without transcoding or downsampling.
</p>
<table width="100%" class="bottomspace">
    <tr>
        <th class="param-heading">Parameter</th>
        <th class="param-heading">Required</th>
        <th class="param-heading">Default</th>
        <th class="param-heading">Comment</th>
    </tr>
    <tr class="table-altrow">
        <td><code>id</code></td>
        <td>Yes</td>
        <td></td>
        <td>A string which uniquely identifies the file to download. Obtained by calls to getMusicDirectory.</td>
    </tr>
</table>
<p>
    Returns binary data on success, or an XML document on error (in which case the HTTP content type will start with "text/xml").
</p>