http://your-server/rest/stream.view
Since 1.0.0
Streams a given media file.
| Parameter | Required | Default | Comment |
|---|---|---|---|
id |
Yes | A string which uniquely identifies the file to stream. Obtained by calls to getMusicDirectory. | |
maxBitRate |
No | (Since 1.2.0) 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. | |
format |
No | (Since 1.6.0) Specifies the preferred target format (e.g., "mp3" or "flv") in case there are multiple applicable transcodings. | |
timeOffset |
No | Only applicable to video streaming. If specified, start streaming at the given offset (in seconds) into the video. Typically used to implement video skipping. | |
size |
No | (Since 1.6.0) Only applicable to video streaming. Requested video size specified as WxH, for instance "640x480". | |
estimateContentLength |
No | false | (Since 1.8.0). If set to "true", the Content-Length HTTP header will be set to an estimated value for transcoded or downsampled media. |
Returns binary data on success, or an XML document on error (in which case the HTTP content type will start with "text/xml").