Skip to main content
Conversational AI Engine: Create advanced voice apps by combining Agora's real-time audio with powerful conversational AI.

Query transcoding templates

Query transcoding templates

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

Query all transcoding template configurations under the specified App ID

Request​

Path parameters​

appid stringrequired

The App ID of the project

Response​

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

    OK
    • status string

      Status of the request.

      • success: The request was successful.
      • error: The request failed
    • data object
      Show propertiesHide properties
      • enabled boolean

        Whether to enable the multi-bitrate function on the viewer side.

        • true: Enable
        • false: Disable
      • codecs array
        Show propertiesHide properties
        • id string

          The ID of the transcoding template.

        • enabled boolean

          Whether to enable this transcoding template:

          • true: Enable the template.
          • false: Do not enable this template.
        • Video object
          Show propertiesHide properties
          • width number

            The width of the transcoded output video (px).

          • height number

            The height of the transcoded output video (px).

          • fps number

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

  • 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.

    OK
    • status string

      Status of the request.

      • success: The request was successful.
      • error: The request failed
    • data object
      Show propertiesHide properties
      • enabled boolean

        Whether to enable the multi-bitrate function on the viewer side.

        • true: Enable
        • false: Disable
      • codecs array
        Show propertiesHide properties
        • id string

          The ID of the transcoding template.

        • enabled boolean

          Whether to enable this transcoding template:

          • true: Enable the template.
          • false: Do not enable this template.
        • Video object
          Show propertiesHide properties
          • width number

            The width of the transcoded output video (px).

          • height number

            The height of the transcoded output video (px).

          • fps number

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

    • message string

      Describes why the request failed.

Authorization

This endpoint requires Basic Auth.

Request example


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

Response example


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