Web

AtomicXCore SDK is the next-generation reactive API from TRTC, purpose-built for live streaming, instant messaging, audio/video calls, and voice chat rooms. This API suite enables rapid UI development and supports comprehensive features including room management, screen sharing, member management, seat control, basic beauty effects, and more. Built on the TRTC SDK, AtomicXCore delivers ultra-low latency and high-quality audio and video experiences. This page provides a complete reference for all AtomicXCore SDK API interfaces, organized by functional module.
LoginState
User Authentication and Login Management
Core Features: Deliver essential identity authentication, including user login, logout, and personal profile management. This forms the foundation of user identity across your application.
Technical Highlights: Support multiple login methods, user info caching, persistent login state, and robust security for user identity.
Use Cases: User login, identity verification, profile management, permission control, and other core authentication scenarios.
Reactive Data
Data List
Description
﻿loginUserInfo﻿
Details of the currently logged-in user.
API Functions
Function List
Description
﻿login﻿
Authenticate and log in the user.
﻿setSelfInfo﻿
Update user profile information.
﻿logout﻿
Log out the user.
DeviceState
Device State Management
Core Features: Control audio/video devices such as cameras and microphones, monitors device status, checks permissions, and provides essential device services.
Technical Highlights: Support multi-device management, real-time device monitoring, dynamic permission checks, and automatic device fault recovery.
Use Cases: Device management, permission control, audio/video capture, device fault handling, and other foundational scenarios.
Reactive Data
Data List
Description
﻿microphoneStatus﻿
Status of the microphone.
﻿microphoneList﻿
List of available microphone devices.
﻿currentMicrophone﻿
Currently selected microphone device.
﻿microphoneLastError﻿
Last microphone error details.
﻿captureVolume﻿
Microphone capture volume level.
﻿currentMicVolume﻿
Current microphone volume.
﻿isMicrophoneTesting﻿
Microphone testing status.
﻿testingMicVolume﻿
Microphone volume during testing.
﻿cameraStatus﻿
Status of the camera.
﻿cameraList﻿
List of available camera devices.
﻿currentCamera﻿
Currently selected camera device.
﻿cameraLastError﻿
Last camera error details.
﻿isCameraTesting﻿
Camera testing status.
﻿isCameraTestLoading﻿
Camera test loading status.
﻿isFrontCamera﻿
Indicates if the front camera is in use.
﻿localMirrorType﻿
Local video mirror type.
﻿localVideoQuality﻿
Local video quality settings.
﻿speakerList﻿
List of available speaker devices.
﻿currentSpeaker﻿
Currently selected speaker device.
﻿outputVolume﻿
Speaker output volume level.
﻿currentAudioRoute﻿
Current audio output route.
﻿isSpeakerTesting﻿
Speaker testing status.
﻿screenStatus﻿
Screen sharing status.
﻿networkInfo﻿
Network connection details.
API Functions
Function List
Description
﻿openLocalMicrophone﻿
Enable the local microphone.
﻿closeLocalMicrophone﻿
Disable the local microphone.
﻿muteLocalAudio﻿
Mute local audio.
﻿unmuteLocalAudio﻿
Unmute local audio.
﻿getMicrophoneList﻿
Retrieve the list of microphone devices.
﻿setCurrentMicrophone﻿
Select the active microphone device.
﻿startMicrophoneTest﻿
Begin microphone testing.
﻿setCaptureVolume﻿
Adjust microphone capture volume.
﻿setOutputVolume﻿
Adjust speaker output volume.
﻿stopMicrophoneTest﻿
End microphone testing.
﻿getSpeakerList﻿
Retrieve the list of speaker devices.
﻿setCurrentSpeaker﻿
Select the active speaker device.
﻿setAudioRoute﻿
Configure the audio output route.
﻿startSpeakerTest﻿
Begin speaker testing.
﻿stopSpeakerTest﻿
End speaker testing.
﻿openLocalCamera﻿
Enable the local camera.
﻿closeLocalCamera﻿
Disable the local camera.
﻿getCameraList﻿
Retrieve the list of camera devices.
﻿setCurrentCamera﻿
Select the active camera device.
﻿switchCamera﻿
Switch between front and rear cameras.
﻿switchMirror﻿
Toggle video mirror mode.
﻿updateVideoQuality﻿
Update video quality settings.
﻿startCameraDeviceTest﻿
Begin camera device testing.
﻿startScreenShare﻿
Start screen sharing.
﻿stopScreenShare﻿
Stop screen sharing.
﻿stopCameraDeviceTest﻿
End camera device testing.
﻿screenCaptureStopped﻿
Callback for when screen sharing stops.
LiveListState
Live Room List Management
Core Features: Manage the complete lifecycle of live rooms, including creation, joining, leaving, ending, and supports paginated retrieval and real-time updates of the live room list.
Technical Highlights: Enable paginated loading, real-time status sync, dynamic live info updates, and reactive data binding to keep UI and data state aligned. New reactive data: liveList and liveListCursor, plus fetchLiveList API.
Use Cases: Displaying live room lists, creating live rooms, managing live status, live data analytics, and related business scenarios.
Reactive Data
Data List
Description
﻿currentLive﻿
Information about the current live room.
﻿liveList﻿
Live room list data, including all live rooms.
﻿liveListCursor﻿
Pagination cursor for fetching the next page of live room data.
API Functions
Function List
Description
﻿createLive﻿
Create a new live room.
﻿joinLive﻿
Join an existing live room.
﻿leaveLive﻿
Leave the current live room.
﻿endLive﻿
End the live stream.
﻿updateLiveInfo﻿
Update live room information.
﻿queryMetaData﻿
Query custom metadata.
﻿updateLiveMetaData﻿
Update custom metadata for the live room.
﻿fetchLiveList﻿
Fetch the live room list.
LiveSeatState
Live Room Seat Management
Core Features: Provide seat control for multi-user co-hosting, including seat state management and audio/video device control—take seat, leave seat, lock seat, and more.
Technical Highlights: Built on WebRTC, support multi-stream audio/video management, seat locking, device control, permission management, and advanced features. New reactive data: seatList, canvas, speakingUsers, networkQualities, and full seat operation APIs.
Use Cases: Multi-user co-hosting, host PK battles, interactive games, online education, conference live streaming, and other multi-user interaction scenarios.
Reactive Data
Data List
Description
﻿seatList﻿
Seat list, including status and user details for all seats.
﻿canvas﻿
Canvas configuration for video rendering and layout.
﻿speakingUsers﻿
List of users currently speaking.
﻿networkQualities﻿
Network quality information for each user.
API Functions
Function List
Description
﻿takeSeat﻿
Take a seat (go live on mic).
﻿leaveSeat﻿
Leave a seat (go off mic).
﻿lockSeat﻿
Lock a seat.
﻿unLockSeat﻿
Unlock a seat.
﻿kickUserOutOfSeat﻿
Remove a user from a seat.
﻿moveUserToSeat﻿
Move a user to a specified seat.
﻿openRemoteCamera﻿
Enable a remote user's camera.
﻿closeRemoteCamera﻿
Disable a remote user's camera.
﻿openRemoteMicrophone﻿
Enable a remote user's microphone.
﻿closeRemoteMicrophone﻿
Disable a remote user's microphone.
﻿muteMicrophone﻿
Mute a microphone.
﻿unmuteMicrophone﻿
Unmute a microphone.
﻿startPlayStream﻿
Start stream playback.
﻿stopPlayStream﻿
Stop stream playback.
LiveAudienceState
Live Room Audience Management
Core Features: Manage the audience list, controls audience permissions, assigns administrators, and supports moderation and real-time audience statistics.
Technical Highlights: Real-time audience list updates, hierarchical permission management, batch operations, ensuring live room order and optimal user experience. New reactive data: audienceList and audienceCount.
Use Cases: Audience management, permission control, live room moderation, audience interaction, and related scenarios.
Reactive Data
Data List
Description
﻿audienceList﻿
Audience list, including details for all viewers.
﻿audienceCount﻿
Total audience count.
API Functions
Function List
Description
﻿fetchAudienceList﻿
Retrieve the audience list.
﻿setAdministrator﻿
Assign administrator privileges.
﻿revokeAdministrator﻿
Remove administrator privileges.
﻿kickUserOutOfRoom﻿
Remove a user from the room.
﻿disableSendMessage﻿
Mute a user.
LiveMonitorState
Live Room Monitoring Management
Core Features: Provide real-time monitoring of live rooms, including live status tracking, data statistics, anomaly detection, and multi-room monitoring.
Technical Highlights: Real-time data collection, multi-dimensional metrics, intelligent alerting, ensuring live streaming stability and reliability. New reactive data: monitorLiveInfoList and optimized monitoring APIs.
Use Cases: Live quality monitoring, performance analysis, anomaly alerts, data statistics, and operational management.
Reactive Data
Data List
Description
﻿monitorLiveInfoList﻿
List of monitored live room details.
API Functions
Function List
Description
﻿init﻿
Initialize live room monitoring.
﻿getLiveList﻿
Get the list of live rooms.
﻿closeRoom﻿
Close a live room.
﻿sendMessage﻿
Send a message.
﻿startPlay﻿
Start playback.
﻿stopPlay﻿
Stop playback.
﻿muteLiveAudio﻿
Mute live audio.
CoGuestState
Co-host Guest Management
Core Features: Manage co-hosting interactions between audience and host, including application, invitation, acceptance, rejection, and co-hosting status management.
Technical Highlights: Real-time audio/video technology, status synchronization, adaptive quality, network monitoring. New reactive data: connected, invitees, applicants, candidates, and applyForSeat API.
Use Cases: Audience co-hosting, interactive Q&A, online karaoke, game live streaming, and other audience participation scenarios.
Reactive Data
Data List
Description
﻿candidates﻿
List of candidate users for co-host invitation.
﻿connected﻿
List of users currently co-hosting.
﻿invitees﻿
List of users invited to co-host.
﻿applicants﻿
List of users applying to co-host.
API Functions
Function List
Description
﻿cancelApplication﻿
Cancel a co-host application.
﻿acceptApplication﻿
Accept a co-host application.
﻿rejectApplication﻿
Reject a co-host application.
﻿cancelInvitation﻿
Cancel a co-host invitation.
﻿acceptInvitation﻿
Accept a co-host invitation.
﻿rejectInvitation﻿
Reject a co-host invitation.
﻿disConnect﻿
Disconnect from co-hosting.
﻿applyForSeat﻿
Apply to go live on mic.
CoHostState
Co-host Host Management
Core Features: Enable co-hosting between hosts, including invitations, applications, status management, and a complete host co-hosting workflow.
Technical Highlights: Multi-host audio/video sync, picture-in-picture display, quality optimization for seamless co-hosting. New reactive data: coHostStatus, connected, applicant, invitees, candidates, and full co-hosting control APIs.
Use Cases: Host PK battles, collaborative live streaming, cross-platform co-hosting, host interaction, and advanced live streaming scenarios.
Reactive Data
Data List
Description
﻿coHostStatus﻿
Co-host host status.
﻿connected﻿
Co-host connection status.
﻿applicant﻿
Host applying for co-hosting.
﻿invitees﻿
List of invited hosts.
﻿candidates﻿
Candidate host list.
API Functions
Function List
Description
﻿requestHostConnection﻿
Request host co-hosting.
﻿cancelHostConnection﻿
Cancel host co-hosting.
﻿acceptHostConnection﻿
Accept host co-hosting.
﻿rejectHostConnection﻿
Reject host co-hosting.
﻿exitHostConnection﻿
Exit host co-hosting.
BattleState
PK Battle Management
Core Features: Manage PK battles between hosts, including invitations, acceptance, rejection, ending, and real-time score tracking.
Technical Highlights: Real-time battle status sync, score calculation, result statistics, and more. New reactive data: battleScore for a complete PK battle experience.
Use Cases: Host PK battles, talent competitions, game battles, interactive contests, and entertainment scenarios.
Reactive Data
Data List
Description
﻿currentBattleInfo﻿
Current PK battle details.
﻿battleUsers﻿
Users participating in the PK battle.
﻿battleScore﻿
Real-time PK battle score.
API Functions
Function List
Description
﻿requestBattle﻿
Request a PK battle.
﻿cancelBattleRequest﻿
Cancel a PK battle request.
﻿acceptBattle﻿
Accept a PK battle.
﻿rejectBattle﻿
Reject a PK battle.
﻿exitBattle﻿
Exit a PK battle.
BarrageState
Barrage Message Management
Core Features: Manage barrage features in live rooms, including text and custom messages, barrage sending, message status sync, and local tip display.
Technical Highlights: High-concurrency message processing, real-time sync, message filtering, emoji support, and more. New API functions: sendTextMessage, sendCustomMessage, appendLocalTip.
Use Cases: Barrage interaction, message management, emoji usage, chat rooms, and social scenarios.
Reactive Data
Data List
Description
﻿messageList﻿
List of barrage messages.
API Functions
Function List
Description
﻿sendTextMessage﻿
Send a text message.
﻿sendCustomMessage﻿
Send a custom message.
﻿appendLocalTip﻿
Add a local tip.
MessageListState
Message List Management
Core Features: Manage chat message lists, including message loading, scroll control, read receipts, message highlighting, and complete display functionality.
Technical Highlights: Virtual scrolling, message optimization, real-time updates, and high-performance handling. New reactive data: activeConversationID, messageList, hasMoreOlderMessage, and more.
Use Cases: Instant messaging, group chat, private chat, message management, and communication scenarios.
Reactive Data
Data List
Description
﻿activeConversationID﻿
ID of the active conversation.
﻿messageList﻿
Message list data.
﻿hasMoreOlderMessage﻿
Indicates if older messages are available.
﻿hasMoreNewerMessage﻿
Indicates if newer messages are available.
﻿enableReadReceipt﻿
Read receipt status.
﻿isDisableScroll﻿
Scroll disable status.
﻿recalledMessageIDSet﻿
Set of recalled message IDs.
﻿highlightMessageIDSet﻿
Set of highlighted message IDs.
API Functions
Function List
Description
﻿setEnableReadReceipt﻿
Enable or disable read receipts.
﻿setIsDisableScroll﻿
Enable or disable scroll.
﻿highlightMessage﻿
Highlight a message.
MessageInputState
Message Input Management
Core Features: Manage the input box state and behavior, supporting text input, emoji, @mentions, input status indication, and a complete input experience.
Technical Highlights: Rich text editing, input status sync, draft saving, and more. New reactive data: inputRawValue, isPeerTyping.
Use Cases: Message editing, emoji input, file sending, voice input, and related scenarios.
Reactive Data
Data List
Description
﻿inputRawValue﻿
Raw text content of the input box.
﻿isPeerTyping﻿
Indicates if the peer is typing.
API Functions
Function List
Description
﻿updateRawValue﻿
Update the input box value.
﻿setEditorInstance﻿
Set the editor instance.
﻿setContent﻿
Set the input box content.
﻿insertContent﻿
Insert content into the input box.
﻿focusEditor﻿
Focus the input editor.
﻿blurEditor﻿
Remove focus from the editor.
﻿sendMessage﻿
Send a message.
MessageActionState
Message Action Management
Core Features: Manage message actions such as forwarding, quoting, copying, deleting, recalling, and provides a complete set of message operations.
Technical Highlights: Support batch operations, action state management, permission control, and more. New reactive data: forwardMessageIDList, isForwardMessageSelectionDone.
Use Cases: Message forwarding, quoting, management, batch operations, and related scenarios.
Reactive Data
Data List
Description
﻿forwardMessageIDList﻿
List of message IDs selected for forwarding.
﻿isForwardMessageSelectionDone﻿
Indicates if forwarding selection is complete.
﻿forwardConversationIDList﻿
Target conversation IDs for forwarding.
﻿quotedMessage﻿
Details of the quoted message.
API Functions
Function List
Description
﻿forwardMessage﻿
Forward a message.
﻿setForwardMessageIDList﻿
Set the list of messages to forward.
﻿setIsForwardMessageSelectionDone﻿
Set forwarding selection completion status.
﻿setForwardConversationIDList﻿
Set target conversations for forwarding.
﻿quoteMessage﻿
Quote a message.
﻿clearQuotedMessage﻿
Clear the quoted message.
﻿copyTextMessage﻿
Copy a text message.
﻿deleteMessage﻿
Delete a message.
﻿recallMessage﻿
Recall a message.
﻿resetMessageActionState﻿
Reset message action state.
ConversationListState
Conversation List Management
Core Features: Manage the user's conversation list, including sorting, unread count statistics, conversation operations, and complete management features.
Technical Highlights: Real-time conversation updates, intelligent sorting, network status monitoring, and more. New reactive data: conversationList, activeConversation, totalUnRead, netStatus.
Use Cases: Conversation management, contact lists, group management, message center, and related scenarios.
Reactive Data
Data List
Description
﻿conversationList﻿
Conversation list data.
﻿activeConversation﻿
Currently active conversation.
﻿totalUnRead﻿
Total unread messages count.
﻿netStatus﻿
Network connection status.
API Functions
Function List
Description
﻿markConversationUnread﻿
Mark a conversation as unread.
﻿setActiveConversation﻿
Set the active conversation.
﻿pinConversation﻿
Pin a conversation.
﻿deleteConversation﻿
Delete a conversation.
﻿muteConversation﻿
Mute a conversation.
﻿setConversationDraft﻿
Set a conversation draft.
﻿createC2CConversation﻿
Create a one-on-one conversation.
﻿createGroupConversation﻿
Create a group conversation.
ContactListState
Contact List Management
Core Features: Manage the user's contact list, including friend management, group management, blacklist management, and complete contact features.
Technical Highlights: Contact grouping, friend applications, group applications, and more. New reactive data: friendList, groupList, blackList, and full contact operation APIs.
Use Cases: Friend management, group management, contact search, social networking, and related scenarios.
Reactive Data
Data List
Description
﻿friendList﻿
List of friends.
﻿groupList﻿
List of groups.
﻿blackList﻿
Blacklist.
﻿friendApplicationUnreadCount﻿
Unread friend application count.
﻿friendGroupList﻿
List of friend groups.
﻿friendApplicationList﻿
List of friend applications.
﻿groupApplicationList﻿
List of group applications.
API Functions
Function List
Description
﻿setGroupApplicationList﻿
Set the group application list.
﻿setFriendList﻿
Set the friend list.
﻿setGroupList﻿
Set the group list.
﻿setBlackList﻿
Set the blacklist.
﻿setFriendApplicationUnreadCount﻿
Set unread friend application count.
﻿setFriendGroupList﻿
Set the friend group list.
﻿setFriendApplicationList﻿
Set the friend application list.
﻿initContactListWatcher﻿
Initialize contact list watcher.
﻿addFriend﻿
Add a friend.
﻿markFriendApplicationAsRead﻿
Mark friend applications as read.
﻿acceptFriendApplication﻿
Accept a friend application.
﻿refuseFriendApplication﻿
Refuse a friend application.
﻿addToBlacklist﻿
Add a user to the blacklist.
﻿removeFromBlacklist﻿
Remove a user from the blacklist.
﻿deleteFriend﻿
Delete a friend.
﻿setFriendRemark﻿
Set a friend's remark.
﻿createFriendGroup﻿
Create a friend group.
﻿deleteFriendGroup﻿
Delete a friend group.
﻿addToFriendGroup﻿
Add a user to a friend group.
﻿removeFromFriendGroup﻿
Remove a user from a friend group.
﻿renameFriendGroup﻿
Rename a friend group.
﻿joinGroup﻿
Join a group.
﻿acceptGroupApplication﻿
Accept a group application.
﻿refuseGroupApplication﻿
Refuse a group application.
C2CSettingState
One-on-One Chat Settings Management
Core Features: Manage settings for one-on-one conversations, including user info, chat settings, and permission control.
Technical Highlights: Real-time settings sync, permission management, personalized configuration. Reactive data fields standardized to userID, avatar, signature, and more.
Use Cases: One-on-one chat settings, user info management, chat permission control, and related scenarios.
Reactive Data
Data List
Description
﻿currentConversationRef﻿
Reference to the current conversation.
﻿userIDRef﻿
User ID.
﻿nickRef﻿
User nickname.
﻿avatarRef﻿
User avatar.
﻿signatureRef﻿
User signature.
﻿remarkRef﻿
Friend remark name.
﻿isMutedRef﻿
Conversation mute status.
﻿isPinnedRef﻿
Conversation pin status.
﻿isContactRef﻿
Friend relationship status.
﻿userID﻿
User ID.
﻿avatar﻿
User avatar URL.
﻿signature﻿
User signature.
﻿remark﻿
User remark name.
﻿isMuted﻿
Muted status.
﻿isPinned﻿
Pinned status.
﻿isContact﻿
Contact status.
API Functions
Function List
Description
﻿setChatPinned﻿
Pin the chat.
﻿setChatMuted﻿
Enable do-not-disturb for the chat.
﻿setUserRemark﻿
Set user remark.
GroupSettingState
Group Chat Settings Management
Core Features: Manage group chat settings and operations, including group info, member management, permission control, and complete group management features.
Technical Highlights: Group permission management, member operations, group settings sync, and more. New reactive data: groupID, groupType, groupName, and full group management APIs.
Use Cases: Group management, member management, permission control, group settings, and related scenarios.
Reactive Data
Data List
Description
﻿groupID﻿
Group ID.
﻿groupType﻿
Group type.
﻿groupName﻿
Group name.
﻿avatar﻿
Group avatar URL.
﻿introduction﻿
Group introduction.
﻿notification﻿
Group announcement.
﻿isMuted﻿
Muted status.
﻿isPinned﻿
Pinned status.
﻿groupOwner﻿
Group owner details.
﻿adminMembers﻿
Administrator list.
﻿allMembers﻿
List of all group members.
﻿memberCount﻿
Total member count.
﻿maxMemberCount﻿
Maximum allowed member count.
﻿currentUserID﻿
Current user ID.
﻿currentUserRole﻿
Current user role.
﻿nameCard﻿
User name card.
﻿isMuteAllMembers﻿
Indicates if all members are muted.
﻿isInGroup﻿
Indicates if the user is in the group.
﻿inviteOption﻿
Group invite options.
API Functions
Function List
Description
﻿getGroupMemberList﻿
Retrieve the group member list.
﻿updateGroupProfile﻿
Update group profile information.
﻿addGroupMember﻿
Add a member to the group.
﻿deleteGroupMember﻿
Remove a member from the group.
﻿changeGroupOwner﻿
Transfer group ownership.
﻿setGroupMemberRole﻿
Set a member's role in the group.
﻿setGroupMemberNameCard﻿
Set a member's name card.
﻿setChatPinned﻿
Pin the group chat.
﻿setChatMuted﻿
Enable do-not-disturb for the group chat.
﻿setGroupMemberMuteTime﻿
Set mute duration for a group member.
﻿setMuteAllMember﻿
Mute all group members.
﻿dismissGroup﻿
Dismiss the group.
﻿quitGroup﻿
Leave the group.
﻿hasPermission﻿
Check user permissions.
﻿canOperateOnMember﻿
Check if a member can be operated on.
﻿getAvailablePermissions﻿
Get available permissions.
﻿initWatcher﻿
Initialize group watcher.
VideoMixerState
Video Mixing Management
Core Features: Manage video mixing, supporting multi-stream composition, layout management, media source control, and advanced video processing.
Technical Highlights: Real-time video mixing, dynamic layout adjustment, media source management, and more. New reactive data: isVideoMixerEnabled, mediaSourceList, activeMediaSource, and full mixing control APIs.
Use Cases: Multi-host live streaming, picture-in-picture, video composition, professional production, and related scenarios.
Reactive Data
Data List
Description
﻿publishVideoQuality﻿
Video size by resolution.
﻿isVideoMixerEnabled﻿
Indicates if video mixing is enabled.
﻿mediaSourceList﻿
List of media sources.
﻿activeMediaSource﻿
Currently active media source.
API Functions
Function List
Description
﻿getVideoDataByQuality﻿
Get video data by quality.
﻿getSizeByQuality﻿
Get video size by quality.
﻿getSizeByResolution﻿
Get video size by resolution.
﻿transformTUIVideoQualityToTRTCVideoResolution﻿
Convert video quality to TRTC resolution.
﻿transformTRTCVideoResolutionToTUIVideoQuality﻿
Convert TRTC resolution to video quality.
﻿transformTRTCVideoResModeToTUIVideoResMode﻿
Convert TRTC resolution mode.
﻿changeActiveMediaSource﻿
Switch the active media source.
﻿updateVideoQuality﻿
Update video quality settings.
﻿getDefaultLayoutByMediaSource﻿
Get default layout for a media source.
﻿addMediaSource﻿
Add a media source.
﻿updateMediaSource﻿
Update a media source.
﻿removeMediaSource﻿
Remove a media source.
﻿enableLocalVideoMixer﻿
Enable local video mixer.
﻿clearMediaSource﻿
Clear all media sources.
﻿initMediaSourceManager﻿
Initialize media source manager.
﻿initVideoMixerState﻿
Initialize video mixer state.
VirtualBackgroundState
Virtual Background Management
Core Features: Manage virtual backgrounds, including background replacement, blur, custom backgrounds, and video beautification.
Technical Highlights: AI-powered real-time background segmentation and replacement. New reactive data: virtualBackgroundConfig, plus isSupported and setVirtualBackground APIs.
Use Cases: Video calls, online meetings, live stream beautification, privacy protection, and related scenarios.
Reactive Data
Data List
Description
﻿virtualBackgroundConfig﻿
Virtual background configuration.
API Functions
Function List
Description
﻿initVirtualBackground﻿
Initialize virtual background.
﻿saveVirtualBackground﻿
Save virtual background settings.
﻿isSupported﻿
Check if virtual background is supported.
﻿setVirtualBackground﻿
Set the virtual background.
ASRState
Speech Recognition Management
Core Features: Manage speech recognition, including real-time speech-to-text, transcript history, transcript export, and more.
Technical Highlights: Advanced ASR technology, multi-language support, real-time transcription, history records. New reactive data: recentTranscripts, transcriptHistory, and exportTranscripts API.
Use Cases: Meeting notes, speech transcription, accessibility, content recording, and related scenarios.
Reactive Data
Data List
Description
﻿recentTranscripts﻿
Recent speech transcript records.
﻿transcriptHistory﻿
Speech transcript history records.
API Functions
Function List
Description
﻿setRecentTranscriptsDuration﻿
Set duration for recent transcripts.
﻿clearHistory﻿
Clear transcript history.
﻿exportTranscripts﻿
Export transcripts.
SearchState
Search Feature Management
Core Features: Manage global search, including message, user, and group search, with multi-dimensional search capabilities.
Technical Highlights: Advanced search, search history, suggestions, and more. Reactive data standardized to keyword, results, isLoading, and full search APIs.
Use Cases: Message search, contact search, content lookup, history records, and related scenarios.
Reactive Data
Data List
Description
﻿keyword﻿
Search keyword.
﻿results﻿
Search results.
﻿isLoading﻿
Loading status.
﻿error﻿
Error details.
﻿searchAdvancedParams﻿
Advanced search parameters.
﻿selectedSearchType﻿
Selected search type.
API Functions
Function List
Description
﻿search﻿
Perform a search.
﻿setKeyword﻿
Set the search keyword.
﻿setSelectedType﻿
Set the selected search type.
﻿setSearchMessageAdvancedParams﻿
Set advanced parameters for message search.
﻿setSearchUserAdvancedParams﻿
Set advanced parameters for user search.
﻿setSearchGroupAdvancedParams﻿
Set advanced parameters for group search.
﻿loadMore﻿
Load more results.
SeatStore
Seat Storage Management
Core Features: Provide underlying storage and management for seat states, including seat info caching, user info mapping, device request handling, and other core features.
Technical Highlights: Reactive storage design, real-time state sync, event-driven updates, and more. New reactive data: liveOwnerUserId, localUserId, seatList, plus getUserInfo and convertUserInfoToAudienceInfo APIs.
Use Cases: Seat state management, user info storage, device state tracking, and foundational scenarios.
Reactive Data
Data List
Description
﻿liveOwnerUserId﻿
Live room host user ID.
﻿localUserId﻿
Local user ID.
﻿seatList﻿
Seat list, including status and user info for all seats.
﻿coHostUserList﻿
List of co-host users.
﻿sentDeviceRequestMap﻿
Mapping of sent device requests.
﻿receivedDeviceRequestMap﻿
Mapping of received device requests.
﻿userInfoMap﻿
User info mapping table.
API Functions
Function List
Description
﻿getUserInfo﻿
Retrieve user information.
﻿convertUserInfoToAudienceInfo﻿
Convert user information to audience information.
﻿

