Enable Live Room (iOS)

Last updated: 2021-01-04 15:05:18


    TUIKit 5.0.10 and later versions provide the TUIKit_live UI component, which supports the livestreaming feature based on Tencent Real-Time Communication (TRTC).

    After importing TUIKit to your project, you can quickly enable the livestreaming feature in several simple steps. If you have not imported TUIKit, import it using the pods method in Step 2: Import TUIKit. In this way, the TUIKit_live UI component is imported by default.

    Step 1: Enable the TRTC Service

    1. Log in to the IM console and click the target application card to go to the basic configuration page of the application.
    2. Click Activate under Activate Tencent Real-Time Communication (TRTC).
    3. Click Confirm in the dialog box that appears.


      A TRTC application with the same SDKAppID as the IM application is created in the TRTC console. You can use the same account and authentication information for IM and TRTC.

    Step 2: Initialize and Log In to TUIKit

    Import the SDKAppID generated in Step 1 to initialize TUIKit and call the login API to log in to TUIKit. For more information on how to generate UserSig, see UserSig.

    [[TUIKit sharedInstance] setupWithAppId:SDKAppID];
    [[TUIKit sharedInstance] login:@"userID" userSig:@"userSig" succ:^{
         NSLog(@"-----> login successful");
    } fail:^(int code, NSString *msg) {
         NSLog(@"-----> login failed");

    Step 3: Start Livestreaming at the Anchor End

    Create an anchor. To start livestreaming at the anchor end, create TUILiveRoomAnchorViewController and set a unique roomid.

    #import "TUIKitLive.h"
    /// roomId: 123456. A viewer needs to set the same roomid as that at the anchor end to view the anchor's livestream. The roomid used here is only an example. The actual value must be unique.
    TUILiveRoomAnchorViewController *anchorVC = 
    [[TUILiveRoomAnchorViewController alloc] initWithRoomId:123456];
    /// Callback for receiving successful anchor creation/exit
    anchorVC.delegate =  self ; 
    [anchorVC eanblePK: NO];
    /// push/present displays viewController on the anchor page.
    [self.navigationController pushViewController:anchorVC animated: YES];

    Step 4: View Livestreams at the Viewer End

    Create a viewer. To view an anchor's livestream, create TUILiveRoomAudienceViewController and set the same roomid as that at the anchor end.

    #import "TUIKitLive.h"
    /// Initialize the viewer page and set the same roomId as that at the anchor end to view the anchor's livestream.
    // Set useCDN to NO. If you need CDN for playback, refer to the following section.
    /// anchorId is the userId of the anchor in the live room. It is optional. However, we recommend that you set it.
    /// cdnUrl is the CDN playback address, for example, http://[playback domain name]/live/[sdkappid]_[roomId]_[userID]_main.flv.
    TUILiveRoomAudienceViewController *audienceVC =
    [[TUILiveRoomAudienceViewController alloc] initWithRoomId:123456
    /// push/present displays viewController on the viewer page based on project requirements.
    [self.navigationController pushViewController:anchorVC animated: YES];

    Step 5: Generate a Live Room List

    After you create an anchor and a viewer, a live room list is required to associate them.

    • After the anchor creates a room, record the room ID to the backend.
    • After the anchor terminates the room, the backend also terminates the room ID.
    • The viewer gets the room ID list from the backend and clicks it to enter the corresponding room.

    Room lists can vary, and we do not provide an example of how to build a room list at the backend. You can see TUILiveRoomManager in the demo to implement the logic by which the client reports the room creation result.

    1. After the anchor is created, livestreaming enabled or disabled information is reported in the callback function at the anchor end.
    #pragma mark  - TUILiveRoomAnchorDelegate**
    /// Callback for successful room creation
    - (void)onRoomCreate:(TRTCLiveRoomInfo *roomInfo) {
        NSSTring *roomId = roomInfo.roomId;
        /// Reports successful live room creation
        [TUILiveRoomManager.sharedManager createRoom:sdkAppId 
    /// Callback for exiting/stopping livestreaming
    - (void)onRoomDestroy:(TRTCLiveRoomInfo *roomInfo) {
        NSSTring *roomId = roomInfo.roomId;
        /// Reports live room termination
      [TUILiveRoomManager.sharedManager destroyRoom:sdkAppId 
    1. Create the live room list page UI.
      The live room list page displays livestreams. For more information on the implementation, see TUILiveRoomListViewController implementation in the demo.
    2. Click a room to view.
      On the live room list page, click a room. Create a viewer by referring to Step 4: View Livestreams at the Viewer End to view livestreams.

    Step 6: Use LVB CDN to View Livestreams

    When TUILiveRoomAudienceViewController is created at the viewer end, TRTC is used to view livestreams by default if useCdn is set to NO, and CDN is used to view livestreams if useCdn is set to YES.

    TRTC uses UDP to transmit audio and video data, and standard LVB CDN uses RTMP, HLS, FLV, or other protocols to transmit data. TRTC provides a shorter delay and smoother microphone on/off experience than LVB CDN. However, TRTC is more expensive than LVB CDN.

    If you do not have high delay requirements, use CDN to view livestreams to reduce costs.


    You have activated Tencent Cloud LVB. You need to configure a playback domain name for livestream playback according to the requirements of applicable authorities. For more information, see Adding Domain Name.

    Enabling relayed push

    1. Log in to the TRTC console.
    2. Select Application Management on the left sidebar and click Feature Configuration in the row of the target application.
    3. In Relayed Push Configuration, click to the right of Enable Relayed Push. In the Enable Relayed Push dialog box that appears, click Confirm to enable the feature.

    Configuring a playback domain name

    1. Log in to the LVB console.
    2. Click Add Domain Name, enter a playback domain name, select Playback domain name as the domain name type, select an acceleration region (which is Mainland China by default), and click OK.

    Entering the playback URL when a viewer enters the room

    After you enable relayed push, the anchor end automatically pushes livestreams to the cloud. When a viewer views the livestreams, you need to enter the URL from LVB CDN.

    /// eg: If you configure a playback domain name and set the domain name to my.com in CNAME, the default playback URL is http://[playback domain name]/live/[sdkappid]_[roomId]_[userID]_main.flv.
    TUILiveRoomAudienceViewController *audienceVC = 
    [[TUILiveRoomAudienceViewController alloc] initWithRoomId:123456 
                               cdnUrl:@"http://[playback domain name]/live/[sdkAppId]_[roomId]_[userId]_main.flv"];


    For more information on TRTC relayed livestreaming, see CDN Relayed Livestreaming and On-Cloud MixTranscoding.


    What can I do if no image is displayed after the anchor enables livestreaming?

    Livestreaming requires a camera and microphone. You need to apply for camera and microphone use permissions from users.
    Use Xcode to open your project. Click the project file, select the target, click the Info page, and add NSCameraUsageDescription and NSMicrophoneUsageDescription.

    After the project runs in your mobile phone, choose Settings > Privacy > Camera and Microphone and assign permissions to the application.

    How can I customize gifts?

    The TUIKit_live SDK allows users to customize gifts. To modify the gift content or source, modify the server request address or logic in the TUILiveDefaultGiftAdapterImp.m file of TUIKit_live. Ensure that the returned data has the same format as the existing data.

    //eg data format. Complete reference link: https://liteav-test-1252463788.cos.ap-guangzhou.myqcloud.com/gift_data.json. The JSON character string content is as follows:
      "giftList": [
          "giftId": "1", // Gift ID. Each gift has a unique ID.
          "giftImageUrl": "https://8.url.cn/huayang/resource/now/new_gift/1590482989_25.png", // Image displayed on the gift panel
          "lottieUrl": "https://assets5.lottiefiles.com/packages/lf20_t9v3tO.json", // Large gift animation file
          "price": 2989, // Price of a virtual gift
          "title": "rocket", // Gift title
          "type": 1 // Gift type. 1: large gift, displayed in full screen mode. 2: small gift, dynamically displayed on the top of the message list
          "giftId": "2",
          "giftImageUrl": "https://8.url.cn/huayang/resource/now/new_gift/1507876726_3",
          "lottieUrl": "",
          "price": 298,
          "title": "egg",
          "type": 0

    How do I implement PK?

    To implement the PK feature, perform the following steps:

    1. Enable PK when TUILiveRoomAnchorViewController is created at the anchor end.
    TUILiveRoomAnchorViewController *anchorVC = 
    [[TUILiveRoomAnchorViewController alloc] initWithRoomId:123456];
    anchorVC.delegate = self;
    /// Enable PK.
    [anchorVC eanblePK: YES];
    1. Set PK list data in the getPKRoomIDList: callback of TUILiveRoomAnchorViewController at the anchor end.
    - (void)getPKRoomIDList:(TUILiveOnRoomListCallback)callback {
        /// If your room requires the PK feature, return the anchor's room ID array that supports PK through callback in this callback function.
           callback(@[@"12345", @"123456"]);

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback