You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This section summarizes the basic considerations for using the RESTful API:
Please make sure that the Agora channel profile is live broadcasting.
In case of request errors, make sure to print the values of the X-Request-ID and X-Resource-ID fields in the response header for troubleshooting.
As explained in the name description, you should use the name parameter if only one Converter is needed in a channel.
Set the region parameter to the region associated with the CDN source, as explained in the region parameter description.
If the Converter is automatically destroyed due to a service failure or other reasons, Agora recommends that you create a new Converter.
If the CDN side's pulling stream is abnormal after creating a Converter, Agora recommends that you delete the Converter and create a new one.
When updating the same Converter multiple times, ensure that the sequence value is incremented, as explained in the sequence parameter description.
Agora does not support performing both transcoding and non-transcoding live streaming in the same Converter. To use a different streaming mode, create a new Converter and configure it accordingly.
In non-transcoding mode, the Converter can only forward video streams with RTMP, not transcode video streams. To ensure that CDN audiences can watch the video, use video codec formats that comply with the RTMP standard protocol, such as H.264 or H.265. If the video codec format at the streaming end is VP8, use the Converter's transcoding mode.
Agora recommends that you use the default values when setting the video resolution, frame rate, and bitrate of the output transcoded stream. You can also refer to the following table to set the values. If you set a bitrate beyond a reasonable range, the Agora server automatically adjusts the bitrate to stay within a reasonable range.
Resolution
Frame rate (fps)
Bitrate (Kbps)
160 × 120
15
130
120 × 120
15
100
320 × 180
15
280
180 × 180
15
200
240 × 180
15
240
320 × 240
15
400
240 × 240
15
280
424 × 240
15
440
640 × 360
15
800
360 × 360
15
520
640 × 360
30
1200
360 × 360
30
800
480 × 360
15
640
480 × 360
30
980
640 × 480
15
1000
480 × 480
15
800
640 × 480
30
1500
480 × 480
30
1200
848 × 480
15
1220
848 × 480
30
1860
640 × 480
10
800
1280 × 720
15
2260
1280 × 720
30
3420
960 × 720
15
1820
960 × 720
30
2760
The text was updated successfully, but these errors were encountered:
https://docs.agora.io/en/media-push/develop/restful-api
Considerations
This section summarizes the basic considerations for using the RESTful API:
X-Request-ID
andX-Resource-ID
fields in the response header for troubleshooting.region
parameter to the region associated with the CDN source, as explained in theregion
parameter description.sequence
value is incremented, as explained in thesequence
parameter description.For more integration recommendations, see Integration Best Practices.
Commonly used video profile
Agora recommends that you use the default values when setting the video resolution, frame rate, and bitrate of the output transcoded stream. You can also refer to the following table to set the values. If you set a bitrate beyond a reasonable range, the Agora server automatically adjusts the bitrate to stay within a reasonable range.
The text was updated successfully, but these errors were encountered: