创建订阅资源--WebRTC 传输网络-火山引擎

文档中心

立即注册

导航

创建订阅资源

最近更新时间：2024.09.10 10:48:20首次发布时间：2022.08.30 14:30:09

在订阅 WTN 的媒体流资源之前，你应创建订阅资源。
关于订阅资源，参看发布资源与订阅资源。

使用说明

接口行为

调用此接口，向 WTN 服务端发送 SDP Offer。如果调用成功，WTN 服务端会创建订阅资源，订阅客户端会收到来自 WTN 服务端的 SDP Answer。

订阅鉴权

是否订阅鉴权在创建发布资源时通过携带的 Token 设置。关于具体设置，参看鉴权。

注意事项

前提条件

在 WTN 的机制下，在创建订阅资源前，你必须已成功创建对应的发布资源；否则会收到 404 的响应码。关于如何创建发布资源，参看创建发布资源。
连接订阅资源以后，并不一定能够收到音视频流。仅在发布客户端发布音视频流时，你才可以收到音视频流。

后续操作

创建订阅资源，并开始订阅时，注意：

如果创建订阅资源后 15 秒未开始订阅，订阅资源会被删除，你必须重新创建订阅资源；
如果有多个订阅客户端同时订阅同一个发布资源下的音视频资源，你必须为这些订阅客户端分别创建各自的订阅资源。

请求说明

请求方式：POST
请求地址：https://wtn.volcvideo.com/sub/<AppID>/<StreamID>

请求参数

Path

参数	类型	是否必选	示例值	描述
AppID	String	是	`Your_AppId`	应用 ID。在 WTN 控制台上获取。
StreamID	String	是	`Stream123`	流 ID。和创建发布资源时设置的值一致。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/sdp`	请求内容类型。固定值：`application/sdp`
Authorization	String	是	`{TokenType} {Token}`	当开启了订阅鉴权时，必须传入此参数；未开启订阅鉴权时，不传入此参数。 `TokenType`：固定值： `Bearer`。 `Token`：参见鉴权规则。

Query

参数	类型	是否必选	示例值	描述
SessionID	String	否	`Session123`	客户端生成的 ID，用于日志排查。
MuteAudio	Bool	否	`false`	是否订阅音频数据。 `true` ：不订阅音频数据； `false` ：订阅音频数据。默认值为 `false` 。
MuteVideo	Bool	否	`false`	是否订阅视频数据。 `true` ：不订阅视频数据； `false` ：订阅视频数据。默认值为 `false` 。
ClientIP	String	否	`123.112.69.85`	客户端的公网 IP 地址（IPV4 或 IPV6）。WTN 服务端会根据它为客户端分配最佳媒体服务器节点。默认值为发起 HTTP 请求的 IP。
RID	String	否	`High`	使用 WebRTC 协议发布的 Simulcast 媒体流的 RTP Stream ID。你可以通过此参数选择订阅多个 Simulcast 媒体流中的指定流。如果不填，那么默认订阅最高档位的 Simulcast 媒体流。如果发布端 RID 有变动，原来的订阅者会断开，需要重新订阅才能收到新发布的流；如果发布端发布新的媒体流，使用了相同的 RID，那么，原来的订阅者不会断开，无需重新订阅就能收到新发布的流。

Body

参数	类型	是否必选	示例值	描述
data-raw	String	是	`<SDP Offer>`	向服务端发送 SDP Offer

响应结果

成功响应示例

参数		类型	示例值	描述
Status		String	`201 Created`	接口请求成功
Header	Content-Type	String	`application/sdp`	返回内容的类型
Header	Location	String	`https://xxxx.com`	订阅资源 url
Body		String	`<SDP Answer>`	收到服务端的 SDP Answer

异常响应示例

参数		类型	示例值	描述
Status		String	`400 Unknown Request`	未知请求异常
Header	Content-Type	String	`text/plain`	返回内容的类型
Body		String	`Resource Not Exist`	资源不存在

请求示例

curl --location --request POST 'https://wtn.volcvideo.com/sub/<AppID>/<StreamID>' \
--header 'Authorization: Bearer <Token>' \
--header 'Content-Type: application/sdp' \
--data-raw '<SDP Offer>'

返回示例

<SDP Answer>

状态码

您可访问状态码，获取更多状态码信息。

WebRTC 传输网络