Data List	Description
loginUserInfo	Details of the currently logged-in user.

Function List	Description
login	Authenticate and log in the user.
setSelfInfo	Update user profile information.
logout	Log out the user.

Data List	Description
microphoneStatus	Status of the microphone.
microphoneList	List of available microphone devices.
currentMicrophone	Currently selected microphone device.
microphoneLastError	Last microphone error details.
captureVolume	Microphone capture volume level.
currentMicVolume	Current microphone volume.
isMicrophoneTesting	Microphone testing status.
testingMicVolume	Microphone volume during testing.
cameraStatus	Status of the camera.
cameraList	List of available camera devices.
currentCamera	Currently selected camera device.
cameraLastError	Last camera error details.
isCameraTesting	Camera testing status.
isCameraTestLoading	Camera test loading status.
isFrontCamera	Indicates if the front camera is in use.
localMirrorType	Local video mirror type.
localVideoQuality	Local video quality settings.
speakerList	List of available speaker devices.
currentSpeaker	Currently selected speaker device.
outputVolume	Speaker output volume level.
currentAudioRoute	Current audio output route.
isSpeakerTesting	Speaker testing status.
screenStatus	Screen sharing status.
networkInfo	Network connection details.

Function List	Description
openLocalMicrophone	Enable the local microphone.
closeLocalMicrophone	Disable the local microphone.
muteLocalAudio	Mute local audio.
unmuteLocalAudio	Unmute local audio.
getMicrophoneList	Retrieve the list of microphone devices.
setCurrentMicrophone	Select the active microphone device.
startMicrophoneTest	Begin microphone testing.
setCaptureVolume	Adjust microphone capture volume.
setOutputVolume	Adjust speaker output volume.
stopMicrophoneTest	End microphone testing.
getSpeakerList	Retrieve the list of speaker devices.
setCurrentSpeaker	Select the active speaker device.
setAudioRoute	Configure the audio output route.
startSpeakerTest	Begin speaker testing.
stopSpeakerTest	End speaker testing.
openLocalCamera	Enable the local camera.
closeLocalCamera	Disable the local camera.
getCameraList	Retrieve the list of camera devices.
setCurrentCamera	Select the active camera device.
switchCamera	Switch between front and rear cameras.
switchMirror	Toggle video mirror mode.
updateVideoQuality	Update video quality settings.
startCameraDeviceTest	Begin camera device testing.
startScreenShare	Start screen sharing.
stopScreenShare	Stop screen sharing.
stopCameraDeviceTest	End camera device testing.
screenCaptureStopped	Callback for when screen sharing stops.

Data List	Description
currentLive	Information about the current live room.
liveList	Live room list data, including all live rooms.
liveListCursor	Pagination cursor for fetching the next page of live room data.

Function List	Description
createLive	Create a new live room.
joinLive	Join an existing live room.
leaveLive	Leave the current live room.
endLive	End the live stream.
updateLiveInfo	Update live room information.
queryMetaData	Query custom metadata.
updateLiveMetaData	Update custom metadata for the live room.
fetchLiveList	Fetch the live room list.

Data List	Description
seatList	Seat list, including status and user details for all seats.
canvas	Canvas configuration for video rendering and layout.
speakingUsers	List of users currently speaking.
networkQualities	Network quality information for each user.

Function List	Description
takeSeat	Take a seat (go live on mic).
leaveSeat	Leave a seat (go off mic).
lockSeat	Lock a seat.
unLockSeat	Unlock a seat.
kickUserOutOfSeat	Remove a user from a seat.
moveUserToSeat	Move a user to a specified seat.
openRemoteCamera	Enable a remote user's camera.
closeRemoteCamera	Disable a remote user's camera.
openRemoteMicrophone	Enable a remote user's microphone.
closeRemoteMicrophone	Disable a remote user's microphone.
muteMicrophone	Mute a microphone.
unmuteMicrophone	Unmute a microphone.
startPlayStream	Start stream playback.
stopPlayStream	Stop stream playback.

Data List	Description
audienceList	Audience list, including details for all viewers.
audienceCount	Total audience count.

Function List	Description
fetchAudienceList	Retrieve the audience list.
setAdministrator	Assign administrator privileges.
revokeAdministrator	Remove administrator privileges.
kickUserOutOfRoom	Remove a user from the room.
disableSendMessage	Mute a user.

Data List	Description
monitorLiveInfoList	List of monitored live room details.

Function List	Description
init	Initialize live room monitoring.
getLiveList	Get the list of live rooms.
closeRoom	Close a live room.
sendMessage	Send a message.
startPlay	Start playback.
stopPlay	Stop playback.
muteLiveAudio	Mute live audio.

Data List	Description
candidates	List of candidate users for co-host invitation.
connected	List of users currently co-hosting.
invitees	List of users invited to co-host.
applicants	List of users applying to co-host.

Function List	Description
cancelApplication	Cancel a co-host application.
acceptApplication	Accept a co-host application.
rejectApplication	Reject a co-host application.
cancelInvitation	Cancel a co-host invitation.
acceptInvitation	Accept a co-host invitation.
rejectInvitation	Reject a co-host invitation.
disConnect	Disconnect from co-hosting.
applyForSeat	Apply to go live on mic.

Data List	Description
coHostStatus	Co-host host status.
connected	Co-host connection status.
applicant	Host applying for co-hosting.
invitees	List of invited hosts.
candidates	Candidate host list.

