开发者中心
互动直播
Agora.io 社区
中文
search-icon
Agora Electron SDK API Reference
概览 AgoraRtcEngine Events 错误码与警告码

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

AgoraNetworkQuality

AgoraNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6

网络质量：

  • 0：质量未知
  • 1：质量极好
  • 2：主观感觉和极好差不多，但码率可能略低于极好
  • 3：主观感受有瑕疵但不影响沟通
  • 4：勉强能沟通但不顺畅
  • 5：网络质量非常差，基本不能沟通
  • 6：网络连接已断开，完全无法沟通

CaptureRect

CaptureRect: Rectangle

ClientRoleType

ClientRoleType: 1 | 2

用户角色类型：

  • 1：主播
  • 2：观众

ConnectionChangeReason

ConnectionChangeReason: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

引起当前网络状态发生改变的原因：

  • 0：建立网络连接中
  • 1：成功加入频道
  • 2：网络连接中断
  • 3：网络连接被服务器禁止
  • 4：加入频道失败。SDK 在尝试加入频道 20 分钟后还是没能加入频道，会返回该状态，并停止尝试重连
  • 5：离开频道
  • 6：不是有效的 APP ID。请更换有效的 APP ID 重新加入频道
  • 7：不是有效的频道名。请更换有效的频道名重新加入频道
  • 8：生成的 Token 无效
  • 9：当前使用的 Token 过期，不再有效，需要重新在你的服务端申请生成 Token
  • 10：此用户被服务器禁止
  • 11：由于设置了代理服务器，SDK 尝试重连
  • 12：更新 Token 引起网络连接状态改变
  • 13：客户端 IP 地址变更，可能是由于网络类型，或网络运营商的 IP 或端口发生改变引起

ConnectionState

ConnectionState: 1 | 2 | 3 | 4 | 5

网络连接状态。

1：网络连接断开。该状态表示 SDK 处于：

2：建立网络连接中。该状态表示 SDK 在调用 joinChannel 后正在与指定的频道建立连接。

  • 如果成功加入频道，App 会收到 connectionStateChanged 回调，通知当前网络状态变成 3：网络已连接
  • 建议连接后，SDK 还会处理媒体初始化，一切就绪后会回调 joinedChannel

3：网络已连接。该状态表示用户已经加入频道，可以在频道内发布或订阅媒体流。如果因网络断开或切换而导致 SDK 与频道的连接中断，SDK 会自动重连，此时 App 会收到：

  • connectionStateChanged 回调，通知网络状态变成 4：重新建立网络连接中

4：重新建立网络连接中。该状态表示 SDK 之前曾加入过频道，但因网络等原因连接中断了，此时 SDK 会自动尝试重新接入频道。

  • 如果 SDK 无法在 10 秒内重新接入频道，则 connectionLost 会被触发，SDK 会一致保留该状态，并不断尝试重新加入频道
  • 如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，App 会收到 connectionStateChanged 回调，通知当前网络状态进入 5：网络连接失败，SDK 停止尝试重连

5：网络连接失败。该状态表示 SDK 已不再尝试重新加入频道，用户必须要调用 leaveChannel 离开频道。

  • 如果用户还想重新加入频道，则需要再次调用 joinChannel
  • 如果 SDK 因服务器端使用 RESTful API 禁止加入频道，则 App 会收到 connectionStateChanged 回调

MacScreenSymbol

MacScreenSymbol: number

MediaDeviceType

MediaDeviceType: -1 | 0 | 1 | 2 | 3 | 4

媒体设备类型：

  • -1：未知的设备类型
  • 0：音频播放设备
  • 1：音频录制设备
  • 2：视频渲染设备
  • 3：视频采集设备
  • 4：应用的音频播放设备

RemoteVideoState

RemoteVideoState: 1 | 2

远端视频状态：

  • 1：远端视频状态正常
  • 2：远端视频卡顿，可能是由于网络条件导致

ScreenSymbol

ScreenSymbol: MacScreenSymbol | WindowsScreenSymbol

StreamType

StreamType: 0 | 1

视频流类型：

  • 0：视频大流，即高分辨率、高码率视频流
  • 1：视频小流，即低分辨率、低码率视频流

WindowsScreenSymbol

WindowsScreenSymbol: Rectangle

Variables

Const agora

agora: any = require('../../build/Release/agora_node_ext')
score