导航
实时音视频
搜索目录或文档标题搜索目录或文档标题
实时音视频
产品动态
快速入门
场景方案
开发指南
Token 鉴权
音频管理
视频管理
屏幕共享
客户端 API 参考
服务端 API 参考
房间管理
转推直播
输入在线媒体流
实时数据监控
历史数据查询
业务标识管理
实时消息通信
历史版本（文档停止维护）
2023-08-01
2023-06-01
转推直播
2022-06-01
2020-12-01
转推直播
输入在线媒体流
获取数据指标
实时消息通信
常见问题
集成相关
质量相关
实时对话式 AI
进阶功能
API 参考
对话式 AI FAQ
硬件对话智能体
实时信令
互动白板
客户端 API 参考
Open API 参考
即时通讯 IM
快速开始
客户端 API 参考
服务端 API 参考
服务端 OpenAPI
成员相关
会话成员管理
会话相关
消息相关
用户相关
关于产品
- 文档首页 /实时音视频/实时音视频/客户端 API 参考/微信小程序 3.3/概览
概览
最近更新时间：2025.07.28 19:26:38首次发布时间：2022.01.21 10:38:44
复制全文
我的收藏有用
有用
无用
无用
文档反馈
问问助手引擎管理
| API | 描述 |
|---|---|
| init | 初始化 client |
| destroy | 销毁 clinet 实例并释放相关资源 |
| setBusinessId | 设置业务标识参数 |
房间管理
| API | 描述 |
|---|---|
| join | 加入房间 |
| leave | 离开当前房间 |
| setUserVisibility | 设置用户可见性 |
音视频传输
| API | 描述 |
|---|---|
| publish | 发布音视频流 |
| unpublish | 停止发布音视频流 |
| subscribe | 订阅指定远端用户音视频流 |
| unsubscribe | 取消订阅指定远端用户音视频流 |
| muteLocal | 暂停发送本地音视频流给远端订阅用户 |
| muteRemote | 暂停接收指定远端用户的音视频流 |
消息
| API | 描述 |
|---|---|
| login | 登录 |
| logout | 登出 |
| updateLoginToken | 更新登录令牌 |
| getPeerOnlineStatus | 获取用户在线状态 |
| sendUserMessage | 在房间内发送点对点文本消息给指定用户 |
| sendUserBinaryMessage | 在房间内发送点对点二进制消息给指定用户 |
| sendRoomMessage | 在房间内发送广播文本消息 |
| sendRoomBinaryMessage | 在房间内发送广播二进制消息 |
| sendUserMessageOutsideRoom | 在房间外发送点对点文本消息给指定用户 |
| sendUserBinaryMessageOutsideRoom | 在房间外发送点对点二进制消息给指定用户 |
| setServerParams | 设置业务服务器参数 |
| sendServerMessage | 在房间内发送文本消息到业务服务器 |
| sendServerBinaryMessage | 在房间内发送二进制消息到业务服务器 |
媒体流数据统计和上报
媒体流的发布和接收通过微信小程序标签 live-pusher 和 live-player 实现。如果你需要收集上下行的媒体流数据，可以调用以下接口，将相应的数据传给 RTC SDK， 由 RTC SDK 进行整理和上报。
| API | 描述 |
|---|---|
| reportPusherStateChange | 收集和上报 live-pusher 的 bindstatechange 发布者状态改变数据 |
| reportPusherNetStatusChange | 收集和上报 live-pusher 的 bindnetstatus 发布者网络状态数据 |
| reportPlayerStateChange | 收集和上报 live-player 的 bindstatechange 订阅者状态改变数据 |
| reportPlayerNetStatusChange | 收集和上报 live-player 的 bindnetstatus 订阅者网络状态数据 |
回调
| API | 描述 |
|---|---|
| on | 监听 SDK.EVENTS 对象中包含的事件 |
| off | 取消监听事件 |
SDK.EVENTS 对象中包含的事件列举如下。
| 事件名 | 说明 |
|---|---|
| STREAM_ADDED | 房间内有远端流加入 |
| STREAM_REMOVED | 房间内远端流退出 |
| UPDATE_URL | 推流或拉流地址更新 |
| STREAM_FAILED | 推流或拉流异常 |
| MUTE_AUDIO | 远端流关闭音频 |
| UNMUTE_AUDIO | 远端流打开音频 |
| MUTE_VIDEO | 远端流关闭视频 |
| UNMUTE_VIDEO | 远端流打开视频 |
| CLIENT_BANNED | 服务端踢出用户 |
| PEER_ONLINE | 房间内有其他用户加入 |
| PEER_LEAVE | 房间内有其他用户退出 |
| ERROR | 收到微信小程序的 SocketTask.onError 事件 |
| DISCONNECT | WebSocket 异常中断 |
| LOGIN_BANNED | 重复登录被踢出 |
| USER_MESSAGE_RECEIVED | 收到用户文本消息 |
| USER_BINARY_MESSAGE_RECEIVED | 收到用户二进制消息 |
| ROOM_MESSAGE_RECEIVED | 收到房间文本消息 |
| ROOM_BINARY_MESSAGE_RECEIVED | 收到房间二进制消息 |
| USER_MESSAGE_RECEIVED_OUTSIDE_ROOM | 收到房间外用户文本消息 |
| USER_BINARY_MESSAGE_RECEIVED_OUTSIDE_ROOM | 收到房间外用户二进制消息 |
| SERVER_PARAMS_SET_RESULT | 设置业务服务器参数结果 |