音视频通话

实现音视频通话

简要说明

  • 学习本章节前,前务必阅读完准备工作章节

  • 通篇将SDK文件引入定义为"RTCSDK"

  • 代码部分均为 js 代码,详细代码请参考SDK包里的demo。

创建第一个小程序

开发工具选择

预览编译上传代码必须使用微信开发者工具,用户可根据个人习惯选择开发工具进行代码编写。

SDK包目录结构

├─RTCSDK                             // SDK包,将该文件夹拷贝到项目中
│  ├─RTC_Miniapp_SDK.min.js          // SDK
│  │
│  ├─RTC_Miniapp_SDK.min.js.map      // SDK映射文件,便于快速定位SDK报错位置。非必要
│  │
│  └─components                      // SDK组件
│      ├─RTCAudioPlayer              // 音频拉流组件
│      ├─RTCVideoPlayer              // 视频拉流组件
│      ├─RTCVideoPusher              // 音视频推流组件
│      └─RTCScreenMarkV4             // 屏幕共享标注组件
│
├─meetingDemo                        // 会议演示-meetingDemo
│   ├─pages                          // 项目页面
│   │   ├─chat                       // 聊天页面
│   │   ├─login                      // 首页,登录页面
│   │   ├─meeting                    // 视频会议页面
│   │   ├─option                     // 选项页面
│   │   └─setting                    // 设置页面
│   │
│   └─utils
│       └─RTCSDK                      // 导入SDK目录到项目中
│
├─videoCallDemo                       // 呼叫演示-videoCallDemo
│   ├─components                      //自定义组件
│   │   └─myModal
│   │
│   ├─pages                           // 项目页面
│   │   ├─login                       // 登录页面
│   │   ├─queue                       // 队列页面
│   │   ├─setting                     // 设置页面
│   │   └─videoCall                   // 视频呼叫页面
│   │
│   └─utils
│       └─RTCSDK                      // 导入SDK目录到项目中
│
│ 
└─Uniapp Api Demo                     // API Demo-导入到Hbuilder编译器
    ├─package
    │  └─RTCSDK                       // 导入SDK JS文件
    │
    ├─pages
    │
    └─wxcomponents                    // 导入SDK组件
        ├─RTCAudioPlayer
        ├─RTCVideoPlayer
        └─RTCVideoPusher

首次创建项目

  1. 创建一个小程序项目需要填入小程序时的AppId,请勿使用测试号
  2. 导入SDK包中的CRSDK文件夹
  3. 在app.js中导入SDK文件,即 RTC_Miniapp_SDK.min.js,可使用import或者require导入
    const RTCSDK = require('./utils/RTCSDK/RTC_Miniapp_SDK.min.js');

基本步骤

1. 初始化SDK

初始化是整个SDK的使用基础,通常在程序启动的时候进行初始化(Init),
退出后进行反初始化(UnInit),整个程序的生命周期中只进行一次初始化和反初始化。

    const sdkErr = RTCSDK.Init(); //初始化SDK,返回状态码
    if (sdkErr === 0) {
        console.log('初始化成功');
        // 可以继续设置服务器及登录操作
    } else {
        console.log(`初始化失败,错误码:${sdkErr}}`);
    }

相关API请参考:

2. 登录服务器

设置视频服务器地址,然后使用appID和md5加密后的appSecret登录。(获取App ID及App Secret)

  • 调用接口:
    //设置服务器地址,如果使用云服务时填sdk.cloudroom.com
    //使用私有化部署的服务器时要填部署的服务器地址;此处以云服务为例。
    RTCSDK.SetServerAddr('sdk.cloudroom.com');

    //登录接口,推荐使用Token鉴权机制登录,参考LoginByToken接口
    RTCSDK.Login(AppID, md5(AppSecret), nickName, userID);
  • 回调通知:
//登录成功
RTCSDK.LoginSuccess.callback = (userID,cookie) => {
   //登录成功,开始创建房间,见 第3步
}

//登录失败
RTCSDK.LoginFail.callback = (sdkErr,cookie) => {
   //登录出错,可以弹出错误提示,或调用登录接口再次重试登录
}

//登录掉线
RTCSDK.LineOff.callback = sdkErr => {

}

相关API请参考:

3. 创建房间

  • 调用接口:
//创建房间
RTCSDK.CreateMeeting()
  • 回调通知:
//创建房间成功
RTCSDK.CreateMeetingSuccess.callback = (meetObj,cookie) => {
    //创建成功,可以进入房间
}
//创建房间失败
RTCSDK.CreateMeetingFail.callback = (sdkErr,cookie) => {
    //创建失败,可以弹出错误提示,不能再执行 进入房间
}

相关API请参考:

4. 进入房间

用创建成功的房间信息(房间ID)进入房间,其他用户也是利用此房间信息进入该房间。

  • 调用接口:
