RTC WX SDK

简介

RTC WX SDK 是公司实时音视频通讯解决方案的 微信小程序端 SDK,开发者可以使用 RTC WX SDK 提供的 API 和小程序提客户端供的API建立连接,控制实时音视频通话,实现各种场景的应用。

请务必使用 微信开发者工具 来部署您的 应用,否则会出现找不到 应用 错误!

基本工作原理

RTC WX SDK 是基于 WXRTC 的实时音视频通话解决方案,它通过 WebSocket 与公司实时音视频后台服务器建立信令通道,信令通道 主要是用来进行用户进退房、媒体能力交换、房间内用户状态变更通知等信令通信;音视频数据传输则通过 WXRTC 的 RTP/RTCP与RTMP的转换 进行。

API 概要

  • AVDEngine类是整个 SDK 的主入口,提供创建 avdEngine 对象、获取摄像头列表、麦克风列表、控制日志等级及日志保存等功能。

  • Room类(由avdEngine.obtainRoom(roomId)创建),提供房间相关的核心能力:

    • 进房 join()

    • 退房leave()

    • 关闭房间 closeRoom()

  • User 类(由room.getUser(userId)创建),提供用户相关的核心能力:

    • 命令远端用户发布某一摄像头视频remotecmdPublishCamera(video)

    • 命令远端用户取消发布摄像头视频remotecmdUnpublishCamera(userId,cameraId)

    • 命令远端用户打开麦克风remotecmdOpenMicrophone(userId)

    • 命令远端用户关闭麦克风remotecmdCloseMicrophone(userId)

    • 命令远端用户麦克风静音remotecmdMuteMicrophone(userId)

    • 命令远端用户麦克风取消静音remotecmdUnmuteMicrophone(userId)

  • Video类(由user.getVideo(videoId)创建),提供实时视频通话的核心能力:

    • 发布视频Video#publish()

    • 取消发布视频unpublish()

    • 订阅视频流Video#subscrible()

    • 取消订阅视频流Video#unsubscrible()

  • Audio类(由user.getVideo(microphoneId)创建),提供实时音频通话的核心能力:

    • 发布音频Audio#openMicrophone()

    • 取消发布音频Audio#closeMicrophone()

    • 订阅音频流Audio#subscrible()

    • 取消订阅音频流Audio#unsubscrible()

Tutotials