Function List	Description
requestHostConnection	Request host co-hosting.
cancelHostConnection	Cancel host co-hosting.
acceptHostConnection	Accept host co-hosting.
rejectHostConnection	Reject host co-hosting.
exitHostConnection	Exit host co-hosting.

Data List	Description
currentBattleInfo	Current PK battle details.
battleUsers	Users participating in the PK battle.
battleScore	Real-time PK battle score.

Function List	Description
requestBattle	Request a PK battle.
cancelBattleRequest	Cancel a PK battle request.
acceptBattle	Accept a PK battle.
rejectBattle	Reject a PK battle.
exitBattle	Exit a PK battle.

Data List	Description
messageList	List of barrage messages.

Function List	Description
sendTextMessage	Send a text message.
sendCustomMessage	Send a custom message.
appendLocalTip	Add a local tip.

Data List	Description
activeConversationID	ID of the active conversation.
messageList	Message list data.
hasMoreOlderMessage	Indicates if older messages are available.
hasMoreNewerMessage	Indicates if newer messages are available.
enableReadReceipt	Read receipt status.
isDisableScroll	Scroll disable status.
recalledMessageIDSet	Set of recalled message IDs.
highlightMessageIDSet	Set of highlighted message IDs.

Function List	Description
setEnableReadReceipt	Enable or disable read receipts.
setIsDisableScroll	Enable or disable scroll.
highlightMessage	Highlight a message.

