aliyun-webrtc-electron-sdk v1.0.0-beta2

Electron SDK 1.0.0

阿里云音视频通信aliyun-webrtc-electron-sdk

一、接入前准备

接入参数配置

1 、在electron项目目录中package.json文件scripts中增加postinstall命令配置指定版本号 （electron版本也需要对应版本，一般相同主版本号可以兼容）

"scripts": {
	"postinstall": "node node_modules/aliyun-webrtc-electron-sdk/dist/bin/alirtcdown -v 6.0.9"
  ...
}

参数说明：

2、在dependencies中增加aliyun-webrtc-electron-sdk包

"dependencies": {
  ...
	"aliyun-webrtc-electron-sdk": "1.0.0"
  ...
}

3、执行npm install /cnpm install安装依赖

打包参数配置

由于electron sdk用到的dll库在asar压缩后无法正常使用，需要配置不压缩

"build": {
	"extraResources": [
  	"./node_modules/aliyun-webrtc-electron-sdk/**"
  ]
}

官方文档

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

二、文档

接口文档

本文为您介绍了Electron SDK的接口详情

目录

基础接口

频道相关接口

发布相关接口

订阅相关接口

视频相关接口

音频相关接口

预览接口

远端用户查询接口

其他接口

接口详情

基础接口

• 实例化

let aliElectronRtc = new AliRtcEngine(option)

注：H5兼容模式是指是否能和Web端正常通信，默认关闭。

• destroy：销毁实例

aliElectronRtc.destroy();

频道相关接口

• setAutoPublishSubscribe：设置是否自动发布，是否自动订阅。

注：默认自动发布和订阅，必须在加入频道之前设置。

aliElectronRtc.setAutoPublishSubscribe(autoPub, autoSub);

• joinChannel：加入频道。

注：1、加入频道成功后，如果中途需要加入其他频道，必须先调用leaveChannel离开当前频道。2、如果加入频道失败，需要重试时，无需先调用leaveChannel。

aliElectronRtc.joinChannel(authInfo, displayName).then(()=>{
    // 入会成功
}).then((code)=>{
    // 入会失败，查看错误码
});

• leaveChannel: 离开频道

aliElectronRtc.leaveChannel().then(()=>{
	// 离会成功
}).catch((code) => {
	// 离会失败，查看错误码 
});

• setChannelProfile: 设置频道类型

注：默认通信模式，设置频道模式需要在入会前调用。返回 0：成功，其他表示对应错误码

aliElectronRtc.setChannelProfile(profile)

发布相关接口

• isAutoPublish: 查询当前是否为自动发布模式，返回true为自动发布，false为手动发布

aliElectronRtc.isAutoPublish();

• configLocalCameraPublish：设置是否允许发布相机流。

注：默认为允许发布相机流，手动发布时，需要调用publish才能生效。

aliElectronRtc.configLocalCameraPublish(enable);

• configLocalScreenPublish: 设置是否允许发布屏幕流。

注：默认为不允许发布屏幕流，手动发布时，需要调用publish才能生效。

aliElectronRtc.configLocalScreenPublish(enable);

• configLocalAudioPublish: 设置是否允许发布音频流。

注：默认为允许发布音频流，手动发布时，需要调用publish才能生效。

aliElectronRtc.configLocalAudioPublish(enable);

• configLocalSimulcast: 设置是否允许发布次要视频流。

注：1、默认为允许发布次要视频流，手动发布时，需要调用publish才能生效。2、当仅推视频流未推共享流，且频道内只有两个用户时，因为是1v1模式，对方看不到小流。3、当前仅支持相机流小流。

aliElectronRtc.configLocalSimulcast(enable);

• publish: 手动发布视频和音频流。

注：1、调用publish的实际表现需要结合configLocalCameraPublish、configLocalScreenPublish、configLocalAudioPublish、configLocalSimulcast等接口才能确定。2、根据您的具体业务需求配置上述4个接口的参数，以发布相应的视频和音频流。3、发布和停止发布都是调用publish。    4、如需停止发布，则需要上述4个配置接口的参数都置为false，再调用publish。5、需要在加入频道成功之后调用该接口。

