AgoraWebSDK NG API Docs

注意:

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

Agora Web SDK NG 支持所有的主流浏览器,详见浏览器支持

请务必使用 HTTPS 协议或者 localhost,否则 SDK 无法正常工作。

阅读建议

  • Agora 建议你在查看 API 注释前先阅读功能文档
  • 你可以通过页面右上方的搜索功能快速查找 API。

全局模块

AgoraRTC 是 Agora Web SDK NG 中所有可调用方法的入口,主要包含以下方法。

核心方法

方法 描述
createClient 创建本地客户端

本地音视频采集

方法 描述
createMicrophoneAudioTrack 通过麦克风创建一个音频轨道对象
createCameraVideoTrack 通过摄像头创建一个视频轨道对象
createMicrophoneAndCameraTracks 同时创建麦克风音频轨道和摄像头视频轨道
createScreenVideoTrack 通过屏幕共享创建一个视频轨道对象
createBufferSourceAudioTrack 通过音频文件创建一个音频轨道对象
createCustomAudioTrack 创建一个自定义的音频轨道对象
createCustomVideoTrack 创建一个自定义的视频轨道对象

媒体设备查询

方法 描述
getDevices 获取媒体设备列表
getCameras 获取摄像头列表
getMicrophones 获取麦克风列表
getPlaybackDevices 获取音频播放设备列表
getElectronScreenSources 获取 Electron 屏幕共享源列表

日志管理

方法 描述
enableLogUpload 打开日志上传功能
disableLogUpload 关闭日志上传功能
setLogLevel 设置日志等级

全局事件回调

回调 描述
onCameraChanged 视频采集设备状态变化回调
onMicrophoneChanged 音频采集设备状态变化回调
onAudioAutoplayFailed 音频轨道自动播放失败回调

其他

方法 描述
checkSystemRequirements 检测浏览器兼容性
getSupportedCodec 获取支持的编码格式
createChannelMediaRelayConfiguration 创建跨频道媒体流转发的配置对象

AgoraRTCClient 类

调用 createClient 创建一个本地客户端对象 AgoraRTCClient,代表一个通话中的本地用户。AgoraRTCClient 类提供音视频通话的核心功能,主要包含以下方法。

方法 描述
join 加入频道
leave 离开频道
publish 发布本地音视频轨道
unpublish 取消发布本地音视频轨道
subscribe 订阅远端用户的音视频轨道
unsubscribe 取消订阅远端用户的音视频轨道

LocalTrack 类

LocalTrack 是 Agora Web SDK NG 中定义本地音视频轨道的抽象类,可用于本地播放和发布。

SDK 通过不同的方式创建不同的 LocalTrack,返回不同的 LocalTrack 派生类对象。以下列举了所有的 LocalTrack 派生类以及所对应的创建方式。

本地音频轨道

根据创建方式的不同,本地音频轨道可分为以下三种。其中 LocalAudioTrack 派生自 LocalTrackMicrophoneAudioTrackBufferSourceAudioTrack 派生自 LocalAudioTrack

本地音频轨道 描述
LocalAudioTrack 最基础的本地音频轨道对象,包含了基础的本地音频控制,如播放、设置音量控制。
通过调用 AgoraRTC.createCustomAudioTrack 创建。
MicrophoneAudioTrack 本地麦克风音频轨道对象,比 LocalAudioTrack 多一些控制麦克风的方法。
通过调用 AgoraRTC.createMicrophoneAudioTrack 创建。
BufferSourceAudioTrack 通过读取音频数据源创建的本地音频轨道,比基础的 LocalAudioTrack 多一些控制音频数据源的方法。
通过调用 AgoraRTC.createBufferSourceAudioTrack 创建。

本地视频轨道

根据创建方式的不同,本地视频可分为以下两种。其中 LocalVideoTrack 派生自 LocalTrackCameraVideoTrack 派生自 LocalVideoTrack

本地视频轨道 描述
LocalVideoTrack 最基础的本地视频轨道对象,包含了基础的本地视频控制,如播放、美颜。
通过调用 AgoraRTC.createCustomVideoTrackAgoraRTC.createScreenVideoTrack 创建。
CameraVideoTrack 本地摄像头视频轨道对象,比 LocalVideoTrack 多一些控制摄像头和编码参数的方法。
通过调用 AgoraRTC.createCameraVideoTrack 创建。

RemoteTrack 类

RemoteTrack 是 Agora Web SDK NG 中用于定义远端音视频轨道的抽象类。

在实际操作中,你需要先调用 AgoraRTCClient.subscribe 订阅远端用户,然后从远端用户对象 AgoraRTCRemoteUser 中获取派生自 RemoteTrackRemoteAudioTrack 对象和 RemoteVideoTrack 对象。

引入方式

如果你通过 <script> 的方式引入 Agora Web SDK NG,可以通过访问 AgoraRTC.createClient 来获取导出的模块。

如果你通过 npm 或者模块化的方式引入 Agora Web SDK NG,可以通过以下方式访问 AgoraRTC:

import AgoraRTC from "agora-rtc-sdk-ng";
console.log(AgoraRTC.createClient);

类型模块(适用于 Typescript)

对于 Typescript 开发者,我们提供了 .d.ts 文件导出详细的类型定义。你可以查看 API 文档的 Global 页面,该页面列出了所有 SDK 导出的模块和类型。

import AgoraRTC, { IAgoraRTCClient } from "agora-rtc-sdk-ng";

const client: IAgoraRTCClient = AgoraRTC.createClient();