diff options
| author | Scott Jackson <daneren2005@gmail.com> | 2012-07-02 21:24:02 -0700 |
|---|---|---|
| committer | Scott Jackson <daneren2005@gmail.com> | 2012-07-02 21:24:02 -0700 |
| commit | a1a18f77a50804e0127dfa4b0f5240c49c541184 (patch) | |
| tree | 19a38880afe505beddb5590379a8134d7730a277 /subsonic-site/src/main/webapp/api-stream.jsp | |
| parent | b61d787706979e7e20f4c3c4f93c1f129d92273f (diff) | |
| download | dsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.tar.gz dsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.tar.bz2 dsub-a1a18f77a50804e0127dfa4b0f5240c49c541184.zip | |
Initial Commit
Diffstat (limited to 'subsonic-site/src/main/webapp/api-stream.jsp')
| -rw-r--r-- | subsonic-site/src/main/webapp/api-stream.jsp | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/subsonic-site/src/main/webapp/api-stream.jsp b/subsonic-site/src/main/webapp/api-stream.jsp new file mode 100644 index 00000000..dba598c1 --- /dev/null +++ b/subsonic-site/src/main/webapp/api-stream.jsp @@ -0,0 +1,59 @@ +<h2 class="div"><a name="stream"></a>stream</h2>
+
+<p>
+ <code>http://your-server/rest/stream.view</code>
+ <br>Since <a href="#versions">1.0.0</a>
+</p>
+
+<p>
+ Streams a given media file.
+</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 stream. Obtained by calls to getMusicDirectory.</td>
+ </tr>
+ <tr>
+ <td><code>maxBitRate</code></td>
+ <td>No</td>
+ <td></td>
+ <td>(Since <a href="#versions">1.2.0</a>) If specified, the server will attempt to limit the bitrate
+ to this value, in kilobits per second. If set to zero, no limit is imposed.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>format</code></td>
+ <td>No</td>
+ <td></td>
+ <td>(Since <a href="#versions">1.6.0</a>) Specifies the preferred target format (e.g., "mp3" or "flv") in case there are multiple applicable transcodings.</td>
+ </tr>
+ <tr>
+ <td><code>timeOffset</code></td>
+ <td>No</td>
+ <td></td>
+ <td>Only applicable to video streaming. If specified, start streaming at the given offset (in seconds) into the video.
+ Typically used to implement video skipping.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>size</code></td>
+ <td>No</td>
+ <td></td>
+ <td>(Since <a href="#versions">1.6.0</a>) Only applicable to video streaming. Requested video size specified as WxH, for instance "640x480".</td>
+ </tr>
+ <tr>
+ <td><code>estimateContentLength</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>(Since <a href="#versions">1.8.0</a>). If set to "true", the <em>Content-Length</em> HTTP header will be set to an estimated value
+ for transcoded or downsampled media.</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>
|