Data List	Description
inputRawValue	Raw text content of the input box.
isPeerTyping	Indicates if the peer is typing.

Function List	Description
updateRawValue	Update the input box value.
setEditorInstance	Set the editor instance.
setContent	Set the input box content.
insertContent	Insert content into the input box.
focusEditor	Focus the input editor.
blurEditor	Remove focus from the editor.
sendMessage	Send a message.

Data List	Description
forwardMessageIDList	List of message IDs selected for forwarding.
isForwardMessageSelectionDone	Indicates if forwarding selection is complete.
forwardConversationIDList	Target conversation IDs for forwarding.
quotedMessage	Details of the quoted message.

Function List	Description
forwardMessage	Forward a message.
setForwardMessageIDList	Set the list of messages to forward.
setIsForwardMessageSelectionDone	Set forwarding selection completion status.
setForwardConversationIDList	Set target conversations for forwarding.
quoteMessage	Quote a message.
clearQuotedMessage	Clear the quoted message.
copyTextMessage	Copy a text message.
deleteMessage	Delete a message.
recallMessage	Recall a message.
resetMessageActionState	Reset message action state.

Data List	Description
conversationList	Conversation list data.
activeConversation	Currently active conversation.
totalUnRead	Total unread messages count.
netStatus	Network connection status.

