aliyun-webrtc-electron-sdk v2.5.2-beta1

Electron SDK

阿里云音视频通信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.10"
  ...
}

参数说明：

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

"dependencies": {
  ...
	"aliyun-webrtc-electron-sdk": "^2.5.2"
  ...
}

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();

频道相关接口

• joinChannel：加入频道。

注：1、加入频道成功后，如果中途需要加入其他频道，必须先调用leaveChannel离开当前频道。 2、如果加入频道失败，需要重试时，无需先调用leaveChannel。 3、该接口是异步接口，是否成功加入频道，通过onJoinChannelResult判断。

aliElectronRtc.joinChannel(authInfo, options)

• isInCall: 是否在频道中

aliElectronRtc.isInCall()

返回说明：true表示在频道中，false表示不在频道中 ​

• leaveChannel: 离开频道

aliElectronRtc.leaveChannel()

注：该接口是异步接口，是否成功加入频道，通过onJoinChannelResult判断 ​

• setChannelProfile: 设置频道类型

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

aliElectronRtc.setChannelProfile(profile)

发布相关接口

• publishLocalVideoStream：设置是否允许推视频流。

aliElectronRtc.publishLocalVideoStream(enable)

• isLocalVideoStreamPublished：查询当前是否允许推视频流。

aliElectronRtc.isLocalVideoStreamPublished()

返回说明：true表示允许推相机流，false表示不允许推相机流。 ​

• isScreenSharePublished：查询当前是否允许推屏幕流。

aliElectronRtc.isScreenSharePublished()

返回说明：true表示允许推相机流，false表示不允许推相机流。 ​

• publishLocalAudioStream：设置是否允许推音频流。

aliElectronRtc.publishLocalAudioStream(enable)

返回说明：0表示方法调用成功，其他表示方法调用失败。

• isLocalAudioStreamPublished：查询当前是否允许推音频流。

aliElectronRtc.isLocalAudioStreamPublished

返回说明：true表示允许推音频流，false表示不允许推音频流。

• publishLocalDualStream：设置是否允许推次要视频流。

aliElectronRtc.publishLocalDualStream(enable)

返回说明：0表示方法调用成功，其他表示方法调用失败。

• isDualStreamPublished：查询当前是否允许推次要视频流。

aliElectronRtc.isDualStreamPublished()

返回说明:true表示允许推次要视频流，false表示不允许推次要视频流。

订阅相关接口

• setRemoteVideoStreamType：设置订阅的相机流格式。

aliElectronRtc.setRemoteVideoStreamType(uid, streamType)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setRemoteDefaultVideoStreamType：设置默认订阅的相机流格式。

aliElectronRtc.SetRemoteDefaultVideoStreamType(streamType)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setDefaultSubscribeAllRemoteAudioStreams：设置是否默认拉音频流。

