blob: dba598c1ce470472bc67062ee3ff2926a3a93215 (
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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>
|
