Function Configuration

Last updated: 2021-10-19 15:50:47

    After creating an application, you can enable relayed push, on-cloud recording, and advanced permission control for it in Function Configuration. The configuration takes effect in about 5 minutes.

    Relayed Push

    Notes

    • The process of TRTC converting UDP-based audio/video streams and pushing them to the CSS system is known as “relayed push”.
    • Relayed push is disabled by default. To enable the feature, you need to activate the CSS service first.
    • If you use relayed push to implement CDN relayed live streaming, CSS will charge you based on the downstream traffic generated or bandwidth used. For details, see CSS > Bill-by-Traffic/Bandwidth.
    • If you use relayed push for on-cloud recording, you will be charged for recording streams and storing the recording files. For details, see On-Cloud Recording and Playback > Billing.
    • If you bind templates of paid features such as recording, transcoding, screencapturing & porn detection, and watermarking to the domain name (xxxx.livepush.myqcloud.com) used for relayed push in the CSS console, you will be charged value-added fees.

    Enabling relayed push

    1. Log in to the TRTC console and click Application Management.
    2. Click Function Configuration for the application whose configuration you want to modify.
    3. In Relayed Push Configuration, click the button next to Enable Relayed Push.
    4. In the dialog box that pops up, read the risk statement carefully; if you are sure you want to enable the feature, check the box and click Enable Relayed Push.

    Choosing relayed push mode

    After enabling relayed push, you can choose the relayed push mode that fits your needs.

    • Specified stream for relayed push: After selecting this mode, if you do not need the On-Cloud MixTranscoding service, call the client-side SDK API startPublishing to start relayed push; if you need the service, follow the steps in On-Cloud MixTranscoding, and relayed push will start automatically after On-Cloud MixTranscoding.
    • Global auto-relayed push: After you select this mode, all upstream audio/video streams of TRTC are automatically pushed to the CSS system.

    Disabling relayed push

    To disable relayed push, follow these steps:

    1. Click Application Management, and click Function Configuration for the application whose configuration you want to modify.
    2. In Relayed Push Configuration, click the button next to Enable Relayed Push.
    3. In the dialog box that pops up, read the risk statement carefully; if you are sure you want to disable the feature, check the box and click Disable Relayed Push.

    On-Cloud Recording

    Notes

    • The relayed push feature of TRTC leverages the on-cloud recording capability of CSS to record entire live streaming sessions and store the recording files in VOD.
    • The recording feature is based on CSS, which charges you by the peak number of concurrent recording channels in a month. For details, see CSS > CSS Recording Billing.
    • Recording files are stored in VOD, which charges you based on the storage space used. For details, see VOD > Pay-as-You-Go.
    • If you play or download a recording file, you will be charged a traffic (video acceleration) fee based on the amount of downstream traffic accelerated. For details, see VOD > Pay-as-You-Go.
    • On-cloud recording is disabled by default. To enable the feature, you need to activate CSS and VOD first.
    • On-cloud recording relies on relayed push, which you need to enable first.

    Enabling on-cloud recording

    The on-cloud recording feature of TRTC allows you to record the audio/video streams of each user as a separate file. To enable the feature, follow the steps in On-Cloud Recording and Playback.

    Modifying on-cloud recording configuration

    Note:

    Modifying on-cloud recording configuration may affect your active business. Make sure you understand the risks before the modification.

    1. Click Application Management, and click Function Configuration for the application whose configuration you want to modify.
    2. In On-Cloud Recording Configuration, click Edit to go to the edit page.
    3. Modify the configuration information as needed, and click Confirm to save the modification.

    Disabling on-cloud recording

    After you disable on-cloud recording, your active business will be unable to record streams on the cloud, whether manually or automatically. Please make sure that your business no longer needs the feature before disabling it.

    1. Click Application Management, and click Function Configuration for the application whose configuration you want to modify.
    2. In On-Cloud Recording Configuration, click the button next to Enable On-Cloud Recording.
    3. If you are sure about disabling the feature after reading the risks, click Disable On-Cloud Recording.

    Advanced Permission Control

    You may consider enabling advanced permission control if you want to control room entry and mic-on permissions (i.e., allowing only specific users to enter a room or use their mics), but are worried that giving permissions on the client makes the service vulnerable to attacks and cracking.

    Notes

    After you enable advanced permission control for an SDKAppID, all users using the SDKAppID must pass the correct privateMapKey in TRTCParams to enter a room. Therefore, you are not advised to enable the feature if a user is using the SDKAppID.

    Enabling advanced permission control

    1. Click Application Management, select the application for which you want to enable advanced permission control, and click Function Configuration.
    2. In Function Configuration > Advanced Permission Control, click the button next to Enable.

    Disabling advanced permission control

    1. Click Application Management, select the application for which you want to disable advanced permission control, and click Function Configuration.
    2. In Function Configuration > Advanced Permission Control, click the button next to Enable.

    Documentation

    • To create an application, see Creating Application.
    • To search for an application in the application list, see Searching Application.
    • To view the basic information of an application, see Application Info.
    • If you want to set an image as the background displayed during on-cloud stream mixing, you can add the image in Material Management. For details, see Material Management.
    • To get the demo source code for a quick start, see Quick Start.