getTranscodeDecision

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getTranscodeDecision

Returns a transcode decision for a given media file. This endpoint is used by clients to determine if a media file should be transcoded before streaming. The server will analyze the provided client information and return a decision. This endpoint must be accessed using a POST request

Parameters

Parameter	Req.	OpenS.	Default	Comment
`mediaId`	Yes			The ID of the media to be transcoded.
`mediaType`	Yes			Either song or podcast so the server knows what the mediaId is referring to.

Request Body

The request body must be a JSON object containing the client’s capabilities. See the ClientInfo documentation for more details.

getTranscodeStream

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getTranscodeStream

Returns a transcoded media stream. Note: Clients should not try to reconstruct the transcodeParams. Instead, they must use the transcodeParams provided in the response of the getTranscodeDecision endpoint.

Parameters

Parameter	Req.	Default	Comment
`mediaId`	Yes		The ID of the media to be transcoded.
`mediaType`	Yes		Either song or podcast so the server knows what the mediaId is referring to.
`offset`	No	0	The time offset in seconds from which to start transcoding.
`transcodeParams`	Yes		Server-specific transcoding parameters, obtained from the property `transcodeParams` of the result of the endpoint `getTranscodeDecision`. The value is unique and already properly escaped.

Example

http://your-server/rest/getTranscodeStream.view?mediaIdId=123&mediaType=song&offset=0&parameters=...&u=demo&p=demo&v=1.16.1&c=AwesomeClientName&f=json

Result

The raw transcoded media stream. In case of an error, a standard HTTP error code is returned with a descriptive message.

Transcoding on OpenSubsonic

getTranscodeDecision

Parameters

Request Body

getTranscodeStream

Parameters

Example

Result