aliElectronRtc.publish().then(()=>{
  // 推流成功
}).catch((code)=>{
	// 推流失败 查看错误码
})

订阅相关接口

• isAutoSubscribe: 查询当前是否为自动订阅模式，返回true为自动订阅，false为手动订阅

aliElectronRtc.isAutoSubscribe();

• configRemoteCameraTrack：设置是否订阅远端相机流。

注：1、默认为订阅大流。2、当对流进行操作时（如手动订阅，关闭订阅），必须调用subscribe才能生效。

aliElectronRtc.configRemoteCameraTrack(uid, preferMaster, enable);

• configRemoteScreenTrack: 设置是否订阅远端屏幕流。

注：1、默认为不订阅远端屏幕流。2、当对流进行操作时（如手动订阅，关闭订阅），必须调用subscribe才能生效。

aliElectronRtc.configRemoteScreenTrack(uid, enable);

• configRemoteAudio：设置是否订阅远端音频流。

注：1、默认订阅远端音频流。2、当对流进行操作时（如手动订阅，关闭订阅），必须调用subscribe才能生效。

aliElectron.configRemoteAudio(uid, enable);

• subscribe： 手动订阅视频和音频流。

注、1、调用subscribe的实际表现需要结合configRemoteCameraTrack、configRemoteScreenTrack、configRemoteAudio等接口才能确定。2、根据您的具体业务需求配置上述3个接口的参数，以订阅相应的视频流和音频流。3、订阅和停止订阅都是调用subscribe。4、如果需停止订阅，则需要上述3个配置接口的参数都置为false，然后调用subscribe。

aliElectronRtc.subscribe(uid).then((data)=>{
	
}).catch(()=>{
	// 订阅失败（该用户不存在/未改变订阅项）
})

Promise，resolve返回data参数

视频相关接口

• setVideoProfile: 设置视频流的参数。

注：可以在加入频道之前或者之后设置。

aliElectronRtc.setVideoProfile(profile, track);

• muteLocalCamera：是否关闭本地摄像头推送

注：该接口关闭本地摄像头推送后不会改变推流状态，推的摄像头流为黑帧

aliElectronRtc.muteLocalCamera(mute)

• getVideoDevices：获取摄像头列表

aliElectronRtc.getVideoDevices();

返回摄像头列表，各项信息如下

• getCurrentVideoDevice: 获取当前摄像头Id

aliElectronRtc.getCurrentVideoDevice();

• setVideoDevice: 设置摄像头

aliElectronRtc.setVideoDevice(deviceId);

• getScreenShareSourceInfo: 获取屏幕分享源信息

aliElectronRtc.getScreenShareSourceInfo(source_type);

返回该类型的屏幕信息

• getDesktopResolution: 获取屏幕分享桌面分辨率

注：当前只能获取桌面分辨率，获取窗口分辨率为0

aliElectronRtc.getDesktopResolution(source_id, source_title);

• setScreenShareSource: 设置屏幕分享源

aliElectronRtc.setScreenShareSource(source);

• getScreenShareSource: 获取屏幕分享源，返回当前设置的屏幕分享源。

aliElectronRtc.getScreenShareSource();

音频相关接口

• muteLocalMic

注：该接口关闭本地麦克风推送后不会改变推流状态，推的本地音频流为静音

aliElectronRtc.muteLocalMic(mute)

• muteRemoteAudioPlaying: 设置是否停止播放远端音频流

aliElectronRtc.muteRemoteAudioPlaying(uid, mute)

• getAudioRecordingDevices: 获取麦克风（录音设备）列表

aliElectronRtc.getAudioRecordingDevices();

返回麦克风（录音设备）列表，各项信息如下

• getCurrentAudioRecordingDevice: 获取当前麦克风（录音设备）Id

aliElectronRtc.getCurrentAudioRecordingDevice();

• setAudioRecordingDevice: 设置麦克风（录音设备）

