创建发布资源--WebRTC 传输网络-火山引擎

文档中心

立即注册

导航

创建发布资源

最近更新时间：2024.09.23 11:44:47首次发布时间：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

参数	类型	是否必选	示例值	描述
AppID	String	是	`Your_AppId`	应用 ID。在 WTN 控制台上获取。
StreamID	String	是	`Stream123`	流 ID。自定义取值，仅支持数字+字母，最长 64 个字符。

参数	类型	是否必选	示例值	描述
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。

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

返回示例

<SDP Answer>

状态码

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

WebRTC 传输网络