Query transcoding templates

Updated

Queries transcoding template configurations under a specified App ID.

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

Query all transcoding template configurations under the specified App ID

Path Parameters

appId#*string

The App ID of the project

Header Parameters

Content-Type#*string

The request content type. Use application/json.

Allowedapplication/json

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

application/json

application/json

Response schema

200application/json

The request succeeded and returned template data.

status#optionalstring

The status of the request.

Status of the request.

  • success: The request was successful.
  • error: The request failed
Allowedsuccess | error
data#optionalobject
defaultapplication/json

The request failed.

message#optionalstring

Describes why the request failed.

status#optionalstring

The status of the request.

Status of this request:

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

Response example

{
      "status": "The status of this request:\n- `success`: The request succeeded.\n- `error`: The request failed.\n",
      "data": {
        "enabled": true,
        "codecs": [
          {
            "id": "The ID of the transcoding template.",
            "enabled": true,
            "video": {
              "width": 0,
              "height": 0,
              "fps": 0
            }
          }
        ]
      }
    }

Authorization

This endpoint requires authentication.

basicAuth

Request examples

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

Response example

{  "status": "success",  "data": {    "enabled": true,    "codecs": [      {        "id": "The ID of the transcoding template.",        "enabled": true,        "video": {          "width": 0,          "height": 0,          "fps": 0        }      }    ]  }}
{  "status": "error",  "message": "Description of the reason for the request failure."}