aliyun-webrtc-sdk v1.17.3

Aliyun WebRtc SDK

阿里云音视频通信aliyun-webrtc-sdk，提供基于WebRTC适用于浏览器的SDK。

Installation

You can install it as dependency with npm/cnpm or yarn.

$ # save into package.json dependencies with -S
$ npm install aliyun-webrtc-sdk -S

$ # you can use cnpm for fast install
$ cnpm install aliyun-webrtc-sdk -S

$ # use yarn for install
$ yarn add aliyun-webrtc-sdk

一、接入前准备

阿里云RTC提供移动端、PC等多端SDK，并兼容标准WebRTC浏览器接入网络，帮助您快速搭建多端实时应用。接入RTC的方法，请参见入门概述。 当您成功搭建本地SDK，可以在终端调用API与RTC服务端进行交互，在加入频道或房间后，您可以进行本地推流、订阅远端用户等操作，实现频道内不同用户之间的音视频实时通话。 阿里云RTC拥有全球实时智能调度系统，并结合实时媒体处理系统和1500+边缘节点，运用行业领先的音频3A（AGC、AEC、ANS）、视频编码、弱网对抗等算法为您提供低延时、抗丢包的音视频实时通信。

二、快速开启

• 创建实例

import 'aliyun-webrtc-sdk'

/**
 * 创始实例,目前支持多实例
 */
var aliWebrtc = new AliRtcEngine();

• 检测浏览器是否支持webrtc

aliWebrtc.isSupport().then((res)=>{
  //支持webrtc
}).catch((error)=>{
	//不支持webrtc
})

• 订阅onPublisher回调。当远程用户推流时，在SDK里会触发onPublisher回调，通过订阅这个回调，能够得到频道里已经推流的用户。

aliWebrtc.on('onPublisher',(publisher) =>{
    //远程发布者userId
    console.log(publisher.userId);
    //远程发布名字
    console.log(publisher.displayName);
    //远程流内容，streamConfigs是数组。
    console.log(publisher.streamConfigs);
  });

• 开启本地预览。在创建完AliRtcEngine实例后，您可以通过video标签播放。

aliWebrtc.startPreview(
    video    // html中的video元素
).then(()=>{
    //预览成功
}).catch((error) => {
    // 预览失败
});

• 加入频道

aliWebrtc.joinChannel({
    userid,         // 用户ID，只能由数字、字母、下划线组成
    channel,        // 频道
    appid,          // 应用ID
    nonce,          // 随机码
    timestamp,      // 时间戳
    gslb,           // gslb服务地址
    token,          // 令牌
},displayName).then(()=>{
    // 入会成功
} ,(error)=>{
    // 入会失败，打印错误内容，可以看到失败原因
    console.log(error.message);
});

• 推流 默认推摄像头和麦克风流

aliWebrtc.publish().then(()=>{
} ,(error)=>{
    console.log(error.message);
});

• 订阅和显示远程流。通过subscribe方法订阅远程流，订阅成功后在调用setDisplayRemoteVideo显示远程流。

通常在onPublisher回调中进行订阅与设置视图。

aliWebrtc.subscribe(userId).then((userId)=>{
    aliWebrtc.setDisplayRemoteVideo(
        userId,       // userId是用户ID
        video,        // html中用于显示stream对象的video元素
        1             // 1表示摄像头流（大流和小流）和音频流，2表示屏幕分享流
    )
},(error)=>{
    console.log(error.message);
});

• 离开频道。

aliWebrtc.leaveChannel().then(()=>{
} ,(error)=>{
    console.log(error.message);
});

三、接口回调列表

1）接口列表（详细接口信息请参考官网AliRtcEngine接口文档）

基础接口

频道相关接口

发布相关接口

订阅相关接口

视频相关接口

音频相关接口

预览接口

远端用户查询接口

其他接口

2）回调列表（详细回调信息请参考官网回调与监听文档）

四、错误码列表(详细错误码信息请参考官网错误码文档)

isSupport 错误码 errorCode

其他 错误码 errorCode