aliElectronRtc.setDefaultSubscribeAllRemoteAudioStreams(sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• subscribeAllRemoteAudioStreams：停止或恢复拉所有远端音频流。

aliElectronRtc.subscribeAllRemoteAudioStreams(sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• subscribeRemoteAudioStream：停止或恢复特定远端用户的音频流拉取。

aliElectronRtc.subscribeRemoteAudioStream(uid, sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setDefaultSubscribeAllRemoteVideoStreams：设置是否默认拉视频流。

aliElectronRtc.setDefaultSubscribeAllRemoteVideoStreams(sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• subscribeAllRemoteVideoStreams：停止或恢复拉所有远端视频流。

aliElectronRtc.subscribeAllRemoteVideoStreams(sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• subscribeRemoteVideoStream：停止或恢复特定远端用户的视频流拉取。

aliElectronRtc.subscribeRemoteVideoStream(uid, track, sub)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

视频相关接口

• setScreenShareEncoderConfiguration：设置屏幕共享编码属性。

aliElectronRtc.setScreenShareEncoderConfiguration(config)

• setLocalViewConfig：为本地预览设置渲染窗口

aliElectronRtc.setLocalViewConfig(element)

• enableLocalVideo：禁用或重新启用本地视频采集。

aliElectronRtc.enableLocalVideo(enable)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• muteLocalCamera：停止或恢复本地视频数据发送。

aliElectronRtc.muteLocalCamera(mute, track)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

说明此接口只是控制指定视频流上是否发送黑帧，采集和数据发送不会停止，如果需要关闭采集请使用enableLocalVideo接口，如果需要中止视频数据发送请使用publishLocalVideoStream接口。 ​

• setRemoteViewConfig：为远端的视频设置渲染窗口

aliElectronRtc.setRemoteViewConfig(uid, container, type)

• stopRecord：停止录制。

aliElectronRtc.stopRecord()

返回说明：true表示方法调用成功，false表示方法调用失败。 ​

• startRecord：开始录制

aliElectronRtc.startRecord(recordType, recordFormat, filePath, audioConfig, videoConfig, isFragment)

返回说明：true表示方法调用成功，false表示方法调用失败。 注：目前仅支持音频录制 ​

• pauseRecord：暂停录制。

aliElectronRtc.pauseRecord()

返回说明：true表示方法调用成功，false表示方法调用失败。

• resumeRecord：重新开始录制。

aliElectronRtc.resumeRecord()

返回说明：true表示方法调用成功，false表示方法调用失败。 ​

• setBeautyEffect：设置是否启用基础美颜。

aliElectronRtc.setBeautyEffect(enable, config)

返回说明：0表示方法调用成功，其他表示方法调用失败。

说明该接口目前只支持美白和磨皮。 ​

• setVideoEncoderConfiguration：设置视频编码属性。

aliElectronRtc.setVideoEncoderConfiguration(config)

共享视频接口

• startScreenShareByDesktopId：根据桌面ID进行屏幕分享。

aliElectronRtc.startScreenShareByDesktopId(desktopId, config) 

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明 配置指定区域分享时，分享区域最小分辨率为16 x 16，设置区域小于最小分辨率时重置为最小分辨率；设置分享区域超过实际桌面分辨率时，将分享整个桌面。 ​

• startScreenShareByWindowId：根据窗口ID进行屏幕分享。

aliElectronRtc.startScreenShareByWindowId(windowId, config)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• stopScreenShare：停止屏幕分享。

aliElectronRtc.stopScreenShare()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getScreenShareConfig：获取屏幕共享配置。

aliElectronRtc.getScreenShareConfig()

返回说明：返回屏幕共享配置信息 AliEngineScreenShareConfig​ ​

• getScreenShareSourceInfo：获取屏幕分享源信息。

aliElectronRtc.getScreenShareSourceInfo(sourceType).then(sourceInfo => {
	//...
})

返回说明：Promise 返回屏幕共享源列表

• getCurrentScreenShareSourceId：获取当前屏幕共享源ID。

aliElectronRtc.getCurrentScreenShareSourceId()

返回说明：返回当前屏幕共享源ID。 ​

• getCurrentScreenShareSourceType：获取当前屏幕共享源类型。

aliElectronRtc.getCurrentScreenShareSourceType()

返回说明：返回当前屏幕共享源类型。 ​

音频相关接口

• muteLocalMic：停止或恢复本地音频数据发送。

aliElectronRtc.muteLocalMic(mute, mode)

返回说明：0表示方法调用成功，其他表示方法调用失败。

说明 mute只是发送音频数据为静音帧，采集和编码模块仍然在工作。 ​

• muteRemoteAudio：停止或恢复远端的音频播放。

aliElectronRtc.muteRemoteAudio(uid, mute)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• muteAllRemoteAudio：停止或恢复远端所有的音频播放。

aliElectronRtc.muteAllRemoteAudio(mute)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startAudioCapture：开启音频采集。

aliElectronRtc.startAudioCapture()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• stopAudioCapture：关闭音频采集。

aliElectronRtc.stopAudioCapture()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startAudioPlayer：开启音频播放设备。

aliElectronRtc.StartAudioPlayer()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• stopAudioPlayer：关闭音频播放。

aliElectronRtc.stopAudioPlayer()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• enableAudioVolumeIndication：设置音量回调频率和平滑系数。

aliElectronRtc.enableAudioVolumeIndication(interval, smooth, reportVad)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setAudioProfile：设置音频Profile。

aliElectronRtc.setAudioProfile(audio_profile, audio_scene)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startAudioAccompany：开始混音

aliElectronRtc.startAudioAccompany(filePath, onlyLocalPlay, replaceMic, loopCycles)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• stopAudioAccompany：停止混音

aliElectronRtc.stopAudioAccompany()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setAudioAccompanyVolume：设置混音音量

aliElectronRtc.setAudioAccompanyVolume(volume)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明设置音量需要在startAudioAccompany后才能生效。 ​

• setAudioAccompanyPublishVolume：设置混音之后推流出去的音量

aliElectronRtc.setAudioAccompanyPublishVolume(volume)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明设置音量需要在startAudioAccompany后才能生效。 ​

• getAudioAccompanyPublishVolume：获取推流出去的混音音量

aliElectronRtc.getAudioAccompanyPublishVolume()

返回说明：返回推流出去的混音音量。 ​

• setAudioAccompanyPlayoutVolume：设置混音之后本地播放的音量

aliElectronRtc.setAudioAccompanyPlayoutVolume(volume)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明设置音量需要在startAudioAccompany后才能生效。 ​

• getAudioAccompanyPlayoutVolume：获取混音本地播放的音量

aliElectronRtc.getAudioAccompanyPlayoutVolume()

返回说明：当前混音本地播放的音量大小。 ​

• pauseAudioAccompany：暂停混音

aliElectronRtc.pauseAudioAccompany()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• resumeAudioAccompany：重新开始混音

aliElectronRtc.resumeAudioAccompany()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getAudioAccompanyDuration：获取伴奏文件时长

aliElectronRtc.getAudioAccompanyDuration()

返回说明：返回当前伴奏文件时长，单位为毫秒。 ​

• getAudioAccompanyCurrentPosition：获取音乐文件播放进度

aliElectronRtc.getAudioAccompanyCurrentPosition()

返回说明：当前音乐文件播放进度，单位为毫秒。 ​

• setAudioAccompanyPosition：设置音频文件的播放位置

aliElectronRtc.setAudioAccompanyPosition(pos)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• enableSystemAudioRecording：设置是否开启系统声音采集推送。

aliElectronRtc.enableSystemAudioRecording(enable, path)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• isSystemAudioRecording：当前是否开启系统声音采集推送。

aliElectronRtc.isSystemAudioRecording()

返回说明：true表示开启状态， false表示关闭状态。 ​

• setSystemAudioRecordingVolume：设置系统声音采集推送音量。

aliElectronRtc.setSystemAudioRecordingVolume(volume)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getSystemAudioRecordingVolume：获取当前设置系统声音采集推送音量。

aliElectronRtc.getSystemAudioRecordingVolume()

返回说明：返回系统音量。 说明需要开启系统声音采集推送后才能设置，否则设置失败。 ​

音频设备管理接口

• getAudioCaptureList：获取系统中的录音设备列表。

aliElectronRtc.getAudioCaptureList()

返回说明：返回系统中的录音设备列表。 ​

• getCurrentAudioCaptureName：获取使用的录音设备名称。

aliElectronRtc.getCurrentAudioCaptureName()

返回说明：返回当前音频采集设备名。 ​

• getCurrentAudioCaptureID：获取使用的录音设备ID。

aliElectronRtc.getCurrentAudioCaptureID()

返回说明：返回当前音频采集设备ID。 ​

• setCurrentAudioCaptureName：选择录音设备名称。

aliElectronRtc.setCurrentAudioCaptureName()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setCurrentAudioCaptureID：选择录音设备ID。

aliElectronRtc.setCurrentAudioCaptureID()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getAudioPlayerList：获取系统中的扬声器列表。

aliElectronRtc.getAudioPlayerList()

返回说明：返回音频播放设备列表。 ​

• getCurrentAudioPlayerName：获取当前使用的扬声器名称。

aliElectronRtc.getCurrentAudioPlayerName()

返回说明：返回当前音频播放设备名。 ​

• getCurrentAudioPlayerID：获取当前使用的扬声器ID。

aliElectronRtc.getCurrentAudioPlayerID()

返回说明：返回当前音频播放设备ID。 ​

• setCurrentAudioPlayerName：选择扬声器名称。

aliElectronRtc.setCurrentAudioPlayerName()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setCurrentAudioPlayerID：选择扬声器ID。

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startTestAudioRecordByName：开始测试音频采集设备

aliElectronRtc.startTestAudioRecordByName(deviceName, callbackInterval)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明开始测试后音量信息通过onAudioDeviceRecordLevel回调返回。 ​

• startTestAudioRecordById：开启麦克风设备测试（按设备ID）。

aliElectronRtc.startTestAudioRecordById(deviceId, callbackInterval)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明开始测试后音量信息通过onAudioDeviceRecordLevel回调返回。 ​

• stopTestAudioRecord：停止测试音频采集设备。

aliElectronRtc.stopTestAudioRecord()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startTestAudioPlayoutByName：开始测试音频播放设备。

aliElectronRtc.startTestAudioPlayoutByName(deviceName, filePath, callbackInterval, loopCycles)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• startTestAudioPlayoutById：开启扬声器设备测试（按设备ID）。

aliElectronRtc.startTestAudioPlayoutById(deviceId, filePath, callbackInterval, loopCycles)

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明开始测试后音量信息通过onAudioDevicePlayoutLevel回调返回。 ​

• stopTestAudioPlayout：停止测试音频播放设备。

aliElectronRtc.stopTestAudioPlayout()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

视频设备管理接口

• getCameraList：获取摄像头列表。

aliElectronRtc.getCameraList()

返回说明：返回摄像头列表。 ​

• getCurrentCameraName：获取当前使用的摄像头名称。

aliElectronRtc.getCurrentCameraName()

返回说明：返回当前使用的摄像头名称。 ​

• getCurrentCameraID：获取当前使用的摄像头ID。

aliElectronRtc.getCurrentCameraID()

返回说明：返回当前使用的摄像头ID。 ​

• setCurrentCameraName：选择摄像头名称。

aliElectronRtc.setCurrentCameraName(cameraName)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• setCurrentCameraID：选择摄像头ID。

aliElectronRtc.setCurrentCameraID(cameraID)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

预览接口

• startPreview：开始本地预览。

aliElectronRtc.startPreview()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• stopPreview：停止本地预览。

aliElectronRtc.stopPreview()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getUserInfo：查询远端用户的各种状态。

aliElectronRtc.getUserInfo(uid)

返回说明

• getSDKVersion：获取SDK版本号。

aliElectronRtc.getSDKVersion()

返回说明：返回SDK版本号。 ​

• setClientRole：设置用户角色。

aliElectronRtc.setClientRole(clientRole)

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getClientRole：获取用户角色。

aliElectronRtc.getClientRole()

返回说明：返回当前用户角色。 ​

• startLastmileDetect：开始网络质量探测。

aliElectronRtc.startLastmileDetect()

返回说明：0表示方法调用成功，其他表示方法调用失败。 说明此接口需在joinChannel之前调用，探测结果在onLastmileDetectResultWithQuality回调。 ​

• stopLastmileDetect：停止网络质量探测。

aliElectronRtc.stopLastmileDetect()

返回说明：0表示方法调用成功，其他表示方法调用失败。 ​

• getCurrentConnectionStatus：获取当前网络连接状态。

aliElectronRtc.getCurrentConnectionStatus()

返回说明：返回当前网络连接状态 AliEngineConnectionStatus ​

• on：订阅事件

aliElectronRtc.on(event, handler)

• off：取消订阅事件

aliElectronRtc.off(event, handler)

回调文档

目录

回调详情

• onJoinChannelResult：加入频道结果的回调。

aliElectronRtc.on("onJoinChannelResult", (result, channel, elapsed)=> {
	// ...
})

• onLeaveChannelResult：离开频道结果的回调。调用leaveChannel接口后返回，如果leaveChannel后直接释放SDK，将不会收到此回调。

aliElectronRtc.on("onJoinChannelResult", (result)=> {
	// ...
})

• onRemoteUserOnLineNotify：远端用户上线的回调。

aliElectronRtc.on("onRemoteUserOnLineNotify", (uid, elapsed)=> {
	// ...
})

• onRemoteUserOffLineNotify：远端用户下线的回调。

aliElectronRtc.on("OnRemoteUserOffLineNotify", (uid, reason)=> {
	// ...
})

• onAudioPublishStateChanged：音频推流变更的回调。

aliElectronRtc.on("onAudioPublishStateChanged", (oldState, newState, elapseSinceLastState, channel)=> {
	// ...
})

• onVideoPublishStateChanged：视频推流变更的回调。

aliElectronRtc.on("onVideoPublishStateChanged", (oldState, newState, elapseSinceLastState, channeluid, elapsed)=> {
	// ...
})

• onDualStreamPublishStateChanged：次要流推流变更的回调。

aliElectronRtc.on("onDualStreamPublishStateChanged", (oldState, newState, elapseSinceLastState, channel)=> {
	// ...
})

• onScreenSharePublishStateChangedWithInfo：屏幕分享推流变更的回调

aliElectronRtc.on("onRemoteUserOnLineNotify", (oldState, newState, elapseSinceLastState, channel, screenShareInfo)=> {
	// ...
})

• onRemoteTrackAvailableNotify：远端用户音视频流发生变化时的回调。

aliElectronRtc.on("onRemoteTrackAvailableNotify", (uid, audioTrack, videoTrack)=> {
	// ...
})

• onAudioSubscribeStateChanged：音频订阅情况变更的回调。

aliElectronRtc.on("onAudioSubscribeStateChanged", (uid, oldState, newState, elapseSinceLastState, channel)=> {
	// ...
})

• onVideoSubscribeStateChanged：相机流订阅情况变更的回调。

aliElectronRtc.on("onVideoSubscribeStateChanged", (uid, oldState, newState, elapseSinceLastState, channel)=> {
	// ...
})

• onScreenShareSubscribeStateChanged：屏幕分享流订阅情况变更的回调。

aliElectronRtc.on("onRemoteUserOnLineNotify", (uid, oldState, newState, elapseSinceLastState, channel)=> {
	// ...
})

• onSubscribeStreamTypeChanged：大小流订阅情况变更的回调。

aliElectronRtc.on("onSubscribeStreamTypeChanged", (uid, oldStreamType, newStreamType, elapseSinceLastState, channel)=> {
	// ...
})

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

aliElectronRtc.on("onOccurWarning", (warn, msg)=> {
	// ...
})

• onOccurError：错误回调。

aliElectronRtc.on("onOccurError", (error, msg)=> {
	// ...
})

• onBye：被服务器踢出或者频道关闭时的回调。

aliElectronRtc.on("onBye", (code)=> {
	// ...
})

• onAudioDeviceStateChanged：音频设备状态变更的回调。

aliElectronRtc.on("onAudioDeviceStateChanged", (deviceInfo, deviceType, deviceState)=> {
	// ...
})

• onVideoDeviceStateChanged：视频设备状态变更的回调。

aliElectronRtc.on("onVideoDeviceStateChanged", (deviceInfo, deviceType, deviceState)=> {
	// ...
})

• onNetworkQualityChanged：网络质量变化时的回调。

aliElectronRtc.on("onNetworkQualityChanged", (uid, upQuality, downQuality)=> {
	// ...
})

• onConnectionStatusChange：网络连接状态改变的回调。

aliElectronRtc.on("onConnectionStatusChange", (status, reason)=> {
	// ...
})

• onUserAudioMuted：对端用户停止音频数据发送的通知。

aliElectronRtc.on("onUserAudioMuted", (uid, isMute)=> {
	// ...
})

• onUserVideoMuted：对端用户发送视频黑帧数据发送的通知。

aliElectronRtc.on("onUserVideoMuted", (uid, isMute)=> {
	// ...
})

• onUpdateRoleNotify：用户角色发生改变时的回调。

aliElectronRtc.on("onUpdateRoleNotify", (oldRole, newRole)=> {
	// ...
})

• onAudioPlayingStateChanged：伴奏播放的回调。

aliElectronRtc.on("onAudioPlayingStateChanged", (type, errorCode)=> {
	// ...
})

• onLastmileDetectResultWithQuality：网络质量探测的回调。

aliElectronRtc.on("onLastmileDetectResultWithQuality", (networkQuality)=> {
	// ...
})

• onAudioDeviceRecordLevel：音频采集设备测试的回调。

aliElectronRtc.on("onAudioDeviceRecordLevel", (level)=> {
	// ...
})

• onAudioDevicePlayoutLevel：音频播放设备测试回调。

aliElectronRtc.on("onAudioDevicePlayoutLevel", (level)=> {
	// ...
})

• onAudioDevicePlayoutEnd：音频播放设备测试结束（音频文件播放完毕）时的回调。

aliElectronRtc.on("onAudioDevicePlayoutEnd", ()=> {
	// ...
})

• onStats：当前会话统计信息回调（2s触发一次）。

aliElectronRtc.on("onStats", (stats)=> {
	// ...
})

• onLocalVideoStats：本地视频统计信息回调（2s触发一次）。

aliElectronRtc.on("onLocalVideoStats", (localVideoStats)=> {
	// ...
})

• onRemoteVideoStats：远端视频统计信息回调（2s触发一次）。

aliElectronRtc.on("onRemoteVideoStats", (remoteVideoStats)=> {
	// ...
})

• onLocalAudioStats：本地音频统计信息回调（2s触发一次）。

aliElectronRtc.on("onLocalAudioStats", (localAudioStats)=> {
	// ...
})

• onRemoteAudioStats：远端音频统计信息回调（2s触发一次）。

aliElectronRtc.on("onRemoteAudioStats", (remoteAudioStats)=> {
	// ...
})

• onMediaRecordEvent：录制事件回调。

aliElectronRtc.on("onMediaRecordEvent", (event, filePath)=> {
	// ...
})

• onAudioVolumeCallback：用户音量大小的回调。

aliElectronRtc.on("onAudioVolumeCallback", (volumeInfo)=> {
	// ...
})

• onActiveSpeaker：订阅的当前说话人。当前时间段说话可能性最大的用户uid。如果返回的uid为0，则默认为本地用户。

aliElectronRtc.on("onActiveSpeaker", (uid)=> {
	// ...
})

数据类型

目录

数据详情

注：枚举数据没有标注枚举值的默认按照表格从0开始枚举递增 ​

• AliEngineAudioPlayingType：音乐伴奏播放状态。

• AliEngineAudioPlayingErrorCode：音乐伴奏播放错误码。

• AliEngineConnectionStatus：网络连接状态。

• AliEngineConnectionStatusChangeReason：网络连接状态变更原因。

• AliEnginePublishState：推流状态。

• AliEngineSubscribeState：订阅状态。

• AliEngineVideoTrack：视频流的类型。

• AliEngineAudioTrack：音频流的类型。

• AliEngineVideoStreamType：相机流类型。

• AliEngineVideoRecordSource：录制视频数据源。

• AliEngineRotationMode：视频旋转角度。

• AliEngineAudioSampleRate：音频采样率类型。

• AliEngineNetworkQuality：网络质量。

• AliEngineAuthInfo：鉴权信息

• AliEngineOnByeType：OnBye类型。

• AliEngineUserOfflineReason：用户离线原因。

• AliEngineScreenShareType：桌面分享类型。

• AliEngineClientRole：角色类型。

• AliEngineExternalDeviceType：外接设备类型。

• AliEngineExternalDeviceState：外接设备状态。

• AliEngineMuteLocalAudioMode：本地静音模式。

• AliEngineUserVolumeInfo：用户音量信息。

• AliEngineScreenShareRegion：屏幕共享区域。

• AliEngineScreenShareEncoderConfiguration：屏幕流码属性设置。

• AliEngineScreenShareConfig：屏幕共享参数配置。

• AliEngineScreenShareInfo：屏幕共享配置信息。

• AliEngineStats：会话数据统计信息。

• AliEngineLocalVideoStats：本地视频统计信息。

• AliEngineRemoteVideoStats：远端视频统计信息。

• AliEngineLocalAudioStats：本地音频统计信息。

• AliEngineRemoteAudioStats：远端音频统计信息。

• AliEngineAudioProfile：音频编码配置。

• AliEngineAudioScenario：音频场景。

• AliEngineRecordType：录制类型。

• AliEngineRecordFormat：录制格式。

• AliEngineAudioQuality：录制音频质量。

• AliEngineVideoQuality：录制视频质量。

• AliEngineRecordAudioConfig：录制音频设置。

• AliEngineRecordVideoConfig：录制视频设置。

• AliEngineFrameRate：视频帧率。

• AliEngineVideoEncoderBitrate：视频编码码率。

• AliEngineVideoEncoderOrientationMode：视频输出模式。

• AliEngineVideoMirrorMode：视频镜像模式。

• AliEngineVideoDimensions：视频分辨率。

• AliEngineVideoEncoderConfiguration：视频编码属性设置。

• AliEngineChannelProfile：频道类型。

• AliEngineErrorCode：SDK错误码。

• AliEngineBeautyConfig：美颜设置。

• AliEngineDeviceInfo：设备信息。

• ChannelMediaOptions：入会选项