概述
更新时间：2025-07-23
概述
本文档主要介绍如何将RTC HarmonyOS NEXT SDK集成到您的项目中，并介绍各类功能的使用方法。在使用本文档前，您需要先了解RTC的一些基本知识，并已经开通了RTC服务。若您还不了解RTC，可以参考产品描述。
HarmonyOS NEXT SDK 能够帮助您实现登录音视频通信房间并开始通信，并可以对发布/订阅、音视频参数、设备参数进行设置。
接口概览
RTC HarmonyOS NEXT SDK提供以下接口。
初始化接口
| API | 描述 |
|---|---|
| initWithAppID | 初始化SDK |
房间相关接口
| API | 描述 |
|---|---|
| destroy | 登出房间并销毁 |
| disbandRoom | 解散房间 |
| kickOffUserWithId | 踢出某成员 |
| shutUpUserWithId | 禁言某成员 |
| queryUserList | 获取房间成员列表 |
| getSelfInfo | 获取自己信息 |
发布/订阅流相关接口
| API | 描述 |
|---|---|
| subscribe | 订阅某成员媒体流 |
| stopSubscribeStreaming | 停止订阅某成员媒体流 |
消息相关接口
| API | 描述 |
|---|---|
| sendMessageToUser | 向某成员发送消息 |
| setUserAttribute | 设置用户属性 |
| getUserAttribute | 获取用户属性 |
| sendChannelData | 发送数据 |
视频相关接口
| API | 描述 |
|---|---|
| startPreview | 开启本地预览 |
| stopPreview | 停止本地预览 |
| setRemoteDisplay | 设置远端渲染窗口 |
| setRemoteVideoPlayState | 设置是否拉取某成员视频流 |
摄像头相关接口
| API | 描述 |
|---|---|
| switchCamera | 切换摄像头 |
| muteCamera | 关闭/开启本地视频采集 |
| getCameraId | 获取当前使用摄像头ID |
音频相关接口
| API | 描述 |
|---|---|
| muteMic | 设置是否静音采集麦克风数据（不关闭麦克风） |
| switchLoundSpeaker | 切换扬声器/听筒 |
| muteSpeaker | 禁止/开启音频输出 |
| getCommunicationDeviceId | 获取音频输出设备ID |
| setRemoteAudioPlayState | 设置是否拉取某成员音频流 |
通知相关接口
可以通过on(),方法进行事件监听，如：
this.baiduRtcRoomIpm.on(RTCEvent.LoginSuccess,()=>{})
RTCEvent事件名及描述如下：
| 事件名 | 描述 |
|---|---|
| LoginSuccess | 用户登录成功 |
| RemoteUserJoinRoom | 远端用户加入 |
| RemoteUserLeaveRoom | 远端用户离开 |
| StreamChangedState | 远端流状态改变 |
| UserShutUp | 用户被禁言 |
| UserDisShutUp | 用户被解除禁言 |
| UserMessage | 收到用户消息/广播 |
| DataChannelMessage | 收到DataChannel消息 |
| UserKickOff | 被踢出房间 |