Create or update a transcoding template

Updated

Creates or updates a transcoding template.

POST
https://api.sd-rtn.com/v1/projects/{appId}/rtls/abr/config/codecs/{codecId}

Create or update a transcoding template under the specified App ID.

Path Parameters

appIdstring
Required

The App ID of the project

codecIdstring
Required

The ID of the transcoding template.

Header Parameters

Content-Typestring
Required

The request content type. Use application/json.

Request Body

application/json

enabledboolean
Required

Whether to enable this transcoding template:

  • true: Enable the template
  • false: Do not enable the template
videoobject
Required
widthnumber
Required

Maximum value: 1920

The width of the transcoded output video (px).

heightnumber
Required

Maximum value: 1920

The height of the transcoded output video (px).

fpsnumber
Required

Maximum value: 60

The frame rate (fps) of the transcoded output video.

Response

  • If the returned status code is 200, the request was successful. The response body contains the result of the request.

  • If the returned status code is not 200, the request failed. The response body includes the detail and reason for failure. Refer to status codes to understand the possible reasons for failure.

Response Body

The request succeeded.

statusstring

The status of the request.

Status of this request:

  • success: The request was successful.
  • error: The request failed.

Response example

{
      "status": "Status of this request:\n- `success`: Request was successful.\n- `error`: Request failed.\n"
    }

Authorization

This endpoint requires authentication.

basicAuth

Request examples

curl --request post \      --url https://api.sd-rtn.com/v1/projects/:appId/rtls/abr/config/codecs/:codecId \      --header 'Authorization: Basic <credentials>' \      --header 'Content-Type: <string>'

Response example

{  "status": "success"}