Function Configuration

Last updated: 2023-10-11 20:17:47Download PDF
After an application is created, you can enable the Relay to CDN, On-Cloud Recording, and advanced rights control functions for your application through function configuration. The modification takes effect about 5 minutes after the modification.

Relay to CDN


TRTC service based on UDP transport protocol connects audio and video streams to CSS through protocol conversion, which is called "Relay to CDN".
The Relay to CDN is disabled by default. CSS must be enabled before the Relay to CDN function is enabled.
When Relay to CDN is used for CDN live viewing, CSS will charge related fees based on the downstream traffic/bandwidth generated by live viewing. For details, see CSS > Traffic Bandwidth Charging Description.
You can use Relay to CDN to push audio and video to CSS. If you use the recording capability of CSS to complete the recording, recording and file storage fees will be incurred. For details, see Cloud Recording and Playback > Related Fees.
If you live in a console to Relay to CDN forward domain name ( binding the recording, transcoding, pornographic identification, watermark, such as charging function template, the Relay to CDN would produce the template corresponding value added cost.

Enable the Relay to CDN function

1. Entering TRTC console, select Application Management in the lower right corner.
2. Select the application whose function configuration you want to modify and click Manage.

3. In the Relay to CDN configuration, click the global relay.

4. In the dialog box that is displayed, read the risk description carefully. If yes, click to enable the Relay to CDN.

Switch the Relay to CDN domain name

1. Your current default domain name called, and support to switch your domain name in CSS console. If you need to switch other domain names, please first go to the CSS console for binding.
After the default domain name is changed, the recording template, callback template, yellow authentication template, and watermark template bound to the current domain name will become invalid. Bind these templates to the new domain name and then complete the switchover. After the domain name switchover takes effect, the audio and video generated in the new room will be pushed based on the new domain name.
2. Go to the TRTC Console > Application Management, select the application whose domain name you want to switch, click Manage to go to the details page, click All configurations, and click Switch in Relay to CDN to switch the Relay to CDN domain name.

Disable Relay to CDN

To disable the Relay to CDN, perform the following steps:
1. Click Application Management, Select the application whose function configuration you want to modify and click Manage.
2. Click View all configuration. In the Relay to CDN configuration, click the button on the right of the Global auto relay.

3. In the disable global auto relay dialog box that is displayed, read the risk description carefully. If yes, click Confirm.

On-Cloud Recording Configuration


The On-Cloud Recording function uses the TRTC capabilities. The recording fee is charged by the TRTC side. For details about the charging rules, see the Cloud Recording Charging Description.
If a recorded file is stored on a VOD platform, the storage fee is charged based on the storage capacity of the recorded file. For details about the charging rules, see VOD video storage (daily settlement) price description or VOD video storage resource package price description.
If a recorded video file needs to be played or downloaded, the VOD service charges for video acceleration. The charges are based on downstream accelerated traffic. For details about the charging rules, see VOD Video Acceleration (daily settlement) price description or VOD video acceleration resource pack price description.
The On-Cloud Recording function is disabled by default. To enable the cloud recording function, you need to enable CSS and VOD first.

Global Auto-Recording

On-Cloud Recording provides an automatic recording method that does not require manual initiation and management of recording tasks. To use this method, you need to configure a global automatic recording template and enable global automatic recording. You do not need to develop or control the initiation and termination of recording tasks. Enable Global Automatic recording. After it takes effect for 5 to 10 minutes, the recording task will be started when the streamers in the TRTC room uplink the audio and video, and the recording task will be stopped when the streamers in the room check out and exceed the set waiting time. Before using the cloud recording function, please go to the console Application List Management > View All configurations to enable cloud recording, as shown below:

On-Cloud Recording supports recording the audio and video of each anchor in the room into an independent file (single-stream recording), and also supports mixing the audio and video of multiple anchors in the room into a file (mixed-stream recording). You can select the single stream and confluence modes for recording at the same time, and it is only valid for newly created rooms after being opened. This function does not take effect for rooms created before automatic recording is enabled. For a detailed implementation, see Achieve cloud recording and playback.
Global Single-Stream Recording
Global single-stream recording format supports audio and video recording, audio recording, video recording, recording files support MP4, HLS and AAC (audio recording format), for details about the recording file slicing policy, see Record file segmentation description.
Recording Mode
single-stream recording: The video footage of each anchor in the room is saved to a separate file.
mixed-stream recording: The video footage of all the anchors in the room is mixed into one file for recording.
Recording Format
Audio and video format: Record audio and video streams in the room, suitable for video calls and interactive live broadcast scenarios.
Audio only format: Record only the audio streams in the room.
File Format
Support MP4, HLS and AAC (audio only format).
Recording Duration of A Single File
The value which can be used to specify the recording slicing duration ranges from 1 minute to 1440 minutes. The default value is 1440 minutes.
The Duration of The Continuative Wait
If the interruption interval does not exceed the specified timeout period, only one file is generated for a call (or live broadcast), but the recorded file can be received only after the timeout period expires. The value ranges from 5 to 86400, in seconds. (Audio fee will be charged during the continuation period, please set the duration of the continuation reasonably.)
Notice: In mixed-stream mode, black frames and silent frames continue to be recorded during the waiting period. In single-stream mode, black frames are not recorded. During the continuation waiting period, single-stream and mixed-stream recordings are charged for the duration of the audio.
Recorded file storage
Supports storage to VOD
VOD: Supports the specified VOD application, the storage time of recorded files in the VOD, and the binding of the VOD task flow.
In single-stream recording mode, the audio and video streams in the room will be recorded separately according to the push parameters, without the need to set transcoding.
The recording robot will continue to wait for the anchor to go up in the room to complete the recording, and it will not end immediately after the anchor checks out. Please set it properly.

Single stream recording can record a maximum of 25 anchors in a room. If more than 25 anchors are recorded, the first 25 anchors will be recorded according to the check-in time. (If you need to record more than 25 anchors in a single stream, see API Manual recording.)
The default waiting time for continuation is 5s. If the time without anchor in the room exceeds the set continuation time, it will be divided into multiple recording tasks, and the corresponding recording files are also independent. If the time without anchor in the room does not exceed the continuation time, the recording tasks will be maintained and the recording files will not be split.
Global Mixed-Stream Recording
In mixed-stream recording mode, you need to set additional video transcoding parameters, audio transcoding parameters and mixed-stream layout parameters of the automatic recording process to control the output specifications of the recorded file. The following table describes the parameters for global mixed-stream audio and video transcoding
Video resolution
The video width and height are limited to [16,2560], and the video width * video height cannot exceed 2560 * 1440, the default video width is 640px, and the video height is 480px
Video bit rate
The video bitrate is limited to [64, 8192] and the default is 550kbps
Video frame rate
Video frame rate is limited to [1,60] and the default is 15fps
Video GOP
GOP is limited to [1,10] and defaults to 10s
Audio sampling rate
Supports 48000, 44100, and 16000Hz
Audio bit rate
The audio bit rate is limited to [32, 128] and the default is 64kbps
Audio channel
Supports single and dual channels
You can set prefabricated layout templates for global mixed-stream recording:
Grid layout: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed.
Screen sharing layout: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 24 videos can be displayed. A user who publishes only audio will still be displayed in one window.
Floating layout: By default, the video of the first anchor in the room (you can also specify an anchor) is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and float over the large video from left to right starting from the bottom of the canvas. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.
Screen sharing layout and floating layout need to specify large screen user rules (the room needs to be laid out as a large screen anchor user ID prefix):
If the anchor ID in the room is not matched according to the prefix, the reserved layout will be left out for the screen sharing layout, and the floating layout will be arranged according to the anchor who entered the room the earliest.
If there are multiple anchor ids in the room, the layout of the anchor with the earliest check-in time will be followed.
Mixed-stream recording number: The number of people mixing under automatic recording is limited to 2-8 people, and the default is 2 people.

Manually Customize the Recording

If you only need to use certain rooms to initiate recording tasks, you can do so manually through CreateCloudRecording.

Disable the On-Cloud Recording

After the on-cloud recording function is enabled, 「Manual Custom Recording」 is enabled by default and cannot be disabled. 「Manual Custom Recording」 generates recording usage based on your initiation. If you only need to use 「Manual Custom Recording」, disable 「Global Automatic Recording」.

Recording File Management

After recording, you can view the recorded file on the VOD audio and video management interface. We will upload the file to the storage location you specify, and you will be able to view it once the upload is complete.
By filtering the VOD applications that you specify, you can view the corresponding recording result files.

By clicking a file name, you can view detailed file information, including preview videos, obtain file urls, and download files.
Depending on the size of the recorded file, the upload time may be delayed by 30 seconds to several minutes. You can subscribe to the recording callback event to obtain the successful upload time of the file.

Advanced Permission Control

If you want to add room access restrictions or access restrictions to some rooms, that is, only allow specified users to enter the room or access the microphone, and you are worried that the client judge the permission is easy to encounter cracking attacks, then you can consider enabling advanced permission control.


After advanced permission control is enabled, all users of the current SDKAppID need to pass the privateMapKey parameter correctly in TRTCParams in order to successfully enter the room. If there is a user using this SDKAppID online, do not enable this feature.

Enable advanced permission control

1. Click Application Management, select the application for which advanced permission control is to be enabled, and click manage in the row where the target application resides.
2. In Advanced Permission Control, click the Enable Advanced Permission Control button on the right.

Disable advanced permission control

1. Click Application Management, select the application for which advanced permission control is to be enabled, and click manage in the row where the target application resides.
2. In Advanced Permission Control, click the Enable Advanced Permission Control button on the right until it becomes closed.

Related Document

To create an application, see Creating an Application.
To view the basic information about an application, see Application Information.