AtomicXCore SDK is TRTC's next-generation scenario-based API framework designed for live streaming and voice chat room applications. It enables you to quickly build custom UIs with minimal effort.
The SDK offers comprehensive features including room management, screen sharing, member management, microphone seat control, and built-in beauty filters. Built on top of TRTC, it delivers ultra-low latency and high-quality audio/video experiences.
This page provides a complete reference of all AtomicXCore SDK (Android) APIs, organized by feature module.
LoginStore
User Identity Authentication and Login Management Module
Core features: Responsible for user authentication, login status management, user information maintenance and other basic authentication services.
Responsive data
|
| Current logged-in user info. |
| Current log-in status. |
API Function
|
| Login method. |
| Logout method. |
| Set user information. |
| Add login callback event listener. |
| Remove login callback event listener. |
LiveListStore
Live Streaming List Management Module
Core Features: Manages the complete lifecycle of live streaming rooms, including creation, joining, leaving, and core business workflows.
Technical Features:
Supports paginated loading, real-time status synchronization, and dynamic live streaming information updates.
Implements reactive data management using Kotlin Flow to ensure seamless synchronization between UI and data states.
Benefits: Provides essential live room management capabilities for live streaming platforms, handles high-concurrency scenarios at scale, and serves as the foundational infrastructure for live streaming services.
Use Cases: Live stream list display, room creation, live status management, and broadcast analytics.
Responsive data
|
| Live stream list data. |
| Live list cursor, used for load by page. |
| Current live streaming information. |
API Function
|
| Retrieve the live stream list. |
| Retrieve live room information based on the live streaming room ID. |
| Create live streaming room. |
| Join live room. |
| Leave the live streaming room. |
| End live stream. |
| Update live streaming information. |
| Add live stream list events listener. |
| Remove live stream list event listener. |
LiveSeatStore
Live Streaming Seat Management Module
Core Features: Enables seat control in multi-user voice chat scenarios, supporting complex seat state management and audio/video device control.
Technical Features:
Built on WebRTC technology with multi-stream management capabilities
Supports seat locking and unlocking
Provides audio/video device control
Implements role-based permission management
Benefits: Delivers essential technology infrastructure for interactive live streaming, enabling various engagement scenarios such as co-hosting, anchor battles (PK), and multiplayer interactions.
Use Cases: Multi-user audio/video interaction scenarios including co-hosting streams, anchor competitions, interactive games, online education, and live conferencing.
Responsive data
|
| Seat List. |
| Canvas information. |
| List of users currently speaking. |
| Audio/Video stats. |
API Function
|
| User joins the stage. |
| User Microphone Dequeuing. |
| Silent microphone. |
| Unmute the microphone. |
| Kick out the user. |
| Move the user to the stage. |
| Lock the seat. |
| Unlock the mic. |
| Enable the remote user's camera. |
| Turn the remote user's camera off. |
| Enable the remote user's microphone. |
| Turn the remote user's microphone off. |
| Add mic seat event listener. |
| Remove mic seat event listener. |
LiveAudienceStore
Live Streaming Audience Management Module
Core Features: Manages live room audience lists with permission control, admin configuration, and moderation tools to maintain room order.
Technical Features:
Real-time audience list updates
Hierarchical permission management
Batch operations support
Advanced moderation controls
Benefits: Delivers comprehensive audience management solutions for live streaming platforms, ensuring smooth moderation at scale.
Use Cases: Audience list management, permission control, room moderation, and audience interaction management.
Responsive data
|
| Live streaming room audience list. |
| Live streaming room audience size. |
| List of muted users. |
API Function
|
| Retrieve the audience list. |
| Set administrator. |
| Revoke administrator. |
| Kick the user out of the room. |
| Disable sending messages. |
| Add audience listener. |
| Remove audience listener. |
DeviceStore
Device Status Management Module
Core Features: Manage control of cameras, microphones and other audio/video devices, provide device status monitoring, permission check and other basic device services.
Technical Features: Support advanced functions such as multi-device management, real-time status monitoring, dynamic permission check, and automatic failure recovery.
Benefits: Provide stability to the device base for the live streaming system, underwrite reliability of audio and video capture and user experience.
Use Cases: Basic technical scenarios such as device management, permission control, audio and video capture, and device failure handling.
Responsive data
|
| Microphone on status. |
| Microphone last error status. |
| Audio Capturing volume (0-100). |
| Current microphone volume (0-100). |
| Audio output volume (0-100). |
| Camera on status. |
| Camera last error status. |
| Whether the camera is front-facing. |
| Local image type. |
| Local video quality settings. |
| Current audio output route (speaker/headphone). |
| Screen sharing status. |
| Network information status. |
API Function
|
| Open local microphone. |
| Close local microphone. |
| Set the capture volume. |
| Set the output volume. |
| Set audio output routing. |
| Preview the front camera, the video preview will be rendered on the cameraView parameter. |
| Stop camera preview. |
| Turn on local camera. |
| Turn off local camera. |
| Switch camera. true: front camera, false: rear camera. |
| Set camera mirror. |
| Set streaming resolution. |
| Enable screen sharing. |
| Disable screen sharing. |
CoGuestStore
Guest Management Module
Core Features: Manages interactive co-hosting between audience members and anchors, handling the complete workflow of mic requests, invitations, acceptances, and rejections.
Technical Features:
Built on real-time audio/video technology
Real-time co-hosting status synchronization
Adaptive audio/video quality adjustment based on network conditions
Network quality monitoring and optimization
Benefits: Enables audience participation and engagement on live streaming platforms, increasing user retention and enhancing stream interactivity.
Use Cases: Interactive scenarios such as audience co-hosting, live Q&A sessions, online karaoke, and gaming streams.
Responsive data
|
| Connected guest list. |
| List of users invited to speak. |
| List of users requesting to speak. |
| List of candidate users available for invitation to speak. |
API Function
|
| Apply for a mic-connection seat. |
| Cancel the application. |
| Accept application. |
| Reject application. |
| Invitation to speak. |
| Cancel invitation. |
| Accept invitation. |
| Reject invitation. |
| Disconnect. |
| Add guest-side event listener for co-streaming. |
| Remove guest-side event listener for co-streaming. |
| Add Anchor-side event listener for co-streaming. |
| Remove Anchor-side event listener for co-streaming. |
CoHostStore
Co-hosting Management Module
Core Features: Enables real-time collaboration between anchors, supporting invitations, connection requests, status management, and interactive workflows.
Technical Features:
Multi-anchor audio/video synchronization
Picture-in-Picture (PiP) display
Adaptive audio/video quality optimization
Low-latency stream coordination
Benefits: Delivers essential infrastructure for anchor collaboration on live streaming platforms, powering advanced engagement scenarios such as anchor battles and co-streaming.
Use Cases: Advanced streaming scenarios including anchor competitions (PK), co-streaming, cross-platform collaboration, and multi-anchor interactions.
Responsive data
|
| Connected Anchor list. |
| Invited Anchor list. |
| Currently applied Anchor information for connecting line. |
| Current connection status. |
API Function
|
| Request connection. |
| Cancel the connection request. |
| Accept the connection request. |
| Reject connection request. |
| Exit connection. |
| Add event listener for connected host. |
| Remove event listener for connected host. |
AudioEffectStore
Audio Processing Module
Core Features: Offer advanced sound effect functions such as voice-changing, reverb, and ear monitoring, support various audio effects and real-time sound effect adjustment.
Technical Features: Support advanced technologies like real-time audio processing, low delay audio transmission, and sound quality optimization.
BusinessValue: Provide differentiated audio experience for live streaming platforms, enhance user engagement and live stream fun.
Use Cases: Scenarios requiring audio processing, such as voice-changing live stream, karaoke live stream, sound effects entertainment, and professional audio effects.
Responsive data
|
| Toggle status |
| Volume of IEMs. |
| Voice-changing status. |
| Reverberation status. |
API Function
|
| Set the voice changing effect. |
| Set the reverb effect. |
| Set the toggle status. |
| Set the volume of IEMs. |
BarrageStore
Live Comments and Messaging Module
Core Features: Handles text messages, custom messages, and live comments in streaming rooms, supporting message sending, status synchronization, and a complete commenting system.
Technical Features:
High-concurrency message processing
Real-time message synchronization
Message filtering and moderation
Emoji and sticker support
Custom message formats
Benefits: Delivers essential interactive capabilities for live streaming platforms, boosting user engagement and fostering community interaction.
Use Cases: Live comments, chat management, emoji and sticker interactions, and in-stream messaging.
Responsive data
|
| Bullet screen messages of the current room. |
API Function
|
| Send text type bullet screen. |
| Send custom type bullet screen. |
BaseBeautyStore
Basic Beauty Filter Module
Core Features: Provide basic beauty effects such as skin smoothing, whitening, and rosy skin, supporting real-time beautification parameter adjustment.
Technical Features: Support advanced technologies such as real-time beautification processing, smooth parameter adjustment, and performance optimization.
Benefits: Provide basic beauty effect capability for live streaming platforms to enhance user image and streaming quality.
Use Cases: Live streams, image optimization, beauty adjustment, and beautification in scenarios where smart beautification capabilities are required.
Responsive data
|
| Smoothing level value ranges from 0 to 9: 0 means disabling, 9 indicates the most obvious effect. |
| Whiteness level value ranges from 0 to 9: 0 means disabling, 9 indicates the most clear effect. |
| Rosy level value ranges from 0 to 9: 0 means disabling, 9 indicates the most clear effect. |
API Function
|
| Set the skin smoothing level. |
| Set the whitening level. |
| Set the rosy level. |
GiftStore
Gift System Management Module
Core Features: Manages gift sending, receiving, and inventory, supporting gift categorization, animations, statistics, and a complete virtual gifting economy.
Technical Features:
Gift animation rendering and effects
Real-time gift statistics and tracking
Leaderboard and ranking system
Multi-tier gift categorization
Transaction history management
Benefits: Enables core monetization capabilities for live streaming platforms, supporting virtual economy and revenue generation.
Use Cases: Virtual gifting, in-app purchases, animated gift effects, gift leaderboards, and revenue analytics.
Responsive data
API Function
|
| Refresh the available gift list. |
| Send a gift. |
| Add gift event listener. |
| Remove gift event listener. |
LikeStore
Like Interaction Module
Core Features: Manages like interactions in streaming rooms, supporting like sending, statistics tracking, event monitoring, and engagement metrics.
Technical Features:
High-concurrency like processing
Real-time like statistics and aggregation
Animated like effects and visual feedback
Popularity leaderboards and rankings
Batch like event handling
Benefits: Enables basic engagement features for live streaming platforms, driving user interaction and community participation.
Use Cases: Like interactions, popularity metrics, engagement tracking, and audience sentiment analysis.
Responsive data
API Function
|
| Send a like. |
| Add event listener for like. |
| Remove event listener for like. |