Agora Video SDK for WordPress 插件——快速集成教程

Agora Video for WordPress 插件可以让你轻松地将直播或视频会议功能,添加到你的 WordPress 帖子和页面。通过 WordPress 管理面板创建和配置 "直播 "或 "通话 "频道。每个频道都有自己的设置页面,您可以在通话/互动直播设置中自定义。

安装

有多种方式可以为 WordPress 安装 Agora Video 插件,可通过 WordPress 管理面板,也可以通过 FTP 安装。

方法一:通过搜索安装

  1. 在 WordPress 管理面板的左侧边栏中,选择“插件->添加新插件”;
  2. 搜索“agora.io”;
  3. 点击“现在安装”按钮;
  4. 当按钮变为“Installed”之后,点击“Active”(启用)按钮。

方法二:上传安装插件

  1. 访问 Agora Video for WordPress 插件页面(https://wordpress.org/plugins/wp-agora-io/) ,下载插件压缩包;
  2. 在 WordPress 管理面板左侧边栏,找到“插件”,在弹出目录中选择“上传”;
  3. 在显示弹窗后,上传 wp-agora-io.zip;
  4. 成功上传后,点击“Activate”(启用)按钮

方法三:通过 FTP 安装

  1. 访问 Agora Video for WordPress 插件页面(https://wordpress.org/plugins/wp-agora-io/) , 下载插件压缩包;
  2. 解压,并上传 wp-agora-io 文件夹至 /wp-content/plugins/directory ;
  3. 在 WordPress 管理面板中,选择“Activate”(启用)该插件。

设置

就像安装一样,有几种不同的方法来设置 Agora Video for WordPress 插件。基本设置可以让你使用基本的直播和视频通话功能。高级设置将启用一些功能,如将流媒体推送到第三方 CDN 服务器或从 CDN 服务器拉取流媒体到频道中。高级设置还可以启用云端录制功能,让使用者可以轻松地将直播流录制到你所指定的云端存储服务。

基本设置

  1. 创建并登录 Agora 开发者账号(Agora 后台https://console.agora.io);
  2. 在 Agora 后台创建第一个项目,并记下后台生成的“App ID”和“App 证书”;
  3. 回到 WordPress 的 Agora 插件设置页面,填写“App ID”和“App 证书”。

进阶设置

  1. 创建并登录 Agora 开发者账号(Agora 后台https://console.agora.io);
  2. 在 Agora 后台创建第一个项目,并复制后台生成的“App ID”和“App 证书”;
  3. 进入“产品用量”页面,开启旁路推流与云录制功能;
  4. 在 Agora 后台,将鼠标拖动至右上角名字处,选择“RESTful API”,复制你的“客户 ID”和“客户证书”;
  5. 回到 WordPress 插件设置界面,填写“App ID”、“App 证书”、“客户 ID”和“客户证书”。

查看所有频道

在 WordPress 管理面板中选择“Agora.io”,你将会看到一个频道列表,这里列出了已经被创建的频道。你可以通过点击来编辑或删除现存的频道。

创建频道

Agora.io 插件中选择“Add New Channel”,然后你将会看到很多选项。第一个选项是为你将创建的频道设定类型。每个频道类型都有自己的配置,UI 也会根据你选择的频道类型二改变。

Agora 的 WordPress Shortcode

当你创建频道后,后台会自动生成一个 Shortcode。Agora 插件有两个 Shortcode,这取决于你选择的频道类型。

如果你选择的是通话,则会得到:

[agora-communication channel_id=""]

如果你选择的是互动直播,则会得到:

[agora-broadcast channel_id=""]

你需要在对应的 Shortcode 中填写正确的频道 ID。

Agora Video for WordPress插件还将video_profile设置作为 Shortcode 的一部分。如果该设置被省略,那么插件将不设置profile,Agora SDK将使用其默认profile。

对于通话模式,可以使用:

[agora-communication channel_id="" videoProfile="720p_3"]

对于互动直播模式,可以使用:

[agora-broadcast channel_id="" videoProfile="720p_3"]

更多参数,可以访问声网文档中心获取:

https://docs.agora.io/en/Video/video_profile_web?platform=Web#recommended-video-profiles

你可以实现什么场景呢?

通过使用 Shortcode,你可以非常便捷地在发布的文章或页面中嵌入互动直播或视频通话功能。

互动直播

在互动直播模式下,指定用户可以发布视频流。其它进入这个页面的用户将成为观众。

群组聊天

在群组通话模式下,任何进入该页面的用户,都可以加入视频通话频道,与其它用户聊天。

相关资源

如果你在设置过程中遇到问题,可以在 RTC 开发者社区发帖提问。如果你有任何新的需求,或认为插件还有任何改进的空间,欢迎在 Github repo 中提交 Pull Request。

Github repo:https://github.com/AgoraIO/Agora-Word-Press

Agora Video SDK for WordPress 插件是基于 Agora Web SDK 实现的。如需要为该插件增加更多功能,可以参考官方文档,了解如何使用 Web SDK。