aliElectronRtc.setAudioRecordingDevice(deviceId);

• getAudioPlaybackDevices: 获取扬声器列表

aliElectronRtc.getAudioPlaybackDevices();

返回扬声器列表，各项信息如下

• getCurrentAudioPlaybackDevice: 获取当前扬声器Id

aliElectronRtc.getCurrentAudioPlaybackDevice();

• setAudioPlaybackDevice: 设置扬声器

aliElectronRtc.setAudioPlaybackDevice(deviceId);

• enableLoopbackRecording: 声卡采集

注：默认关闭，开启声卡采集后系统播放的声音将通过音频流发布出去。

aliElectronRtc.enableLoopbackRecording(enable);

预览接口

• startPreview：开启预览

aliElectronRtc.startPreview();

• stopPreview：关闭预览

aliElectronRtc.stopPreview();

远端用户查询接口

• getUserInfo：查询用户信息

aliElectronRtc.getUserInfo(uid);

其他接口

• on：订阅事件

注：详细的事件信息请参考回调文档

aliElectronRtc.on(event, listener);

• off：取消订阅事件

aliElectronRtc.off(event, listener);

• setClientRole: 设置用户角色

注：1、默认AliRtcClientRoleLive（互动角色）2、入会前设置立即生效3、入会后设置返回成功后需要等待clientRoleChanged回调返回正确结果后确认切换成功。4、返回 0：成功，其他表示对应错误码

aliElectron.setClinetRole(clientRole);

回调文档

目录

回调详情

• userJoined：远端用户加入频道

注：1、当加入频道时，频道内已经有其他用户了，本地会收到这些用户的userJoined回调2、当有远端新用户加入频道时，本地会收到该回调

aliElectronRtc.on("userJoined",(uid)=> {
	console.log(`远端用户${uid}加入房间`)
})

• removeStream：远端用户离开频道

aliElectronRtc.on("removeStream",(uid)=> {
	console.log(`远端用户${uid}离开房间`)
})

• changeStream：远端用户推流变化

aliElectronRtc.on("changeStream",(data)=> {
	console.log(`远端用户${data.user_id}流变化`)
})

返回data数据的内容如下

• subscribeChange：订阅结果改变回调

aliElectronRtc.on("removeStream",(data)=> {
	console.log(`远端用户${data.user_id}订阅状态改变`)
})

返回data数据的内容如下

• warning：警告回调

注：目前警告回调可以忽略，不会影响正常使用 。

aliElectronRtc.on("warning",(code)=> {
	console.log(`warning: ${code}`)
})

• error：错误回调

注：具体错误码请参考官网客户端错误码文档。

aliElectronRtc.on("error",(code)=> {
	console.log(`error: ${code}`)
})

• networkQuality：网络质量变化时回调

aliElectronRtc.on("networkQuality",(data)=> {
	// 网络质量
})

• clientRoleChanged： 用户角色切换回调

aliElectronRtc.on("clientRoleChanged",(data)=> {
	//	data.oldRole 切换前的角色
  //	data.newRole 切换后的角色
})

数据类型

目录

详情

• AliRtcVideoTrack: 视频Track类型

• AliRtcAudioTrack: 音频Track类型

• AliRtcNetworkQuality: 网络质量

• AliRtcAuthInfo: 鉴权信息

• AliRtcRemoteUserInfo: 远端用户信息

• AliRtcClientRole: 角色类型

• AliRtcChannelProfile: 频道类型

• AliRtcScreenShareType: 桌面共享类型

• AliRtcScreenSourceList：屏幕共享源列表

• AliRtcScreenSource：屏幕共享源信息

• AliRtcScreenShareRegion：屏幕共享区域

• AliRtcVideoProfile：视频流参数

注：1、发布视频流规格，默认为AliRTCSDK_Video_Profile_Default。2、您可以在加入频道之前或之后设置，但是您必须在本地流发布之前通过setVideoProfile方法设置。

• AliRtcBeautyConfig：美颜设置