API Reference
AtomicXCore SDK is the next-generation reactive API from TRTC, purpose-built for live streaming, and voice chat rooms. This API suite enables rapid UI development and supports comprehensive features including room management, 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.
LoginStore
User Authentication and Login Management
Core Features: Provide user authentication, manages login state, maintains user profiles, and delivers essential authentication services.
Reactive Data
Data List | Description |
Information about the currently logged-in user. | |
Current login status. |
API Functions
Function List | Description |
Authenticate and log in a user. | |
Log out the current user. | |
Update the user's profile information. |
LiveListStore
Live Room List Management
Core Features: Manage the complete lifecycle of live rooms, including creation, joining, leaving, and ending, covering all core business processes.
Technical Highlights: Support paginated loading, real-time status synchronization, dynamic live info updates, and uses reactive data management (Combine) to keep UI and data state synchronized.
Use Cases: Live room list display, room creation, live status management, live data statistics, and other core live streaming scenarios.
Reactive Data
Data List | Description |
Live room list data. | |
Cursor for paginated live room loading. | |
Information about the current live room. |
API Functions
Function List | Description |
Retrieve the live room list. | |
Create a new live room. | |
Join an existing live room. | |
Leave the current live room. | |
End the live stream. | |
Update live room information. | |
Query custom metadata. | |
Update custom metadata for the live room. |
LiveSeatStore
Live Room Seat Management
Core Features: Provide seat control for multi-user co-hosting scenarios, supporting advanced seat status management and audio/video device control.
Technical Highlights: Built on WebRTC, supports multi-stream audio/video management, seat locking, device control, and permission management.
Use Cases: Multi-user co-hosting, host PK, interactive games, online education, conference live streaming, and other multi-user live interaction scenarios.
Reactive Data
Data List | Description |
List of seats in the live room. | |
Canvas information for video layout. | |
List of users currently speaking. |
API Functions
Function List | Description |
Take a seat (join as co-host). | |
Leave the seat (exit co-host). | |
Mute the microphone. | |
Unmute the microphone. | |
Remove a user from a seat. | |
Move a user to a specified seat. | |
Lock a seat. | |
Unlock a seat. | |
Turn on a remote user's camera. | |
Turn off a remote user's camera. | |
Turn on a remote user's microphone. | |
Turn off a remote user's microphone. |
LiveAudienceStore
Live Room Audience Management
Core Features: Manage the audience list, controls audience permissions, sets administrators, and maintains order in the live room.
Technical Highlights: Provide real-time audience list updates, hierarchical permission management, batch operations, and advanced moderation features.
Use Cases: Audience management, permission control, live room moderation, audience interaction, and other live streaming scenarios.
Reactive Data
Data List | Description |
List of audience members in the live room. | |
Number of audience members. |
API Functions
Function List | Description |
Retrieve the audience list. | |
Assign administrator privileges. | |
Remove administrator privileges. | |
Remove a user from the room. | |
Disable a user's ability to send messages. |
DeviceStore
Device Status Management
Core Features: Control audio/video devices such as camera and microphone, monitors device status, and checks permissions.
Technical Highlights: Support multi-device management, real-time device status monitoring, dynamic permission checking, and automatic device recovery.
Use Cases: Device management, permission control, audio/video capture, device fault handling, and other foundational technical scenarios.
Reactive Data
Data List | Description |
Microphone enabled status. | |
Last microphone error. | |
Microphone capture volume (0-100). | |
Current microphone volume (0-100). | |
Audio output volume (0-100). | |
Camera enabled status. | |
Last camera error. | |
Indicates if the front camera is in use. | |
Local video mirror type. | |
Local video quality settings. | |
Current audio output route (speaker or earpiece). | |
Screen sharing status. | |
Current network information. |
API Functions
Function List | Description |
Enable the local microphone. | |
Disable the local microphone. | |
Set the microphone capture volume. | |
Set the audio output volume. | |
Enable the local camera. |
CoGuestStore
Co-Host Guest Management
Core Features: Manage co-host interactions between audience and host, including application, invitation, acceptance, and rejection workflows.
Technical Highlights: Utilize real-time audio/video technology, supports real-time co-hosting status sync, adaptive audio/video quality, and network monitoring.
Use Cases: Audience co-hosting, interactive Q&A, online karaoke, game streaming, and other audience participation scenarios.
Reactive Data
Data List | Description |
List of connected co-host guests. | |
List of users invited to co-host. | |
List of users applying to co-host. | |
List of candidate users available for co-host invitation. |
API Functions
Function List | Description |
Apply for a co-host seat. | |
Cancel a co-host application. | |
Accept a co-host application. | |
Reject a co-host application. | |
Invite a user to a co-host seat. | |
Cancel a co-host invitation. | |
Accept a co-host invitation. | |
Reject a co-host invitation. | |
Disconnect from co-host. |
CoHostStore
Host Connection Management
Core Features: Enable host-to-host connections, including invitations, connection requests, status management, and host interactions.
Technical Highlights: Support multi-host audio/video synchronization, picture-in-picture display, and audio/video quality optimization for seamless host collaboration.
Use Cases: Host PK, collaborative streaming, cross-platform co-hosting, host interaction, and advanced live streaming scenarios.
Reactive Data
Data List | Description |
List of connected hosts. | |
List of hosts invited to connect. | |
Host currently applying for connection. | |
Current host connection status. |
API Functions
Function List | Description |
Request a host-to-host connection. | |
Cancel a host connection request. | |
Accept a host connection request. | |
Reject a host connection request. | |
Exit a host connection. |
AudioEffectStore
Audio Effects Processing
Core Features: Provide advanced audio effects, including voice changing, reverb, and ear monitoring, with real-time audio adjustments.
Technical Highlights: Powered by Tencent Ethereal Lab's audio algorithms, supports real-time audio effects, low-latency transmission, and audio quality optimization.
Use Cases: Voice changer live streaming, karaoke, audio entertainment, professional audio effects, and other audio processing scenarios.
Reactive Data
Data List | Description |
Status of ear monitoring (on/off). | |
Ear monitor volume level. | |
Current voice changer effect. | |
Current reverb effect. |
API Functions
Function List | Description |
Set the voice changer effect. | |
Set the reverb effect. | |
Enable or disable ear monitoring. | |
Set the ear monitor volume. |
BarrageState
Barrage Message Management
Core Features: Manage barrage messaging in live rooms, including text and custom messages, with real-time message synchronization.
Technical Highlights: Support high-concurrency message processing, real-time sync, message filtering, emoji support, and more.
Use Cases: Barrage interaction, message management, emoji, chat room, and other social features.
Reactive Data
Data List | Description |
List of barrage messages for the current room. |
API Functions
Function List | Description |
Send a text barrage message. | |
Send a custom barrage message. |
BaseBeautyStore
Basic Beauty Effects
Core Features: Provide basic beauty adjustments, including skin smoothing, whitening, and ruddy effects, with real-time parameter tuning.
Technical Highlights: Utilize AI beauty algorithms for real-time processing, smooth parameter adjustment, and optimized performance.
Use Cases: Beauty live streaming, appearance enhancement, beauty adjustment, and live stream beautification.
Reactive Data
Data List | Description |
Skin smoothing level [0-9]: 0 is off, 9 is maximum. | |
Whitening level [0-9]: 0 is off, 9 is maximum. | |
Ruddy level [0-9]: 0 is off, 9 is maximum. |
API Functions
Function List | Description |
Set skin smoothing level. | |
Set whitening level. | |
Set ruddy level. |
GiftStore
Gift System Management
Core Features: Manage sending and receiving gifts, gift list management, gift categorization, gift animation, gift statistics, and a complete gift economy system.
Technical Highlights: Support gift animation rendering, effect processing, statistics, leaderboards, and more.
Use Cases: Gift tipping, virtual currency, gift effects, gift statistics, and other monetization scenarios.
Reactive Data
Data List | Description |
List of available gifts. |
API Functions
Function List | Description |
Refresh the available gift list. | |
Send a gift. |
LikeStore
Like Interaction
Core Features: Manage the like feature in live rooms, including sending likes, like statistics, event listening, and interactive effects.
Technical Highlights: Support high-concurrency like processing, real-time statistics, like animations, leaderboards, and more.
Use Cases: Like interaction, popularity statistics, interactive effects, user engagement, and other live streaming scenarios.
Reactive Data
Data List | Description |
Total number of likes. |
API Functions
Function List | Description |
Send a like. |
