功能简介
ZEGO Express SDK 支持推流到 CDN(Content Delivery Network,内容分发网络),包括转推 CDN 和直推 CDN 两种功能。开发者基于该功能可打通 RTC 产品和 CDN 直播产品,方便用户从网页或第三方播放器直接观看和收听直播内容。为了保证安全,推流到 CDN 时默认开启 CDN 鉴权。
为防止攻击者盗取或伪造您的推流 URL 地址,您可以参考 CDN 推流鉴权,提升您推流使用的安全性。
1转推 CDN
转推 CDN 指的是将音视频流从 ZEGO 音视频云推送到 ZEGO 自有 CDN 或第三方 CDN 的过程。
转推 CDN 包括以下三种方式:
- 默认转推 CDN
用户使用 ZEGO Express SDK 推流到 ZEGO 音视频云的直播流均会转推到 CDN,目前仅支持 ZEGO 自有 CDN。
- 旁路转推 CDN
开发者自定义指定 ZEGO 实时音视频云上的流转推至 CDN,支持 ZEGO 自有 CDN 和第三方 CDN。
- 混流转推 CDN
混流场景也可以将输出流转推至 CDN,支持ZEGO 自有 CDN 和第三方 CDN。
2直推 CDN
直推 CDN 指的是将音视频流直接从本地客户端推送到 ZEGO 自有 CDN 的过程,用户可直接通过拉流 URL 地址从网页或第三方播放器进行观看。但由于直推 CDN 功能在网络传输过程中不经过 ZEGO 实时音视频云,因此开发者无法使用 ZEGO 的超低延迟音视频服务。
3功能对比
两种功能的说明与使用场景如下:
在发起转推或直推 CDN 时需注意,CDN 对音视频格式有所要求,推流端音频支持 AAC 与 MP3,视频支持 H.264 与 H.265(需要 CDN 配置)。
前提条件
在使用 CDN 直播之前,请确保:
- 已在项目中集成 ZEGO Express SDK,实现基本的实时音视频功能,详情请参考 快速开始 - 集成 和 快速开始 - 实现视频通话。
- 已在 ZEGO 控制台 创建项目,并申请有效的 AppID 和 AppSign,详情请参考 控制台 - 项目管理 中的“项目信息”。
CDN 直播功能不是默认开启的,使用前请在 ZEGO 控制台 自助开通(开通步骤请参考 项目管理 - 服务配置 中的“CDN”),或联系 ZEGO 技术支持开通。
转推 CDN
若选择使用直推 CDN 功能,则无需执行本节所有步骤。
1初始化和登录房间
请参考 快速开始 - 实现视频通话 的 “3.1 创建引擎”、“3.2 登录房间”。
2开始推流
日常生活中,我们经常需要用到各种各样的证件,例如红底、蓝底、白底等,然而针对不同证件的需求去照相馆多次拍摄需要花费一定的经济与时间成本。当然市面上有很多专业的图像处理软件,但是对于普通人而言,专业软件的学习还是存在一定的学习门槛。
请参考 快速开始 - 实现视频通话 的 “3.3 推流”。
3开始转推
日常生活中,我们经常需要用到各种各样的证件,例如红底、蓝底、白底等,然而针对不同证件的需求去照相馆多次拍摄需要花费一定的经济与时间成本。当然市面上有很多专业的图像处理软件,但是对于普通人而言,专业软件的学习还是存在一定的学习门槛。
当推流成功后,调用 addPublishCdnUrl 接口增加动态转推至 CDN 的 URL,即可将已经成功推向 ZEGO 实时云的音视频流动态向第三方 CDN 进行转推。支持的转推地址格式为 “rtmp”。
- 若开发者有转推到多家第三方 CDN 厂商的需求,可使用同一个流 ID 多次调用 addPublishCdnUrl 接口(URL 需要不同)。
- 开发者转推到多家第三方 CDN 后,停止转推时也同样需要调用多次来停止所有转推的流。
- 开发者转推到多家第三方 CDN 后,可从 CDN 回调状态通知 publisherRelayCDNStateUpdate 的列表参数中获取到每条转推流的状态变更通知。
/** 推流成功后,开始转推到CDN */
// 推流时使用的流ID
let streamID = "STREAM_ID";
// 需要转推的CDN地址,请开发者按照实际URL填入,streamID为推流的流名,可自定义
let URL = "rtmp://推流域名/接入点/streamID";
ZegoExpressEngine.instance().addPublishCdnUrl(streamID, URL).then((result) {
if(result.errorCode == 0) {
// 转推成功
} else {
// 转推失败,可能由于网络原因转推请求发送失败
}
});
4(可选)监听CDN转推状态通知
日常生活中,我们经常需要用到各种各样的证件,例如红底、蓝底、白底等,然而针对不同证件的需求去照相馆多次拍摄需要花费一定的经济与时间成本。当然市面上有很多专业的图像处理软件,但是对于普通人而言,专业软件的学习还是存在一定的学习门槛。
1、添加/删除转推 CDN 地址状态回调
开发者可通过注册 publisherRelayCDNStateUpdate 获取添加/删除转推 CDN 地址状态回调。在 ZEGO RTC 服务器将音视频流转推到 CDN 后,如果 CDN 转推状态发生变化,例如出现转推停止或转推重试,将会收到此回调。
开发者可根据该回调判断转推 CDN 的音视频流是否正常:
- 若不正常,则根据异常原因进一步定位转推 CDN 的音视频流异常的原因,以及做对应的容灾策略。
- 若对异常的原因不了解,可联系 ZEGO 技术支持分析具体异常的原因。
ZegoExpressEngine.instance().on("publisherRelayCDNStateUpdate", (streamID, infoList) => {
console.log(`publisherRelayCDNStateUpdate:streamID:${streamID}, infoList:${JSON.stringify(infoList)}`);
});
2、转推 CDN 信息详解
转推 CDN 信息 ZegoStreamRelayCDNInfo 包含了 CDN 推流的 URL、转推状态、转推状态变更的原因、状态发生的时间。ZegoStreamRelayCDNInfo 内所有参数如下:
其中,state取值如下:
updateReason 取值如下:
5停止转推
日常生活中,我们经常需要用到各种各样的证件,例如红底、蓝底、白底等,然而针对不同证件的需求去照相馆多次拍摄需要花费一定的经济与时间成本。当然市面上有很多专业的图像处理软件,但是对于普通人而言,专业软件的学习还是存在一定的学习门槛。
调用 removePublishCdnUrl 接口即可删除动态转推至 CDN 的 URL。
该接口并不会停止推往 ZEGO 实时音视频云的音视频流。
// 推流时使用的流ID
let streamID = "STREAM_ID";
// 需要停止转推的CDN地址,请开发者按照实际URL填入,streamID为推流的流名
let URL = "rtmp://推流域名/接入点/streamID";
ZegoExpressEngine.instance().removePublishCdnUrl(streamID, URL).then((result) {
if(result.errorCode == 0) {
// 停止转推成功
} else {
// 停止转推失败,可能由于网络原因停止转推请求发送失败
}
});
直推 CDN
若选择使用转推 CDN 功能,则无需执行本节所有步骤。
1开始直推CDN
在推流前调用 enablePublishDirectToCDN 接口将音视频流直接推往 CDN。
- 调用 enablePublishDirectToCDN 接口后再调用 addPublishCdnUrl 与 removePublishCdnUrl 动态转推至 CDN 则不再生效,因为这两个接口是从 ZEGO 实时音视频云将音视频流转推或停止转推到 CDN,若将音视频流直接推往 CDN 则无法通过 ZEGO 实时音视频云将音视频流再动态转推至 CDN。
- 若调用 enablePublishDirectToCDN 接口出现 1000038 错误码,可能存在的问题有:域名配置错误、媒体网络异常或媒体网络链接为空,请联系 ZEGO 技术支持。
let config = new ZegoCDNConfig();
// URL 需要开发者根据实际情况填写,streamID为推流的流名,可自定义
config.url = "rtmp://推流域名/接入点/streamID";
ZegoExpressEngine.instance().enablePublishDirectToCDN(true, config);
ZegoExpressEngine.instance().startPublishingStream("STREAM_ID");
2 停止直推 CDN
若需停止直推 CDN,调用 stopPublishingStream 接口停止推流即可。
停止推流后,若下一次推流无需直推 CDN,则可以调用 enablePublishDirectToCDN 接口并传值为 “false” 关闭直推 CDN 功能。在推流途中调用此接口不会影响此次推流。
ZegoExpressEngine.instance().stopPublishingStream();
let config = new ZegoCDNConfig();
ZegoExpressEngine.instance().enablePublishDirectToCDN(false, config);
观众拉流
- 当开发者使用 ZEGO 配置的 CDN 进行直推时,则可以直接通过 streamID 进行拉流,请参考 快速开始 - 实现视频通话 的 “3.4 拉流”。
- 当音视频流转推 CDN 成功后,开发者希望用户从 CDN 进行拉流时,需要使用传入 URL 的自定义拉流方式进行拉流,而不能通过流 ID 进行拉流。URL 拉流的操作步骤可参考 推拉流进阶 - 通过 URL 拉流 中的 “4.1 配置推拉流参数” 和 “4.2 开始拉流”。