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 设置来决定是否开启订阅鉴权。关于具体设置,参看 鉴权

注意事项

后续操作

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

重复发布

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

请求说明

  • 请求方式:POST

  • 请求地址:https://wtn.volcvideo.com/pub/<AppID>/<StreamID>

请求参数

Path

参数类型是否必选示例值描述
AppIDStringYour_AppId应用 ID。在 WTN 控制台上获取。
StreamIDStringStream123流 ID。自定义取值,仅支持数字+字母,最长 64 个字符。
参数类型是否必选示例值描述
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 会根据它为业务服务器配置最佳网络资源。

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/pub/<AppID>/<StreamID>' \
--header 'Authorization: Bearer <Token>' \
--header 'Content-Type: application/sdp' \
--data-raw '<SDP Offer>'

返回示例

<SDP Answer>

状态码

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