Agora Web SDK 是通过 HTML 网页加载的 JavaScript 库。 Agora Web SDK 库在网页浏览器中调用 API 建立连接,控制音视频通话和直播服务。

AgoraRTC 是 Agora Web SDK 中所有可调用方法的入口。

AgoraRTC 包含以下类:

描述
Client 提供 AgoraRTC 核心功能的 web 客户端对象。
ClientConfig 定义 createClient 创建的 Client 对象的属性。
Stream 设置通话中的本地或远程音视频流。
StreamSpec 定义 createStream 创建的 Stream 对象的属性。
LocalStreamStats 提供本地音视频流的连接统计数据。
RemoteStreamStats 提供远端音视频流的连接统计数据。
LiveTranscoding 管理旁路推流转码。
MediaDeviceInfo 提供媒体设备的信息。

Client 客户端对象

使用 Agora Web SDK 的第一步就是调用 createClient 创建客户端对象。

客户端对象指通话中的本地或远程用户,提供 AgoraRTC 的核心功能。下表列出 Client 的所有方法:

方法 描述
init 初始化客户端对象。
join 加入 AgoraRTC 频道。
leave 离开 AgoraRTC 频道。
publish 发布本地音视频流至 SD-RTN。
unpublish 取消发布本地音视频流。
subscribe 接收远端音视频流。
unsubscribe 取消接收远端音视频流。
on 监听 Client 方法触发的事件并通知 App。
enableDualStream 开启双流模式。双流为视频大流和视频小流,其中视频大流指高分辨率、高码率的视频流,视频小流指低分辨率、低码率的视频流。
setLowStreamParameter 设置小流视频参数。如果你开启了双流模式,该方法设置小流的视频参数。
setRemoteVideoStreamType 设置视频大小流。
setStreamFallbackOption 设置音视频流回退策略。网络不理想的情况下,为保证通话质量,可以选择自动订阅视频小流或者仅订阅音频流。
disableDualStream 关闭双流模式。
enableAudioVolumeIndicator 启用说话者音量提示。该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。
configPublisher 已废弃。配置直播旁路推流。该方法在加入频道前配置旁路直播推流服务。
startLiveStreaming 新建直播流。
setLiveTranscoding 设置直播转码。
stopLiveStreaming 停止并删除直播流。
setProxyServer 部署 Nginx 服务器。
setTurnServer 部署 TURN 服务器。
setEncryptionSecret 设置 AES 加密密码。
setEncryptionMode 设置 AES 加密方案。
renewToken 更新 Token。
renewChannelKey 更新 Channel Key。

Stream 音视频流对象

音视频流对象指通话中的本地或远程音视频流,提供对音视频流的设置。下表列出 Stream 的所有方法:

方法 描述
init 初始化音视频流对象。
on 监听 Stream 方法触发的事件并通知 App。
play 播放音视频流。
stop 停止播放音视频流。
close 关闭音视频输入设备,如摄像头。
enableAudio 启用音频轨道。
disableAudio 禁用音频轨道。
hasAudio 获取音频 flag。
getAudioLevel 获取当前音量。
setAudioVolume 调节远端流的音量大小。
setAudioOutput 设置音频输出设备,可以在麦克风和扬声器之间切换。
setAudioProfile 设置音频属性。
enableVideo 启用视频轨道。
disableVideo 禁用视频轨道。
hasVideo 获取视频 flag。
setVideoProfile 设置视频属性。
setScreenProfile 设置屏幕共享中的屏幕属性。
getId 获取音视频流 ID。
getStats 获取连接统计数据。

错误代码和警告代码

详见错误代码和警告代码