You need to enable JavaScript to run this app.
导航
创建订阅资源
最近更新时间:2024.05.16 14:24:26首次发布时间: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

参数类型是否必选示例值描述
AppIDStringYour_AppId应用 ID。在 WTN 控制台上获取。
StreamIDStringStream123流 ID。和创建发布资源时设置的值一致。
参数类型是否必选示例值描述
Content-TypeStringapplication/sdp请求内容类型。固定值:application/sdp
AuthorizationString{TokenType} {Token}当开启了订阅鉴权时,必须传入此参数;未开启订阅鉴权时,不传入此参数。
  • TokenType:固定值: Bearer
  • Token:参见鉴权规则

Query

参数类型是否必选示例值描述
SessionIDStringSession123客户端生成的 ID,用于日志排查。
MuteAudioBoolfalse是否订阅音频数据。
  • true :不订阅音频数据;
  • false :订阅音频数据。
默认值为 false
MuteVideoBoolfalse是否订阅视频数据。
  • true :不订阅视频数据;
  • false :订阅视频数据。
默认值为 false
ClientIPString123.112.69.85本地的公网 IP 地址(IPV4 或 IPV6)。
只有在订阅业务服务器时才需要设置此参数,WTN 会根据它为业务服务器配置最佳网络资源。
RIDStringHigh使用 WebRTC 协议发布的 Simulcast 媒体流的 RTP Stream ID。
你可以通过此参数选择订阅多个 Simulcast 媒体流中的指定流。如果不填,那么默认订阅最高档位的 Simulcast 媒体流。
  • 如果发布端 RID 有变动,原来的订阅者会断开,需要重新订阅才能收到新发布的流;
  • 如果发布端发布新的媒体流,使用了相同的 RID,那么,原来的订阅者不会断开,无需重新订阅就能收到新发布的流。

Body

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

响应结果

成功响应示例

参数类型示例值描述
StatusString201 Created接口请求成功
HeaderContent-TypeStringapplication/sdp返回内容的类型
LocationStringhttps://xxxx.com订阅资源 url
BodyString<SDP Answer>收到服务端的 SDP Answer

异常响应示例

参数类型示例值描述
StatusString400 Unknown Request未知请求异常
HeaderContent-TypeStringtext/plain返回内容的类型
BodyStringResource 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>

状态码

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