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

创建发布资源

最近更新时间2023.12.11 20:01:37

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

在将本地音视频流发布到 WTN 之前,你应创建发布资源。
关于发布资源,参看 发布资源与订阅资源

接口行为

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

后续操作

创建发布资源,并开始发布时,注意:

  • 如果创建发布资源后 30 秒未开始发布,发布资源会被删除,你必须重新创建发布资源;
  • 如果已开始发布,但因网络异常等原因断开与发布资源的连接,并超过 30 秒未重新开始发布,发布资源会被删除。

关于重复发布

如果创建发布资源前,具有相同的 AppID 和 StreamID 的发布资源已创建,此前的发布资源将被清理,客户端无法与此前的发布资源建立连接,并且已建立的连接将会断开。

发起请求

请求参数

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

接入点

/pub/{AppID}/{StreamID}

  • AppID:应用 ID。String 类型,在 WTN 控制台上获取,必填。
  • StreamID:流 ID。String 类型。自定义取值,仅支持数字、字母、下划线、减号,最长 64 个字符,必填。

查询参数

  • 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/pub/<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

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