tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation

    TRTCLiveRoom APIs (Flutter)

    Last updated: 2024-01-10 17:16:49
      TRTCLiveRoom is based on Tencent Real-Time Communication (TRTC) and Tencent Cloud Chat. With TRTCLiveRoom:
      A user can create a room and start live streaming, or enter a room as an audience member.
      The anchor can co-anchor with audience members in the room.
      Anchors in two rooms can compete and interact with each other.
      All users can send text and custom messages. Custom messages can be used to send on-screen comments, give likes, and send gifts.
      Note
      All TUIKit components are based on two basic PaaS services of Tencent Cloud, namely TRTC and Chat. When you activate TRTC, the Chat SDK trial edition (which supports up to 100 DAUs) will be activated automatically. For Chat billing details, see Pricing.
      TRTCLiveRoom is an open-source class depending on two closed-source Tencent Cloud SDKs. For the specific implementation process, see Interactive Live Video Streaming (Flutter).
      The TRTC SDK is used as a low-latency live streaming component.
      The AVChatRoom feature of the Chat SDK is used to implement chat rooms, and Chat messages are used to facilitate the co-anchoring process.
      

      TRTCLiveRoom API Overview

      Basic SDK APIs

      API
      Description
      Gets a singleton object.
      Terminates a singleton object.
      Registers an event listener.
      Removes an event listener.
      Logs in.
      Logs out.
      Sets profile.

      Room APIs

      API
      Description
      Creates a room (called by anchor). If the room does not exist, the system will automatically create a room.
      Closes a room (called by anchor).
      Enters a room (called by audience).
      Exits a room (called by audience).
      Gets room list details.
      Gets the anchor and co-anchors in a room. This API works only if it is called after enterRoom().
      Gets the list of all users in a room. This API works only if it is called after enterRoom().

      Stream pushing/pulling APIs

      API
      Description
      Enables preview of the local video.
      Stops local video capturing and preview.
      Starts live streaming (pushing streams).
      Stops live streaming (pushing streams).
      Plays a remote video. This API can be called in common playback and co-anchoring scenarios.
      Stops rendering a remote video.

      APIs for anchor-audience co-anchoring

      API
      Description
      Requests co-anchoring (called by audience).
      Responds to a co-anchoring request (called by anchor).
      Removes a user from co-anchoring (called by anchor).

      APIs for cross-room anchor communication

      API
      Description
      Sends a cross-room communication request (called by anchor).
      Responds to a cross-room communication request (called by anchor).
      Quits cross-room communication.

      Audio/Video APIs

      API
      Description
      Switches between the front and rear cameras.
      Sets the mirror mode.
      Mutes/Unmutes the local user.
      Mutes/Unmutes a remote user.
      Mutes/Unmutes all remote users.

      Background music and audio effect APIs

      API
      Description
      Gets the background music and audio effect management object TXAudioEffectManager.

      Beauty filter APIs

      API
      Description
      Gets the beauty filter management object TXBeautyManager.

      Message sending APIs

      API
      Description
      Broadcasts a text chat message in a room. This API is generally used for on-screen comments.
      Sends a custom text message.

      TRTCLiveRoomDelegate API Overview

      Common event callbacks

      API
      Description
      Callback for error.
      Callback for warning.
      You were kicked offline because another user logged in to the account.

      Room event callback APIs

      API
      Description
      You entered the room.
      Whether a remote user has playable video in the primary stream (usually used for camera images)
      The room was closed.

      Callback APIs for entry/exit of anchors/audience

      API
      Description
      There is a new anchor/co-anchoring viewer in the room.
      An anchor/co-anchoring viewer quit cross-room communication/co-anchoring.
      An audience member entered the room.
      An audience member left the room.

      Callback APIs for anchor-audience co-anchoring events

      API
      Description
      A co-anchoring request was received.
      The co-anchoring request was accepted.
      The co-anchoring request was rejected.
      A user was removed from co-anchoring.

      Callback APIs for cross-room communication events

      API
      Description
      A cross-room communication request was received.
      The cross-room communication request was accepted.
      The cross-room communication request was rejected.
      The cross-room communication ended.

      Message event callback APIs

      API
      Description
      A text message was received.
      A custom message was received.

      Basic SDK APIs

      sharedInstance

      This API is used to get the TRTCLiveRoom singleton object.
       static Future<TRTCLiveRoom> sharedInstance()

      destroySharedInstance

      This API is used to terminate the TRTCLiveRoom singleton object.
      Note
      After the instance is terminated, the externally cached TRTCLiveRoom instance can no longer be used. You need to call sharedInstance again to get a new instance.
      static void destroySharedInstance()

      registerListener

      This API is used to get the event callback of TRTCLiveRoom. You can use TRTCLiveRoomDelegate to get various status notifications of TRTCLiveRoom.
      void registerListener(VoiceListenerFunc func);
      Note
      registerListener is the delegate callback of TRTCLiveRoom.

      unRegisterListener

      This API is used to remove the event listener.
      void unRegisterListener(VoiceListenerFunc func);

      login

      Login
      Future<ActionCallback> login(
            int sdkAppId, String userId, String userSig, TRTCLiveRoomConfig config);
      The parameters are described below:
      Parameter
      Type
      Description
      sdkAppId
      int
      You can view the SDKAppID via Application Management > Application Info in the TRTC console.
      userId
      String
      The ID of the current user, which is a string that can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_).
      userSig
      String
      Tencent Cloud's proprietary security signature. For how to calculate and use it, see FAQs > UserSig.
      config
      TRTCLiveRoomConfig
      Global configuration information, which needs to be initialized during login and cannot be modified afterward.
      useCDNFirst: Specifies the way the audience watches live streams. true means watching over CDNs, which is cost-efficient but has high latency. false means watching under the low latency mode, the cost of which is between that of CDN live streaming and co-anchoring, but the latency is lower than 1 second.
      CDNPlayDomain: Specifies the domain name for CDN live streaming. It takes effect only if useCDNFirst is set to true. You can set it in Domain Management of the CSS console.

      logout

      Log out
      Future<ActionCallback> logout();

      setSelfProfile

      This API is used to set the profile.
      Future<ActionCallback> setSelfProfile(String userName, String avatarURL);
      The parameters are described below:
      Parameter
      Type
      Description
      userName
      String
      Nickname
      avatarURL
      String
      Profile photo URL

      Room APIs

      createRoom

      This API is used to create a room (called by anchor).
      Future<ActionCallback> createRoom(int roomId, TRTCCreateRoomParam roomParam);
      The parameters are described below:
      Parameter
      Type
      Description
      roomId
      int
      The room ID. You need to assign and manage the IDs in a centralized manner. Multiple roomId values can be aggregated into a live room list. Currently, Tencent Cloud does not provide list management services. Please manage your own room lists.
      roomParam
      RoomParam
      Room information, such as room name and cover information. If both the room list and room information are managed on your server, you can ignore this parameter.
      The process of creating a room and starting live streaming as an anchor is as follows:
      1. A user calls startCameraPreview() to enable camera preview and set beauty filters.
      2. The user calls createRoom() to create a room, the result of which is returned via the ActionCallback callback.
      3. The user calls startPublish() to push streams.

      destroyRoom

      This API is used to terminate a room (called by anchor).
      Future<ActionCallback> destroyRoom();

      enterRoom

      This API is used to enter a room (called by audience).
      Future<ActionCallback> enterRoom(int roomId);
      The parameters are described below:
      Parameter
      Type
      Description
      roomId
      int
      The room ID.
      The process of entering a room and starting playback as an audience member is as follows:
      1. A user gets the latest room list from your server. The list may contain the roomID and other information of multiple rooms.
      2. The user selects a room and calls enterRoom() to enter the room.
      3. The user calls startPlay(userId), passing in the anchor’s userId to start playback.
      If the room list contains the anchor’s userId, the user can call startPlay(userId) to start playback.
      If the user does not have the anchor's userId before room entry, he or she can find it in the onAnchorEnter(userId) callback of TRTCLiveRoomDelegate, which is returned after room entry. The user can then call startPlay(userId) to start playback.

      exitRoom

      This API is used to leave a room.
      Future<ActionCallback> exitRoom();

      getRoomInfos

      This API is used to get room list details, which are set by anchors via roomInfo when they call createRoom().
      Note
      You don’t need this API if both the room list and room information are managed on your server.
      Future<RoomInfoCallback> getRoomInfos(List<String> roomIdList);
      The parameters are described below:
      Parameter
      Type
      Description
      roomIdList
      List<String>
      Room ID list

      getAnchorList

      This API is used to get the anchors and co-anchoring viewers in a room. It takes effect only if it is called after enterRoom().
      Future<UserListCallback> getAnchorList();

      getRoomMemberList

      This API is used to get the information of all audience members in a room. It takes effect only if it is called after enterRoom().
      Future<UserListCallback> getRoomMemberList(int nextSeq)
      The parameters are described below:
      Parameter
      Type
      Description
      nextSeq
      int
      Pulling-by-page flag. It is set to 0 when the information is pulled for the first time. If the callback succeeds and nextSeq is not 0, pagination is needed. The value of this field is passed in for the next pull until the value becomes 0.

      Stream Pushing/Pulling APIs

      startCameraPreview

      This API is used to enable local video preview.
      Future<void> startCameraPreview(bool isFrontCamera, int viewId);
      The parameters are described below:
      Parameter
      Type
      Description
      isFrontCamera
      bool
      true: Front camera; false: Rear camera.
      viewId
      int
      Called back video view ID

      stopCameraPreview

      This API is used to stop local video capturing and preview.
        Future<void> stopCameraPreview();

      startPublish

      This API is used to start live streaming (pushing streams), which can be called in the following scenarios:
      An anchor starts live streaming.
      A viewer starts co-anchoring.
      Future<void> startPublish(String streamId);
      The parameters are described below:
      Parameter
      Type
      Description
      streamId
      String?
      The streamId used to bind live streaming CDNs. You need to specify the streamId of the anchor if you want the audience to recieve the anchor's streams via live streaming CDNs.

      stopPublish

      This API is used to stop live streaming (pushing streams), which can be called in the following scenarios:
      An anchor ends live streaming.
      A viewer ends co-anchoring.
      Future<void> stopPublish();

      startPlay

      This API is used to play a remote video. It can be called in common playback and co-anchoring scenarios.
      Future<void> startPlay(String userId, int viewId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the user whose video is to be played.
      viewId
      int
      Called back video view ID.
      Common playback:
      If the room list contains anchors’ userId, after entering a room, a user can call startPlay(userId) to play the anchor's video.
      If audience do not have the anchor's userId before room entry, they can find it in the onAnchorEnter(userId) callback of TRTCLiveRoomDelegate, which is returned after room entry. They can then call startPlay(userId) to play the anchor’s video.
      Co-anchoring: After co-anchoring is initiated, the anchor will receive the onAnchorEnter(userId) callback from TRTCLiveRoomDelegate and can call startPlay(userId), passing in the userId` returned by the callback to play co-anchoring video.

      stopPlay

      This API is used to stop rendering a remote video. It needs to be called after the onAnchorExit() callback is received.
      Future<void> stopPlay(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the remote user.

      APIs for Anchor-Audience Co-anchoring

      requestJoinAnchor

      This API is used to send a co-anchoring request (called by audience).
      Future<ActionCallback> requestJoinAnchor();
      The process of co-anchoring between anchors and audience members is as follows:
      1. A viewer calls requestJoinAnchor() to send a co-anchoring request to the anchor.
      2. The anchor receives the onRequestJoinAnchor() callback of TRTCLiveRoomDelegate.
      3. The anchor calls responseJoinAnchor() to accept or reject the co-anchoring request.
      4. The viewer receives the responseCallback callback, which carries the anchor’s response.
      5. If the request is accepted, the viewer calls startCameraPreview() to enable local camera preview.
      6. The viewer calls startPublish() to push streams.
      7. After the viewer starts pushing streams, the anchor receives the onAnchorEnter() callback of TRTCLiveRoomDelegate.
      8. The anchor calls startPlay() to play the co-anchoring viewer’s video.
      9. If there are other viewers co-anchoring with the anchor in the room, the new co-anchoring viewer will receive the onAnchorEnter() callback and can call startPlay() to play other co-anchoring viewers’ video.

      responseJoinAnchor

      This API is used to respond to a co-anchoring request (called by anchor) after receiving the onRequestJoinAnchor() callback of TRTCLiveRoomDelegate.
      Future<ActionCallback> responseJoinAnchor(String userId, boolean agreee);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID of the audience member.
      agree
      bool
      true: Accept; false: Reject

      kickoutJoinAnchor

      This API is used to remove a user from co-anchoring (called by anchor). The removed user will receive the onKickoutJoinAnchor() callback of TRTCLiveRoomDelegate.
      Future<ActionCallback> kickoutJoinAnchor(String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the co-anchoring user.

      APIs for Cross-Room Communication

      requestRoomPK

      This API is used to send a cross-room communication request (called by anchor).
      Future<ActionCallback> requestRoomPK(int roomId, String userId);
      The parameters are described below:
      Parameter
      Type
      Description
      roomId
      int
      The Room ID of the anchor to call.
      userId
      String
      The user ID of the anchor to call.
      Anchors in different rooms can compete with each other. The process of starting cross-room competition between anchor A and anchor B is as follows:
      1. Anchor A calls requestRoomPK() to send a cross-room communication request to anchor B.
      2. Anchor B receives the onRequestRoomPK() callback of TRTCLiveRoomDelegate.
      3. Anchor B calls responseRoomPK() to respond to the cross-room communication request.
      4. If anchor B accepts the request, he or she would wait for the onAnchorEnter() callback of TRTCLiveRoomDelegate and call startPlay() to play anchor A's video.
      5. Anchor A receives the onRoomPKAccepted or onRoomPKRejected callback.
      6. If the request is accepted, anchor A waits for the onAnchorEnter() callback of TRTCLiveRoomDelegate and calls startPlay() to play anchor B’s video.

      responseRoomPK

      This API is used to respond to a cross-room communication request (called by anchor), after which the request sending anchor will receive the responseCallback passed in to requestRoomPK.
      Future<ActionCallback> responseRoomPK(String userId, boolean agree);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID of the anchor sending the communication request.
      agree
      bool
      true: Accept; false: Reject

      quitRoomPK

      This API is used to quit cross-room communication. If either anchor quits cross-room communication, the other anchor will receive the onQuitRoomPk() callback of TRTCLiveRoomDelegate.
      Future<ActionCallback> quitRoomPK();

      Audio/Video APIs

      switchCamera

      This API is used to switch between the front and rear cameras.
      Future<void> switchCamera(boolean isFrontCamera);

      setMirror

      This API is used to set the mirror mode.
      Future<void> setMirror(boolean isMirror);
      The parameters are described below:
      Parameter
      Type
      Description
      isMirror
      bool
      Enables/Disables mirroring.

      muteLocalAudio

      This API is used to mute or unmute the local user.
      Future<void> muteLocalAudio(boolean mute);
      The parameters are described below:
      Parameter
      Type
      Description
      mute
      boolean
      true: Mute; false: Unmute

      muteRemoteAudio

      This API is used to mute or unmute a remote user.
      Future<void> muteRemoteAudio(String userId, boolean mute);
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The ID of the remote user.
      mute
      boolean
      true: Mute; false: Unmute

      muteAllRemoteAudio

      This API is used to mute or unmute all remote users.
      Future<void> muteAllRemoteAudio(boolean mute);
      The parameters are described below:
      Parameter
      Type
      Description
      mute
      boolean
      true: Mute; false: Unmute

      Background Music and Audio Effect APIs

      getAudioEffectManager

      This API is used to get the background music and audio effect management object TXAudioEffectManager.
      getAudioEffectManager();

      Beauty Filter APIs

      getBeautyManager

      This API is used to get the beauty filter management object TXBeautyManager.
      getBeautyManager();
      You can do the following using TXBeautyManager:
      Set the beauty filter style and apply effects including skin brightening, rosy skin, eye enlarging, face slimming, chin slimming, chin lengthening/shortening, face shortening, nose narrowing, eye brightening, teeth whitening, eye bag removal, wrinkle removal, and smile line removal.
      Adjust the hairline, eye spacing, eye corners, lip shape, nose wings, nose position, lip thickness, and face shape.
      Apply animated effects such as face widgets (materials).
      Add makeup effects.
      Recognize gestures.

      Message Sending APIs

      sendRoomTextMsg

      This API is used to broadcast a text chat message in a room, which is generally used for on-screen comments.
      Future<ActionCallback> sendRoomTextMsg(String message);
      The parameters are described below:
      Parameter
      Type
      Description
      message
      String
      A text message.

      sendRoomCustomMsg

      This API is used to send a custom text message.
      Future<ActionCallback> sendRoomCustomMsg(String cmd, String message);
      The parameters are described below:
      Parameter
      Type
      Description
      cmd
      String
      A custom command word used to distinguish between different message types
      message
      String
      Custom text message

      TRTCLiveRoomDelegate Event Callback APIs

      Common Event Callback APIs

      onError

      Callback for error.
      Note
      This callback indicates that the SDK encountered an unrecoverable error. Such errors must be listened for, and UI reminders should be sent to users if necessary.
      The parameters are described below:
      Parameter
      Type
      Description
      errCode
      int
      Error code
      errMsg
      String
      Error message

      onWarning

      Callback for warning.
      The parameters are described below:
      Parameter
      Type
      Description
      warningCode
      int
      Warning code
      warningMsg
      String
      Warning message

      onKickedOffline

      Callback for being kicked offline because another user logged in to the same account.

      Room Event Callback APIs

      onRoomDestroy

      Callback for room termination. All users in a room will receive this callback after the anchor leaves the room.

      onEnterRoom

      Callback for room entry by the local user.
      The parameters are described below:
      Parameter
      Type
      Description
      result
      int
      If result is greater than 0, it indicates the time (ms) room entry took; if result is less than 0, it represents the error code for room entry.

      onUserVideoAvailable

      Callback for whether a remote user has playable video in the primary stream (usually used for camera images).
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      The user ID.
      available
      boolean
      Whether the user's video is enabled.

      Callback APIs for Entry/Exit of Anchors/Audience

      onAnchorEnter

      Callback for a new anchor/co-anchoring viewer. The audience will receive this callback when there is a new anchor/co-anchoring viewer in the room and can call startPlay() of TRTCLiveRoom to play the video of the anchor/co-anchoring viewer.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the new anchor/co-anchoring viewer
      userName
      String
      Username
      userAvatar
      String
      The address of the user profile photo.

      onAnchorExit

      Callback for the quitting of an anchor/co-anchoring viewer. The anchors and co-anchoring viewers in a room will receive this callback after an anchor/co-anchoring viewer quits cross-room communication/co-anchoring and can call stopPlay() of TRTCLiveRoom to stop playing the video of the anchor/co-anchoring viewer.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      ID of the user who quitted co-anchoring
      userName
      String
      Username
      userAvatar
      String
      The address of the user profile photo.

      onAudienceEnter

      Callback for room entry by a viewer.
      void onAudienceEnter(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
      The parameters are described below:
      Parameter
      Type
      Description
      userInfo
      TRTCLiveRoomDef.TRTCLiveUserInfo
      Information of the viewer who enters the room, such as user ID, nickname, and profile photo.

      onAudienceExit

      Callback for room exit by a viewer.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the viewer
      userName
      String
      Username
      userAvatar
      String
      The address of the user profile photo.

      onRequestJoinAnchor

      Callback for receiving a co-anchoring request from a viewer.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      ID of the request sending user
      userName
      String
      Username
      userAvatar
      String
      The address of the user profile photo.

      onAnchorAccepted

      Callback for accepting a co-anchoring request.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the anchor

      onAnchorRejected

      Callback for rejecting a co-anchoring request.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the anchor

      onKickoutJoinAnchor

      Callback for being removed from co-anchoring. After receiving this callback, a co-anchoring viewer needs to call stopPublish() of TRTCLiveRoom to quit co-anchoring.

      Callback APIs for Cross-Room Communication Events

      onRequestRoomPK

      Callback for receiving a cross-room communication request. If an anchor accepts the request, he or she should wait for the onAnchorEnter() callback of TRTCLiveRoomDelegate and call startPlay() to play the other anchor’s video.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the anchor sending the request
      userName
      String
      Username
      userAvatar
      String
      The address of the user profile photo.

      onRoomPKAccepted

      Callback for accepting a cross-room communication request.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the anchor who accepted the request

      onRoomPKRejected

      Callback for accepting a cross-room communication request.
      The parameters are described below:
      Parameter
      Type
      Description
      userId
      String
      User ID of the anchor who rejected the request

      onQuitRoomPK

      Callback for ending cross-room communication.

      Message Event Callback APIs

      onRecvRoomTextMsg

      A text chat message was received.
      The parameters are described below:
      Parameter
      Type
      Description
      message
      String
      Text message

      onRecvRoomCustomMsg

      A custom message was received.
      The parameters are described below:
      Parameter
      Type
      Description
      command
      String
      Custom command word used to distinguish between different message types
      message
      String
      Custom text message
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy