Tencent Real-Time Communication
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Monthly subscription
- Monthly Packages
- Pay-as-you-go
- Refund Instructions
- Video Calling (Including UI)
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- Calls integration to Chat (TUICallKit)
- Offline Call Push (TUICallKit)
- Flutter
- Additional Features（TUICallKit）
- Multi-Person Call
- Floating Window
- Beauty Effects
- Custom Ringtone
- Monitoring Call Status
- Language Settings
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- REST API
- Third-Party Callback
- Callback Configuration
- Call Status Callback
- Legacy Documentation
- Call Status Callback
- Client APIs (TUICallKit)
- uniapp（Android&iOS）
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Run Demo（TUIRoomKit）
- Integration（TUIRoomKit）
- Screen Sharing (TUIRoomKit)
- Schedule a meeting (TUIRoomKit)
- In-meeting Call (TUIRoomKit)
- Virtual Background (TUIRoomKit)
- Conference Control (TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- Enhanced Features (TUIRoomKit)
- Text Watermark
- Client APIs (TUIRoomKit)
- iOS&Mac
- Android
- Electron
- Flutter
- RoomEngine API
- Server APIs (TUIRoomKit)
- REST API
- User Management
- Third-Party Callback
- Callback Configuration
- User Related
- Seat Connection Related
- Live Streaming (Including UI)
- Customizable Interface (TUILiveKit)
- Client APIs (TUILiveKit)
- Android
- UIKit API
- iOS
- UIKit API
- Web
- Electron
- Flutter
- API-Example
- Video Live（LiveStreamCore）
- Server APIs (TUILiveKit)
- REST API
- Room Related
- User-Related Matters
- Battle Related
- Third-Party Callback
- Callback Configuration
- User Related
- Seat Connection Related
- Voice Chat Room (with UI)
- Client APIs (TUICallKit)
- iOS
- UIKit API
- Android
- UIKit API
- API-Example
- Server APIs (TUILiveKit)
- REST API
- Room Related
- Integration (No UI)
- SDK Download
- API Usage Guidelines
- SDK Quick Start
- 01. Importing the SDK
- 02. Entering a Room
- 03. Subscribing to Audio/Video Streams
- 04. Publishing Audio/Video Streams
- 05. Exiting a Room
- 06. Advanced Guide
- Sensing Network Quality
- Setting Video Quality
- Rotating Videos
- API Reference Manual
- iOS and macOS
- Android
- All Platforms (C++)
- Electron
- Flutter
- Unity
- Advanced Features
- Testing Hardware Devices
- Testing Network Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Event Callbacks
- Enable Watermark
- Server APIs
- Room Management APIs
- Stream mixing and relay APIs
- Data Monitoring APIs
- Pull stream Relay Related interface
- AI Transcription APIs
- Making API Requests
- Call Quality Monitoring APIs
- On-cloud recording APIs
- Usage Statistics APIs
- Appendix
- Console Guide
- Application Management
- Monitoring Dashboard
- Development Assistance
- Solution
- Real-Time Chorus
- Solution Overview (TUIKaraoke)
- TUIKaraoke APIs
- FAQs
- Legacy Documentation
- Protocols and Policies
DocumentationTencent Real-Time CommunicationMulti-Participant Conference (with UI)Enhanced Features (TUIRoomKit)Setting Nickname, Avatar (All Platform)
Setting Nickname, Avatar (All Platform)
Last updated: 2024-08-02 17:35:28
This document introduces how to set the user's avatar and nickname in TUIRoomKit.
Setting Avatar, Nickname
If you need to customize your nickname or avatar, you can use the following API to update:
await TUIRoomEngine.setSelfInfo({ userName: 'jack', avatarUrl: 'http://xxx' });
TUIRoomEngine.setSelfInfo("userName", "avatarUrl", null);
import TUIRoomEngineTUIRoomEngine.setSelfInfo(userName: "xxx", avatarUrl: "xxx") {print("setSelfInfo success")} onError: { code, message inprint("setSelfInfo failed, code:\(code),message:\(message)")}
import 'package:rtc_room_engine/rtc_room_engine.dart';TUIRoomEngine.setSelfInfo("userName", "avatarURL");
await TUIRoomEngine.setSelfInfo({ userName: 'jack', avatarUrl: 'http://xxx' });
Note:
Due to user privacy restrictions, updates to the nickname and profile picture may be delayed. If you require higher real-time updates, you can use the Rename during the conference feature.
Rename during the conference
In a meeting, participants can change their nicknames in real time to suit different scenarios. The updated nickname takes effect immediately, but is limited to the current conference only.
Note：
The Rename During Meeting feature requires TUIRoomKit v2.5.0 or higher. Currently, this feature supports Web, Electron and H5 platforms only.
Flowchart
1. Within TUIRoomKit, during the meeting, click the bottom toolbar Member Management > select yourself or the user you want to rename > More > change name;
2. In the pop-up window, enter the new name and click OK to apply the changes immediately.
Permission to Operations
Ordinary users can only change their own nickname.
The host or admin can change their own or other users' nicknames.
Sample code
If you need to modify it yourself in your project to support the feature of changing nicknames during meetings, you can use the following TUIRoomEngine interface:
const roomEngine = TUIRoomEngine.getInstance();await roomEngine.changeUserNameCard({userId: 'user_1234',nameCard: 'jack',});
const roomEngine = TUIRoomEngine.getInstance();await roomEngine.changeUserNameCard({userId: 'user_1234',nameCard: 'jack',});
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No