Function List	Description
markConversationUnread	Mark a conversation as unread.
setActiveConversation	Set the active conversation.
pinConversation	Pin a conversation.
deleteConversation	Delete a conversation.
muteConversation	Mute a conversation.
setConversationDraft	Set a conversation draft.
createC2CConversation	Create a one-on-one conversation.
createGroupConversation	Create a group conversation.

Data List	Description
friendList	List of friends.
groupList	List of groups.
blackList	Blacklist.
friendApplicationUnreadCount	Unread friend application count.
friendGroupList	List of friend groups.
friendApplicationList	List of friend applications.
groupApplicationList	List of group applications.

Function List	Description
setGroupApplicationList	Set the group application list.
setFriendList	Set the friend list.
setGroupList	Set the group list.
setBlackList	Set the blacklist.
setFriendApplicationUnreadCount	Set unread friend application count.
setFriendGroupList	Set the friend group list.
setFriendApplicationList	Set the friend application list.
initContactListWatcher	Initialize contact list watcher.
addFriend	Add a friend.
markFriendApplicationAsRead	Mark friend applications as read.
acceptFriendApplication	Accept a friend application.
refuseFriendApplication	Refuse a friend application.
addToBlacklist	Add a user to the blacklist.
removeFromBlacklist	Remove a user from the blacklist.
deleteFriend	Delete a friend.
setFriendRemark	Set a friend's remark.
createFriendGroup	Create a friend group.
deleteFriendGroup	Delete a friend group.
addToFriendGroup	Add a user to a friend group.
removeFromFriendGroup	Remove a user from a friend group.
renameFriendGroup	Rename a friend group.
joinGroup	Join a group.
acceptGroupApplication	Accept a group application.
refuseGroupApplication	Refuse a group application.