//进入房间
RTCSDK.EnterMeeting3(meetID, cookie);
  • 回调通知:
//进入房间完成响应
RTCSDK.EnterMeetingRslt.callback = (sdkErr, cookie) => {
    if(sdkErr === 0){
        console.log("进入房间成功,可以继续下面第5步……");
    }else{
        console.log(`进入房间失败,错误码:${sdkErr}`);
    }
}
//监控房间掉线
RTCSDK.MeetingDropped.callback = () => {
    //可重新进进入房间议
}

相关API请参考:

5. 打开麦克风/摄像头/房间声音

紧接第4步,进入房间成功后,可以进行跳转页面操作,导入推流拉流组件,以便本地、远端显示自己的视频图像
RTCVideoPusher 是本地视频、麦克风推流组件
RTCAudioPlayer 是会议内音频拉流组件,会议内成员的麦克风声音通过该组件输出

  • json代码
    {
        "usingComponents": {
            "RTCVideoPusher": "/utils/RTCSDK/components/RTCVideoPusher/RTCVideoPusher",    //声明音视频推流组件,需定位到对应目录
            "RTCAudioPlayer": "/utils/RTCSDK/components/RTCAudioPlayer/RTCAudioPlayer",    //声明音频拉流组件,需定位到对应目录
        }
    }
  • wxml代码
<view style='width: 300rpx;height: 100rpx'>
    <!-- 组件宽高会根据父元素宽高继承 -->
    <!-- 音视频推流组件,config传入配置信息,debug是否开启调式,详细请参考组件文档 -->
    <RTCVideoPusher config='{{RTCVideoPusher}}' debug='{{false}}'>
        <!-- 这里是组件插槽,可在这里自定义元素 -->
    </RTCVideoPusher>
</view>

<!-- 音频拉流组件 -->
<RTCAudioPlayer config='{{RTCAudioPlayer}}' debug='{{false}}'></RTCAudioPlayer>
  • javascript代码
    //音视频推流组件
    const RTCVideoPusher = {
        orientation: 'vertical', // vertical,horizontal,
        aspect: '3:4', // 宽高比,可选值有 3:4, 9:16
        beauty: 0, // 美颜,取值范围 0-9 ,0 表示关闭
        whiteness: 0, // 美白,取值范围 0-9 ,0 表示关闭
        devicePosition: 'front', // 前置或后置,值为front, back, 此属性不支持动态修改,如需切换摄像头请调用api
        muted: false, //默认静音,此属性不支持动态修改,如需开关麦克风请调用api
        enableCamera: true, //默认打开摄像头,此属性不支持动态修改,如需开关摄像头请调用api
        minBitrate: 200, //	最小码率
        maxBitrate: 800, // 最大码率
    }
    this.setData({RTCVideoPusher});

    //-----------------分割线-------------

    //音频拉流组件
    const RTCAudioPlayer = {
        soundMode: 'speaker', // 声音输出方式,有效值为 speaker(扬声器)、ear(听筒)
        autoPauseIfNavigate: false, // 当跳转到其它小程序页面时,是否自动暂停本页面的实时音视频播放
        autoPauseIfOpenNative: false, // 当跳转到其它微信原生页面时,是否自动暂停本页面的实时音视频播放
    }
    this.setData({RTCAudioPlayer}); //将配置渲染到页面

相关API请参考:

6. 观看他人视频

成功进入房间后,查询他人的成员信息并setData到SDK组件观看他人视频图像

  • json代码
    {
        "usingComponents": {
            "RTCVideoPlayer": "/utils/RTCSDK/components/RTCVideoPlayer/RTCVideoPlayer" //声明视频拉流组件,需定位到对应目录
        }
    }
    //视频播放组件默认配置,通过修改data,组件实施更新
    const RTCVideoPlayer = {
        userId: "userID",  //观看用户的userId
        camId: -1,  //观看用户的某个摄像头。默认值-1,观看用户的默认摄像头。
    }
    this.setData({ RTCVideoPlayer });  //配置

  • wxml代码
<view style='width: 300rpx;height: 100rpx'>
    <!-- 组件宽高会根据父元素宽高继承 -->
    <!-- 视频拉流组件 config传入配置信息,debug是否开启调式,详细请参考组件文档 -->
    <RTCVideoPlayer config='{{RTCVideoPlayer}}' debug='{{false}}'>
        <!-- 这里是组件插槽,可在这里自定义元素 -->
    </RTCVideoPlayer>
</view>

7. 退出房间

//退出房间
RTCSDK.ExitMeeting()

相关API请参考:

8. 注销登录

//注销本次登录
RTCSDK.Logout()

相关API请参考:

9. 反初始化,退出SDK

执行反初始化后SDK功能不再可用。

//反初始化
RTCSDK.UnInit();

相关API请参考: