atomicx-core SDK 是腾讯云最新推出的面向即时通信、音视频通话、视频直播、语聊房等场景的全新一代基于响应式的 API,您可以非常快速的基于这组 API 构建自己的 UI 页面,它支持房间管理、屏幕分享、成员管理、麦位控制、基础美颜等丰富功能,同时基于 TRTC SDK,能够提供超低延时、高品质的音视频体验,本页面包含 atomicx-core SDK 的所有 API 接口,按功能模块分类展示。
LoginState
用户身份认证与登录管理模块
核心功能:负责用户身份验证、登录状态管理、用户信息维护等基础认证服务。
响应式数据
数据列表 | 描述 |
当前登录用户信息。 | |
当前登录状态。 |
接口函数
函数列表 | 描述 |
登录方法。 | |
登出方法。 | |
设置用户信息。 |
LiveListState
直播列表管理模块
核心功能:管理直播间的完整生命周期,包括创建、加入、离开、结束等核心业务流程。
技术特点:支持分页加载、实时状态同步、直播信息动态更新,采用响应式数据管理,确保 UI 与数据状态实时同步。
业务价值:为直播平台提供核心的直播间管理能力,支持大规模并发直播场景,是直播业务的基础设施。
应用场景:直播列表展示、直播间创建、直播状态管理、直播数据统计等核心业务场景。
响应式数据
数据列表 | 描述 |
直播列表数据。 | |
直播列表游标,用于分页加载。 | |
当前直播信息。 |
接口函数
函数列表 | 描述 |
获取直播列表。 | |
创建直播间。 | |
加入直播间。 | |
离开直播间。 | |
结束直播。 | |
更新直播信息。 | |
添加直播列表事件监听。 | |
移除直播列表事件监听。 |
LiveSeatState
直播间座位管理模块
核心功能:实现多人连麦场景下的座位控制,支持复杂的座位状态管理和音视频设备控制。
技术特点:基于 WebRTC 技术,支持多路音视频流管理,提供座位锁定、设备控制、权限管理等高级功能。
业务价值:为多人互动直播提供核心技术支撑,支持PK、连麦、多人游戏等丰富的互动场景。
应用场景:多人连麦、主播 PK、互动游戏、在线教育、会议直播等需要多人音视频互动的场景。
响应式数据
数据列表 | 描述 |
座位列表。 | |
画布信息。 | |
正在说话的用户列表。 |
接口函数
函数列表 | 描述 |
用户上麦。 | |
用户下麦。 | |
静音麦克风。 | |
取消静音麦克风。 | |
将用户踢出麦位。 | |
将用户移动到麦位。 | |
锁定麦位。 | |
解锁麦位。 | |
开启远端用户摄像头。 | |
关闭远端用户摄像头。 | |
开启远端用户麦克风。 | |
关闭远端用户麦克风。 | |
添加麦位事件监听。 | |
移除麦位事件监听。 |
LiveAudienceState
直播间观众管理模块
核心功能:管理直播间观众列表,提供观众权限控制、管理员设置等直播间秩序维护功能。
技术特点:支持实时观众列表更新、权限分级管理、批量操作等高级功能,确保直播间秩序和用户体验。
业务价值:为直播平台提供完整的观众管理解决方案,支持大规模观众场景下的秩序维护。
应用场景:观众管理、权限控制、直播间秩序维护、观众互动管理等核心业务场景。
响应式数据
数据列表 | 描述 |
直播间观众列表。 | |
直播间观众数量。 |
接口函数
函数列表 | 描述 |
获取观众列表。 | |
设置管理员。 | |
撤销管理员。 | |
将用户踢出房间。 | |
禁用发送消息。 | |
添加观众监听。 | |
移除观众监听。 |
DeviceState
设备状态管理模块
核心功能:管理摄像头、麦克风等音视频设备的控制,提供设备状态监控、权限检查等基础设备服务。
技术特点:支持多设备管理、设备状态实时监控、权限动态检查、设备故障自动恢复等高级功能。
业务价值:为直播系统提供稳定的设备基础,确保音视频采集的可靠性和用户体验。
应用场景:设备管理、权限控制、音视频采集、设备故障处理等基础技术场景。
响应式数据
数据列表 | 描述 |
麦克风开启状态。 | |
麦克风最后一次错误状态。 | |
是否有音频发布权限。 | |
采集音量大小(0-100)。 | |
当前麦克风音量(0-100)。 | |
输出音量大小(0-100)。 | |
摄像头开启状态。 | |
摄像头最后一次错误状态。 | |
是否为前置摄像头。 | |
本地镜像类型。 | |
本地视频质量设置。 | |
当前音频输出路由(扬声器/耳机)。 | |
屏幕共享状态。 | |
网络信息状态。 |
接口函数
函数列表 | 描述 |
开启本地麦克风。 | |
关闭本地麦克风。 | |
设置采集音量。 | |
设置输出音量。 | |
开启本地摄像头。 |
CoGuestState
连麦嘉宾管理模块
核心功能:处理观众与主播之间的连麦互动,管理连麦申请、邀请、接受、拒绝等完整的连麦流程。
技术特点:基于实时音视频技术,支持连麦状态实时同步、音视频质量自适应、网络状况监控等高级功能。
业务价值:为直播平台提供观众参与互动的核心能力,增强用户粘性和直播趣味性。
应用场景:观众连麦、互动问答、在线K歌、游戏直播等需要观众参与的互动场景。
响应式数据
数据列表 | 描述 |
已连接的连麦嘉宾列表。 | |
被邀请上麦的用户列表。 | |
申请上麦的用户列表。 | |
可邀请上麦的候选用户列表。 |
接口函数
函数列表 | 描述 |
申请连麦座位。 | |
取消申请。 | |
接受申请。 | |
拒绝申请。 | |
邀请上麦。 | |
取消邀请。 | |
接受邀请。 | |
拒绝邀请。 | |
断开连麦连接。 | |
添加连麦嘉宾侧事件监听。 | |
移除连麦嘉宾侧事件监听。 | |
添加连麦主播侧事件监听。 | |
移除连麦主播侧事件监听。 |
CoHostState
连线主播管理模块
核心功能:实现主播间的连线功能,支持主播邀请、连线申请、连线状态管理等主播间互动功能。
技术特点:支持多主播音视频同步、画中画显示、音视频质量优化等高级技术,确保连麦体验的流畅性。
业务价值:为直播平台提供主播间协作的核心能力,支持 PK、合作直播等高级业务场景。
应用场景:主播 PK、合作直播、跨平台连麦、主播互动等高级直播场景。
响应式数据
数据列表 | 描述 |
已连接的连麦主播列表。 | |
被邀请连线的主播列表。 | |
当前申请连线的主播信息。 | |
可邀请连线的候选主播列表。 | |
当前连线状态。 |
接口函数
函数列表 | 描述 |
请求连线。 | |
取消连线请求。 | |
接受连线请求。 | |
拒绝连线请求。 | |
退出连线。 | |
添加连线主播事件监听。 | |
移除连线主播事件监听。 |
AudioEffectState
音效处理模块
核心功能:提供变声、混响、耳返等高级音效功能,支持多种音效效果和实时音效调节。
技术特点:基于腾讯天籁实验室的音频处理算法,支持实时音效处理、低延迟音频传输、音质优化等高级技术。
业务价值:为直播平台提供差异化的音效体验,增强用户参与度和直播趣味性。
应用场景:变声直播、K 歌直播、音效娱乐、专业音效等需要音频处理的场景。
响应式数据
数据列表 | 描述 |
耳返开关状态。 | |
耳返音量大小。 | |
变声状态。 | |
混响状态。 |
接口函数
函数列表 | 描述 |
设置变声效果。 | |
设置混响效果。 | |
设置耳返开关状态。 | |
设置耳返音量大小。 |
BarrageState
弹幕消息管理模块
核心功能:处理直播间内的文本消息、自定义消息等弹幕功能,支持弹幕发送、消息状态同步等完整弹幕系统。
技术特点:支持高并发消息处理、实时消息同步、消息过滤、表情包支持等高级功能。
业务价值:为直播平台提供核心的互动能力,增强用户参与度和直播氛围。
应用场景:弹幕互动、消息管理、表情包、聊天室等社交互动场景。
响应式数据
数据列表 | 描述 |
当前房间的弹幕消息列表。 | |
是否允许发送消息。 |
接口函数
函数列表 | 描述 |
发送文本类型弹幕。 | |
发送自定义类型弹幕。 |
BaseBeautyState
基础美颜模块
核心功能:提供磨皮、美白、红润等基础美颜效果调节,支持实时美颜参数调整。
技术特点:基于 AI 美颜算法,支持实时美颜处理、参数平滑调节、性能优化等高级技术。
业务价值:为直播平台提供基础的美颜能力,提升用户形象和直播质量。
应用场景:美颜直播、形象优化、美颜调节、直播美化等需要美颜功能的场景。
响应式数据
数据列表 | 描述 |
磨皮级别 取值范围[0,9]: 0 表示关闭,9 表示效果最明显。 | |
美白级别 取值范围[0,9]: 0 表示关闭,9 表示效果最明显。 | |
红润级别 取值范围[0,9]: 0 表示关闭,9 表示效果最明显。 |
接口函数
函数列表 | 描述 |
设置磨皮级别。 | |
设置美白级别。 | |
设置红润级别。 |
GiftState
礼物系统管理模块
核心功能:处理礼物的发送、接收、礼物列表管理等功能,支持礼物分类、礼物动画、礼物统计等完整礼物经济系统。
技术特点:支持礼物动画渲染、礼物特效处理、礼物统计、礼物排行榜等高级功能。
业务价值:为直播平台提供核心的变现能力,支持礼物经济、虚拟货币等商业模式。 应用场景:礼物打赏、虚拟货币、礼物特效、礼物统计等商业化场景。
响应式数据
数据列表 | 描述 |
可用礼物列表。 |
接口函数
函数列表 | 描述 |
刷新可用礼物列表。 | |
发送礼物。 | |
添加礼物事件监听器。 | |
移除礼物事件监听器。 |
LikeState
点赞互动模块
核心功能:处理直播间的点赞功能,支持点赞发送、点赞统计、点赞事件监听等互动功能。
技术特点:支持高并发点赞处理、实时点赞统计、点赞动画效果、点赞排行榜等高级功能。
业务价值:为直播平台提供基础的互动能力,增强用户参与度和直播氛围。
应用场景:点赞互动、人气统计、互动效果、用户参与等基础互动场景。
响应式数据
数据列表 | 描述 |
总点赞数量。 |
接口函数
函数列表 | 描述 |
发送点赞。 | |
添加点赞事件监听。 | |
移除点赞事件监听。 |