React Native
AtomicXCore SDK is the next-generation reactive API suite from TRTC, purpose-built for video live streaming, audio chat rooms, and similar real-time scenarios. With AtomicXCore, you can quickly build custom UI pages and leverage a comprehensive set of 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/video performance. This page provides a complete reference of all AtomicXCore SDK APIs, organized by functional module.
LoginState
User Authentication and Login Management
Core Features: Handles user authentication, manages login state, maintains user information, and provides essential authentication services.
Reactive Data
Data List | Description |
Details of the currently logged-in user. | |
Current authentication status. |
API Functions
Function List | Description |
Authenticate and log in the user. | |
Log out the current user. | |
Update user profile information. |
LiveListState
Live Stream List Management
Core Features: Manages the complete lifecycle of live rooms, including creation, joining, leaving, ending, and other core operations.
Technical Highlights: Supports paginated loading, real-time status sync, dynamic updates to live stream info, and reactive data binding for seamless UI/data synchronization.
Business Value: Delivers robust live room management for streaming platforms, scales to large concurrent live scenarios, and forms the backbone of live streaming infrastructure.
Scenarios: Live Stream List display, live room creation, live status management, Data Statistics, and other key business workflows.
Reactive Data
Data List | Description |
Live Stream List data. | |
Cursor for paginated loading of the Live Stream List. | |
Current live stream details. |
API Functions
Function List | Description |
Retrieve the Live Stream List. | |
Create a new live room. | |
Join an existing live room. | |
Leave the current live room. | |
End the live stream. | |
Update live stream details. | |
Register a Live Stream List event listener. | |
Unregister a Live Stream List event listener. |
LiveSeatState
Live Room Seat Management
Core Features: Manages seat control for multi-user co-hosting, including advanced seat state management and audio/video device operations.
Technical Highlights: Built on WebRTC, supports multi-stream audio/video, seat locking, device control, permission management, and more.
Business Value: Powers interactive streaming scenarios like PK, co-hosting, multiplayer games, and other multi-user experiences.
Scenarios: Multi-user co-hosting, host PK, interactive games, online education, conference live streaming, and other real-time audio/video scenarios.
Reactive Data
Data List | Description |
List of seats (co-host positions). | |
Canvas layout information. | |
Users currently speaking. |
API Functions
Function List | Description |
Join as a co-host by taking a seat. | |
Step down from the co-host seat. | |
Mute the microphone. | |
Unmute the microphone. | |
Remove a user from their seat. | |
Move a user to a 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. | |
Register a seat event listener. | |
Unregister a seat event listener. |
LiveAudienceState
Live Room Audience Management
Core Features: Manages the audience list, controls audience permissions, assigns administrators, and provides moderation tools for live rooms.
Technical Highlights: Supports real-time audience updates, hierarchical permission management, batch operations, and advanced moderation to maintain order and optimize user experience.
Business Value: Offers a complete audience management solution for streaming platforms, enabling effective moderation in large-scale live rooms.
Scenarios: Audience management, permission control, live room moderation, audience interaction, and other core workflows.
Reactive Data
Data List | Description |
List of audience members in the live room. | |
Total audience count. |
API Functions
Function List | Description |
Retrieve the audience list. | |
Assign an administrator role. | |
Remove administrator privileges. | |
Remove a user from the live room. | |
Disable message sending for a user. | |
Register an audience event listener. | |
Unregister an audience event listener. |
DeviceState
Device Status Management
Core Features: Controls audio/video devices (camera, microphone), monitors device status, checks permissions, and provides essential device services.
Technical Highlights: Enables multi-device management, real-time device monitoring, dynamic permission checks, automatic device recovery, and more.
Business Value: Ensures reliable audio/video capture and a stable device foundation for live streaming systems.
Scenarios: Device management, permission control, audio/video capture, device error handling, and other foundational use cases.
Reactive Data
Data List | Description |
Microphone enabled/disabled status. | |
Last microphone error. | |
Audio publishing permission status. | |
Capturing volume (0-100). | |
Current microphone volume (0-100). | |
Output volume (0-100). | |
Camera enabled/disabled status. | |
Last camera error. | |
Indicates if the front camera is active. | |
Local video mirroring type. | |
Local video quality settings. | |
Current audio output route (speaker/headphones). | |
Screen sharing status. | |
Network status information. |
API Functions
Function List | Description |
Enable the local microphone. | |
Disable the local microphone. | |
Adjust the capturing volume. | |
Adjust the output volume. | |
Enable the local camera. |
CoGuestState
Guest Co-host Management
Core Features: Manages audience-to-host co-hosting interactions, including application, invitation, acceptance, and rejection workflows.
Technical Highlights: Built on real-time audio/video technology, supports instant co-hosting status sync, adaptive audio/video quality, network monitoring, and more.
Business Value: Enables interactive audience participation for live streaming platforms, boosting engagement and entertainment.
Scenarios: Audience co-hosting, interactive Q&A, online karaoke, game streaming, and other audience-driven scenarios.
Reactive Data
Data List | Description |
Connected guest co-hosts. | |
Users invited to co-host. | |
Users applying to co-host. | |
Candidate users eligible for co-host invitations. |
API Functions
Function List | Description |
Apply for a co-host seat. | |
Cancel a co-host application. | |
Approve 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. | |
Decline a co-host invitation. | |
Disconnect from co-hosting. | |
Register a guest-side co-host event listener. | |
Unregister a guest-side co-host event listener. | |
Register a host-side co-host event listener. | |
Unregister a host-side co-host event listener. |
CoHostState
Co-host Management
Core Features: Enables host-to-host co-hosting, including invitations, applications, status management, and interactive features between hosts.
Technical Highlights: Supports multi-host audio/video sync, picture-in-picture layouts, audio/video optimization, and advanced streaming technologies for seamless co-hosting.
Business Value: Facilitates host collaboration, PK battles, and advanced live streaming scenarios for platforms.
Scenarios: Host PK, collaborative streaming, cross-platform co-hosting, host interaction, and advanced live streaming use cases.
Reactive Data
Data List | Description |
Connected co-hosts. | |
Hosts invited for co-hosting. | |
Host currently applying for co-hosting. | |
Candidate hosts eligible for co-hosting invitations. | |
Current co-hosting status. |
API Functions
Function List | Description |
Request a co-hosting connection. | |
Cancel a co-hosting request. | |
Accept a co-hosting request. | |
Reject a co-hosting request. | |
Exit the co-hosting session. | |
Register a co-host event listener. | |
Unregister a co-host event listener. |
AudioEffectState
Audio Effects Processing
Core Features: Delivers advanced audio effects including voice changing, reverb, ear monitoring, and real-time effect adjustments.
Technical Highlights: Powered by TRTC's Tianlai Lab audio algorithms, supports real-time processing, low-latency audio transmission, and audio quality enhancement.
Business Value: Enables unique audio experiences for live streaming platforms, increasing user engagement and entertainment.
Scenarios: Voice-changing live streaming, karaoke, audio entertainment, professional audio effects, and other audio processing scenarios.
Reactive Data
Data List | Description |
Ear monitoring enabled status. | |
Ear monitor volume level. | |
Voice changing effect type. | |
Reverb effect type. |
API Functions
Function List | Description |
Apply a voice changing effect. | |
Apply a reverb effect. | |
Enable or disable ear monitoring. | |
Set ear monitor volume. |
BarrageState
Live Comments Management
Core Features: Manages live comments (text and custom messages) in live rooms, supports sending comments, message sync, and a full-featured live comments system.
Technical Highlights: Handles high-concurrency messaging, real-time sync, message filtering, emoji support, and more.
Business Value: Powers interactive features for live streaming platforms, driving user engagement and fostering a lively streaming environment.
Scenarios: Live comments interaction, message management, emoji packs, chatroom, and other social features.
Reactive Data
Data List | Description |
Live comments message list for the current room. | |
Indicates if sending messages is allowed. |
API Functions
Function List | Description |
Send a text live comment. | |
Send a custom live comment. |
BaseBeautyState
Basic Beauty Effects
Core Features: Provides skin smoothing, whitening, and rosiness adjustments with real-time beauty parameter tuning.
Technical Highlights: Utilizes AI-powered beauty algorithms for smooth real-time processing and optimized performance.
Business Value: Delivers essential beauty features for live streaming platforms, improving user appearance and stream quality.
Scenarios: Beauty live streaming, appearance enhancement, beauty adjustment, stream beautification, and other beauty-related use cases.
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. | |
Rosiness level (0-9): 0 is off, 9 is maximum. |
API Functions
Function List | Description |
Adjust skin smoothing level. | |
Adjust whitening level. | |
Adjust rosiness level. |
GiftState
Gift System Management
Core Features: Manages gift sending and receiving, gift list management, gift categorization, gift animation, Data Statistics, and a complete gift economy system.
Technical Highlights: Supports gift animation rendering, Gift AR (Augmented Reality), Data Statistics, gift leaderboard, and more.
Business Value: Enables monetization for live streaming platforms, supporting gift economies, virtual currency, and related business models.
Scenarios: Tipping, virtual currency, Gift AR, Data Statistics, and other monetization scenarios.
Reactive Data
Data List | Description |
Available gifts list. |
API Functions
Function List | Description |
Refresh available gifts. | |
Send a gift. | |
Register a gift event listener. | |
Unregister a gift event listener. |
LikeState
Like Interaction
Core Features: Manages the like feature in live rooms, including sending likes, tracking like statistics, and handling like events.
Technical Highlights: Supports high-concurrency like processing, real-time statistics, animated like effects, like leaderboard, and more.
Business Value: Provides essential interactive features for live streaming platforms, boosting user engagement and stream popularity.
Scenarios: Like interaction, popularity metrics, interactive effects, user participation, and other engagement scenarios.
Reactive Data
Data List | Description |
Total like count. |
API Functions
Function List | Description |
Send a like. | |
Register a like event listener. | |
Unregister a like event listener. |
