atomicx-core SDK 是腾讯云最新推出的面向即时通信、音视频通话、视频直播、语聊房等场景的全新一代基于响应式的 API，您可以非常快速的基于这组 API 构建自己的 UI 页面，它支持房间管理、屏幕分享、成员管理、麦位控制、基础美颜等丰富功能，同时基于 TRTC SDK，能够提供超低延时、高品质的音视频体验，本页面包含 atomicx-core SDK 的所有 API 接口，按功能模块分类展示。
LoginState
用户身份认证与登录管理模块
核心功能：提供用户登录、登出、个人信息管理等基础身份认证功能，是整个系统的用户身份基础。
技术特点：支持多种登录方式、用户信息缓存、登录状态持久化等功能，确保用户身份的安全性和可靠性。
业务价值：为所有业务模块提供统一的用户身份认证服务，是系统安全和用户体验的基础保障。
应用场景：用户登录、身份验证、个人信息管理、权限控制等核心身份认证场景。
响应式数据
数据列表 | 描述 |
当前登录用户信息。 |
接口函数
函数列表 | 描述 |
用户登录。 | |
设置用户个人信息。 | |
用户登出函数。 |
DeviceState
设备状态管理模块
核心功能：管理摄像头、麦克风等音视频设备的控制，提供设备状态监控、权限检查等基础设备服务。
技术特点：支持多设备管理、设备状态实时监控、权限动态检查、设备故障自动恢复等高级功能。
业务价值：为直播系统提供稳定的设备基础，确保音视频采集的可靠性和用户体验。
应用场景：设备管理、权限控制、音视频采集、设备故障处理等基础技术场景。
响应式数据
数据列表 | 描述 |
麦克风状态。 | |
麦克风设备列表。 | |
当前选中的麦克风设备。 | |
麦克风最后一次错误信息。 | |
麦克风采集音量。 | |
当前麦克风音量。 | |
麦克风测试状态。 | |
测试时的麦克风音量。 | |
摄像头状态。 | |
摄像头设备列表。 | |
当前选中的摄像头设备。 | |
摄像头最后一次错误信息。 | |
摄像头测试状态。 | |
摄像头测试加载状态。 | |
是否为前置摄像头。 | |
本地视频镜像类型。 | |
本地视频质量。 | |
扬声器设备列表。 | |
当前选中的扬声器设备。 | |
扬声器输出音量。 | |
当前音频路由。 | |
扬声器测试状态。 | |
屏幕分享状态。 | |
网络信息。 |
接口函数
函数列表 | 描述 |
开启本地麦克风。 | |
关闭本地麦克风。 | |
静音本地音频。 | |
取消静音本地音频。 | |
获取麦克风设备列表。 | |
设置当前麦克风设备。 | |
开始麦克风测试。 | |
设置音频采集音量。 | |
设置音频播放音量。 | |
停止麦克风测试。 | |
获取扬声器设备列表。 | |
设置当前扬声器设备。 | |
设置音频路由。 | |
开始扬声器测试。 | |
停止扬声器测试。 | |
开启本地摄像头。 | |
关闭本地摄像头。 | |
获取摄像头设备列表。 | |
设置当前摄像头设备。 | |
切换前后摄像头。 | |
切换视频镜像模式。 | |
更新视频质量。 | |
开始摄像头设备测试。 | |
开始屏幕分享。 | |
停止屏幕分享。 | |
停止摄像头设备测试。 | |
屏幕分享停止回调。 |
LiveListState
直播列表管理模块
核心功能：管理直播间的完整生命周期，包括创建、加入、离开、结束等核心业务流程，支持直播列表的分页获取和实时更新。
技术特点：支持分页加载、实时状态同步、直播信息动态更新，采用响应式数据管理，确保 UI 与数据状态实时同步。新增 liveList 和 liveListCursor 响应式数据，提供 fetchLiveList 接口函数。
业务价值：为直播平台提供核心的直播间管理能力，支持大规模并发直播场景，是直播业务的基础设施。
应用场景：直播列表展示、直播间创建、直播状态管理、直播数据统计等核心业务场景。
响应式数据
数据列表 | 描述 |
转换TUILiveInfo为LiveInfo格式。 | |
直播列表数据，包含所有直播间的信息。 | |
直播列表分页游标，用于获取下一页数据。 |
接口函数
函数列表 | 描述 |
创建直播间。 | |
加入直播间。 | |
离开直播间。 | |
结束直播。 | |
更新直播间信息。 | |
查询元数据。 | |
更新直播间元数据。 | |
获取直播列表。 |
LiveSeatState
直播间座位管理模块
核心功能：实现多人连麦场景下的座位控制，支持复杂的座位状态管理和音视频设备控制，包括上麦、下麦、座位锁定等完整功能。
技术特点：基于 WebRTC 技术，支持多路音视频流管理，提供座位锁定、设备控制、权限管理等高级功能。新增 seatList、canvas、speakingUsers、networkQualities 响应式数据，以及完整的座位操作接口。
业务价值：为多人互动直播提供核心技术支撑，支持 PK、连麦、多人游戏等丰富的互动场景。
应用场景：多人连麦、主播 PK、互动游戏、在线教育、会议直播等需要多人音视频互动的场景。
响应式数据
数据列表 | 描述 |
麦位列表，包含所有麦位的状态和用户信息。 | |
画布配置，用于视频渲染和布局管理。 | |
正在发言的用户列表。 | |
网络质量信息，包含各用户的网络状态。 |
接口函数
函数列表 | 描述 |
用户上麦。 | |
用户下麦。 | |
锁定麦位。 | |
解锁麦位。 | |
踢用户下麦。 | |
移动用户到指定麦位。 | |
开启远端摄像头。 | |
关闭远端摄像头。 | |
开启远端麦克风。 | |
关闭远端麦克风。 | |
静音麦克风。 | |
取消静音麦克风。 | |
开始播放流。 | |
停止播放流。 |
LiveAudienceState
直播间观众管理模块
核心功能：管理直播间观众列表，提供观众权限控制、管理员设置等直播间秩序维护功能，支持实时观众统计。
技术特点：支持实时观众列表更新、权限分级管理、批量操作等高级功能，确保直播间秩序和用户体验。新增 audienceList 和 audienceCount 响应式数据。
业务价值：为直播平台提供完整的观众管理解决方案，支持大规模观众场景下的秩序维护。
应用场景：观众管理、权限控制、直播间秩序维护、观众互动管理等核心业务场景。
响应式数据
数据列表 | 描述 |
观众列表，包含直播间所有观众的信息。 | |
观众总数统计。 |
接口函数
函数列表 | 描述 |
获取观众列表。 | |
设置管理员。 | |
撤销管理员。 | |
踢出房间。 | |
禁言用户。 |
LiveMonitorState
直播监控管理模块
核心功能：提供直播间实时监控功能，包括直播状态监控、数据统计、异常检测等核心监控能力，支持多直播间监控。
技术特点：支持实时数据采集、多维度监控指标、智能告警机制，确保直播服务的稳定性和可靠性。新增 monitorLiveInfoList 响应式数据，优化监控接口。
业务价值：为直播平台提供全方位的监控保障，及时发现和处理异常情况，提升服务质量。
应用场景：直播质量监控、性能分析、异常告警、数据统计等运营管理场景。
响应式数据
数据列表 | 描述 |
监控的直播间信息列表。 |
接口函数
函数列表 | 描述 |
初始化监控。 | |
获取直播列表。 | |
关闭房间。 | |
发送消息。 | |
开始播放。 | |
停止播放。 | |
静音直播音频。 |
CoGuestState
连麦嘉宾管理模块
核心功能：处理观众与主播之间的连麦互动，管理连麦申请、邀请、接受、拒绝等完整的连麦流程，支持连麦状态管理。
技术特点：基于实时音视频技术，支持连麦状态实时同步、音视频质量自适应、网络状况监控等高级功能。新增 connected、invitees、applicants、candidates 响应式数据和 applyForSeat 接口。
业务价值：为直播平台提供观众参与互动的核心能力，增强用户粘性和直播趣味性。
应用场景：观众连麦、互动问答、在线K歌、游戏直播等需要观众参与的互动场景。
响应式数据
数据列表 | 描述 |
取消订阅连麦事件。 | |
连麦连接状态。 | |
被邀请的用户列表。 | |
申请连麦的用户列表。 |
接口函数
函数列表 | 描述 |
取消申请。 | |
接受申请。 | |
拒绝申请。 | |
取消邀请。 | |
接受邀请。 | |
拒绝邀请。 | |
断开连接。 | |
申请上麦。 |
CoHostState
连麦主播管理模块
核心功能：实现主播间的连麦功能，支持主播邀请、连麦申请、连麦状态管理等主播间互动功能，提供完整的主播连麦流程。
技术特点：支持多主播音视频同步、画中画显示、音视频质量优化等高级技术，确保连麦体验的流畅性。新增 coHostStatus、connected、applicant、invitees、candidates 响应式数据和完整的连麦控制接口。
业务价值：为直播平台提供主播间协作的核心能力，支持 PK、合作直播等高级业务场景。
应用场景：主播 PK、合作直播、跨平台连麦、主播互动等高级直播场景。
响应式数据
数据列表 | 描述 |
连麦主播状态。 | |
连麦连接状态。 | |
申请连麦的主播信息。 | |
被邀请的用户列表。 | |
候选用户列表。 |
接口函数
函数列表 | 描述 |
请求主播连麦。 | |
取消主播连麦。 | |
接受主播连麦。 | |
拒绝主播连麦。 | |
退出主播连麦。 |
BattleState
PK 对战管理模块
核心功能：管理主播间的 PK 对战功能，包括对战邀请、接受、拒绝、结束等完整的 PK 流程，支持实时比分统计。
技术特点：支持实时对战状态同步、比分计算、对战结果统计等功能。新增 battleScore 响应式数据，提供完整的 PK 对战体验。
业务价值：为直播平台提供竞技互动功能，增强直播趣味性和用户参与度。
应用场景：主播 PK、才艺比拼、游戏对战、互动竞技等娱乐场景。
响应式数据
数据列表 | 描述 |
当前PK信息。 | |
PK参与用户列表。 | |
PK对战的实时比分。 |
接口函数
函数列表 | 描述 |
请求 PK。 | |
取消 PK 请求。 | |
接受 PK。 | |
拒绝 PK。 | |
退出 PK。 |
BarrageState
弹幕消息管理模块
核心功能：处理直播间内的文本消息、自定义消息等弹幕功能，支持弹幕发送、消息状态同步等完整弹幕系统，提供本地提示功能。
技术特点：支持高并发消息处理、实时消息同步、消息过滤、表情包支持等高级功能。新增 sendTextMessage、sendCustomMessage、appendLocalTip 接口函数。
业务价值：为直播平台提供核心的互动能力，增强用户参与度和直播氛围。
应用场景：弹幕互动、消息管理、表情包、聊天室等社交互动场景。
响应式数据
数据列表 | 描述 |
弹幕消息列表。 |
接口函数
函数列表 | 描述 |
发送文本消息。 | |
发送自定义消息。 | |
添加本地提示。 |
MessageListState
消息列表管理模块
核心功能：管理聊天消息列表，支持消息加载、滚动控制、已读回执、消息高亮等完整的消息展示功能。
技术特点：支持虚拟滚动、消息优化、实时更新等高性能消息处理。新增 activeConversationID、messageList、hasMoreOlderMessage 等响应式数据。
业务价值：为即时通信提供核心的消息展示能力，确保良好的聊天体验。
应用场景：即时通信、群聊、私聊、消息管理等通信场景。
响应式数据
数据列表 | 描述 |
当前活跃的会话 ID。 | |
消息列表数据。 | |
是否有更多旧消息。 | |
是否有更多新消息。 | |
是否启用已读回执。 | |
是否禁用滚动。 | |
已撤回消息的 ID 集合。 | |
高亮消息的 ID 集合。 |
接口函数
函数列表 | 描述 |
设置已读回执。 | |
设置滚动禁用。 | |
高亮消息。 |
MessageInputState
消息输入管理模块
核心功能：管理消息输入框的状态和行为，支持文本输入、表情包、@功能、输入状态提示等完整的输入体验。
技术特点：支持富文本编辑、输入状态同步、草稿保存等功能。新增 inputRawValue、isPeerTyping 响应式数据。
业务价值：为用户提供便捷的消息输入体验，提升沟通效率。
应用场景：消息编辑、表情输入、文件发送、语音输入等输入场景。
响应式数据
数据列表 | 描述 |
输入框的原始文本内容。 | |
对方是否正在输入。 |
接口函数
函数列表 | 描述 |
更新原始值。 | |
设置编辑器实例。 | |
设置内容。 | |
插入内容。 | |
聚焦编辑器。 | |
失焦编辑器。 | |
发送消息。 |
MessageActionState
消息操作管理模块
核心功能：管理消息的各种操作，包括转发、引用、复制、删除、撤回等完整的消息操作功能。
技术特点：支持批量操作、操作状态管理、权限控制等功能。新增 forwardMessageIDList、isForwardMessageSelectionDone 等响应式数据。
业务价值：为用户提供丰富的消息操作能力，提升使用体验。
应用场景：消息转发、消息引用、消息管理、批量操作等场景。
响应式数据
数据列表 | 描述 |
要转发的消息 ID 列表。 | |
消息转发选择是否完成。 | |
转发目标会话 ID 列表。 | |
被引用的消息信息。 |
接口函数
函数列表 | 描述 |
转发消息。 | |
设置转发消息列表。 | |
设置转发选择完成。 | |
设置转发会话列表。 | |
引用消息。 | |
清除引用消息。 | |
复制文本消息。 | |
删除消息。 | |
撤回消息。 | |
重置消息操作状态。 |
ConversationListState
会话列表管理模块
核心功能：管理用户的会话列表，支持会话排序、未读统计、会话操作等完整的会话管理功能。
技术特点：支持实时会话更新、智能排序、网络状态监控等功能。新增 conversationList、activeConversation、totalUnRead、netStatus 响应式数据。
业务价值：为用户提供清晰的会话管理界面，提升沟通效率。
应用场景：会话管理、联系人列表、群组管理、消息中心等场景。
响应式数据
数据列表 | 描述 |
会话列表数据。 | |
当前活跃的会话。 | |
未读消息总数。 | |
网络连接状态。 |
接口函数
函数列表 | 描述 |
标记会话未读。 | |
设置活跃会话。 | |
置顶会话。 | |
删除会话。 | |
静音会话。 | |
设置会话草稿。 | |
创建单聊会话。 | |
创建群聊会话。 |
ContactListState
联系人管理模块
核心功能：管理用户的联系人列表，包括好友管理、群组管理、黑名单管理等完整的联系人功能。
技术特点：支持联系人分组、好友申请处理、群组申请管理等功能。新增 friendList、groupList、blackList 等响应式数据和完整的联系人操作接口。
业务价值：为用户提供完整的社交关系管理能力，构建社交网络。
应用场景：好友管理、群组管理、联系人搜索、社交网络等场景。
响应式数据
数据列表 | 描述 |
好友列表。 | |
群组列表。 | |
黑名单列表。 | |
好友申请未读数。 | |
好友分组列表。 | |
好友申请列表。 | |
群申请列表。 |
接口函数
函数列表 | 描述 |
设置群组申请列表。 | |
设置好友列表。 | |
设置群组列表。 | |
设置黑名单列表。 | |
设置好友申请未读数。 | |
设置好友分组列表。 | |
设置好友申请列表。 | |
初始化联系人监听器。 | |
添加好友。 | |
标记好友申请为已读。 | |
接受好友申请。 | |
拒绝好友申请。 | |
添加到黑名单。 | |
从黑名单移除。 | |
删除好友。 | |
设置好友备注。 | |
创建好友分组。 | |
删除好友分组。 | |
添加到好友分组。 | |
从好友分组移除。 | |
重命名好友分组。 | |
加入群组。 | |
接受群组申请。 | |
拒绝群组申请。 |
C2CSettingState
单聊设置管理模块
核心功能：管理单聊会话的各种设置，包括用户信息、聊天设置、权限控制等功能。
技术特点：支持实时设置同步、权限管理、个性化配置等功能。更新响应式数据为 userID、avatar、signature 等标准化字段。
业务价值：为用户提供个性化的单聊体验，提升沟通质量。
应用场景：单聊设置、用户信息管理、聊天权限控制等场景。
响应式数据
数据列表 | 描述 |
当前会话引用。 | |
用户 ID。 | |
用户昵称。 | |
用户头像。 | |
用户个性签名。 | |
好友备注名。 | |
会话静音状态。 | |
会话置顶状态。 | |
好友关系状态。 | |
用户 ID。 | |
用户头像 URL。 | |
用户个性签名。 | |
用户备注名。 | |
是否已静音。 | |
是否已置顶。 | |
是否为联系人。 |
接口函数
函数列表 | 描述 |
设置聊天置顶。 | |
设置聊天免打扰。 | |
设置用户备注。 |
GroupSettingState
群聊设置管理模块
核心功能：管理群聊的各种设置和操作，包括群信息管理、成员管理、权限控制等完整的群管理功能。
技术特点：支持群权限管理、成员操作、群设置同步等功能。新增 groupID、groupType、groupName 等完整的群信息响应式数据和管理接口。
业务价值：为群主和管理员提供完整的群管理能力，维护群秩序。
应用场景：群管理、成员管理、权限控制、群设置等场景。
响应式数据
数据列表 | 描述 |
群组 ID。 | |
群组类型。 | |
群组名称。 | |
用户头像 URL。 | |
群组介绍。 | |
群组公告。 | |
是否已静音。 | |
是否已置顶。 | |
群主信息。 | |
管理员列表。 | |
所有成员列表。 | |
成员总数。 | |
最大成员数。 | |
当前用户 ID。 | |
当前用户角色。 | |
用户名片。 | |
是否禁言所有成员。 | |
是否在群组中。 | |
邀请选项。 |
接口函数
函数列表 | 描述 |
获取群成员列表。 | |
更新群资料。 | |
添加群成员。 | |
删除群成员。 | |
转让群主。 | |
设置群成员角色。 | |
设置群成员名片。 | |
设置聊天置顶。 | |
设置聊天免打扰。 | |
设置群成员禁言。 | |
设置全员禁言。 | |
解散群组。 | |
退出群组。 | |
检查权限。 | |
检查成员操作权限。 | |
获取可用权限。 | |
初始化监听器。 |
VideoMixerState
视频混流管理模块
核心功能：管理视频混流功能，支持多路视频合成、布局管理、媒体源控制等高级视频处理功能。
技术特点：支持实时视频混流、动态布局调整、媒体源管理等功能。新增 isVideoMixerEnabled、mediaSourceList、activeMediaSource 响应式数据和完整的混流控制接口。
业务价值：为直播平台提供专业的视频制作能力，提升直播质量。
应用场景：多人直播、画中画、视频合成、专业制作等场景。
响应式数据
数据列表 | 描述 |
根据分辨率获取尺寸。 | |
视频混流是否启用。 | |
媒体源列表。 | |
当前活跃的媒体源。 |
接口函数
函数列表 | 描述 |
根据质量获取视频数据。 | |
根据质量获取尺寸。 | |
根据分辨率获取尺寸。 | |
转换视频质量到 TRTC 分辨率。 | |
转换 TRTC 分辨率到视频质量。 | |
转换 TRTC 分辨率模式。 | |
切换活跃媒体源。 | |
更新视频质量。 | |
根据媒体源获取默认布局。 | |
添加媒体源。 | |
更新媒体源。 | |
移除媒体源。 | |
启用本地视频混流。 | |
清空所有媒体源。 | |
初始化媒体源管理器。 | |
初始化视频混流状态。 |
VirtualBackgroundState
虚拟背景管理模块
核心功能：管理虚拟背景功能，支持背景替换、背景模糊、自定义背景等视频美化功能。
技术特点：基于 AI 技术实现实时背景分割和替换。新增 virtualBackgroundConfig 响应式数据和 isSupported、setVirtualBackground 接口函数。
业务价值：为用户提供隐私保护和视频美化功能，提升视频通话体验。
应用场景：视频通话、在线会议、直播美化、隐私保护等场景。
响应式数据
数据列表 | 描述 |
虚拟背景配置。 |
接口函数
函数列表 | 描述 |
初始化虚拟背景。 | |
保存虚拟背景。 | |
检查是否支持。 | |
设置虚拟背景。 |
ASRState
语音识别管理模块
核心功能：管理语音识别功能，支持实时语音转文字、转录历史管理、转录导出等功能。
技术特点：基于先进的 ASR 技术，支持多语言识别、实时转录、历史记录等功能。新增 recentTranscripts、transcriptHistory 响应式数据和 exportTranscripts 接口。
业务价值：为用户提供语音转文字服务，提升沟通效率和可访问性。
应用场景：会议记录、语音转录、无障碍通信、内容记录等场景。
响应式数据
数据列表 | 描述 |
最近的语音转录记录。 | |
语音转录历史记录。 |
接口函数
函数列表 | 描述 |
设置最近转录时长。 | |
清空转录历史记录。 | |
导出转录内容。 |
SearchState
搜索功能管理模块
核心功能：管理全局搜索功能，支持消息搜索、用户搜索、群组搜索等多维度搜索能力。
技术特点：支持高级搜索、搜索历史、搜索建议等功能。重构响应式数据为 keyword、results、isLoading 等标准化字段，提供完整的搜索接口。
业务价值：为用户提供快速查找信息的能力，提升使用效率。
应用场景：消息搜索、联系人搜索、内容查找、历史记录等场景。
响应式数据
数据列表 | 描述 |
搜索关键词。 | |
搜索结果。 | |
是否正在加载。 | |
错误信息。 | |
高级搜索参数。 | |
选中的搜索类型。 |
接口函数
函数列表 | 描述 |
搜索。 | |
设置关键词。 | |
设置选中类型。 | |
设置消息搜索高级参数。 | |
设置用户搜索高级参数。 | |
设置群组搜索高级参数。 | |
加载更多。 |
SeatStore
座位存储管理模块
核心功能：提供座位状态的底层存储和管理，支持座位信息缓存、用户信息映射、设备请求处理等核心功能。
技术特点：采用响应式存储设计，支持实时状态同步、事件驱动更新等功能。新增 liveOwnerUserId、localUserId、seatList 等响应式数据和 getUserInfo、convertUserInfoToAudienceInfo 接口。
业务价值：为座位管理提供可靠的数据基础，确保座位状态的一致性。
应用场景：座位状态管理、用户信息存储、设备状态跟踪等底层场景。
响应式数据
数据列表 | 描述 |
直播间主播用户 ID。 | |
本地用户 ID。 | |
麦位列表，包含所有麦位的状态和用户信息。 | |
连麦主播列表。 | |
已发送的设备请求映射。 | |
已接收的设备请求映射。 | |
用户信息映射表。 |
接口函数
函数列表 | 描述 |
获取用户信息。 | |
转换用户信息为观众信息。 |
