You need to enable JavaScript to run this app.
导航

创建订阅资源

最近更新时间2023.05.12 11:04:39

首次发布时间2022.08.30 14:30:09

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

接口行为

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

后续操作

创建订阅资源,并开始订阅时,注意:

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

前提条件

在 WTN 的机制下,在创建订阅资源前,你必须已成功创建对应的发布资源;否则会收到 404 的响应码。关于如何创建发布资源,参看 创建发布资源

连接订阅资源以后,并不一定能够收到音视频流。仅在发布客户端发布音视频流时,你才可以收到音视频流。

发起请求

请求参数

方法POST
接入域名https://wtn.volcvideo.com

接入点

/sub/{AppID}/{StreamID}

  • AppID:应用 ID。String 类型,在 WTN 控制台上获取,必填。
  • StreamID:流 ID。和创建发布资源时设置的值一致。

查询参数

  • SessionID:客户端生成的 ID,用于日志排查。String 类型,非必填。
  • MuteAudio:是否订阅音频数据。Bool 类型,非必填。true:不订阅音频数据;false:订阅音频数据。默认是 false
  • MuteVideo:是否订阅视频数据。Bool 类型,非必填。true:不订阅视频数据;false:订阅视频数据。默认是 false
  • ClientIP:本地的公网 IP 地址(IPV4 或 IPV6)。String 类型,非必填。你应仅在业务服务器订阅时,设置此参数。WTN 会根据此参数为业务服务器配置最佳的网络资源。

请求头

  • Content-Type:固定值:application/sdp。String 类型,必填。
  • Authorization:当开启了订阅鉴权时,必须传入此参数;未开启订阅鉴权时,不传入此参数。取值:{TokenType} {Token}。String 类型。
    • TokenType:固定值: Bearer
    • Token:参见鉴权规则。
请求体data-raw:<SDP Offer>

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

请求示例

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

响应结果

成功响应示例

参数响应示例
Status201 Created
HeaderContent-Typeapplication/sdp
Location订阅资源 url
Body<SDP Answer>

异常响应示例

参数响应示例
Status400 Unknown Request
HeaderContent-Typetext/plain
BodyResource Not Exist

关于其他的状态码,参考 状态码