文档中心

设置订阅能力

最近更新时间：2024.05.16 14:24:26

首次发布时间：2023.01.12 19:52:41

调用此接口设置订阅状态，包括：

注意事项

调用此接口前，你必须已创建对应的订阅资源，并且此资源未被销毁。

关于创建订阅资源，参看创建订阅资源。
关于订阅资源的生命周期，参看发布资源和订阅资源。

订阅资源 URL ：在成功创建订阅资源时，从响应中获取的 Location 。

参数	类型	是否必选	示例值	描述
MuteAudio	Bool	否	`false`	是否订阅音频数据。 `true` ：不订阅音频数据； `false` ：订阅音频数据。默认值为 `false` 。
MuteVideo	Bool	否	`false`	是否订阅视频数据。 `true` ：不订阅视频数据； `false` ：订阅视频数据。默认值为 `false` 。
RID	String	否	`High`	使用 WebRTC 协议发布的 Simulcast 媒体流的 RTP Stream ID。你可以通过此参数选择订阅多个 Simulcast 媒体流中的指定流。如果不填，那么默认订阅最高档位的 Simulcast 媒体流。如果发布端 RID 有变动，原来的订阅者会断开，需要重新订阅才能收到新发布的流；如果发布端发布新的媒体流，使用了相同的 RID，那么，原来的订阅者不会断开，无需重新订阅就能收到新发布的流。

参数	类型	示例值	描述
Status	String	`200 OK`	接口请求成功

curl --location --request POST '<location>' --data-raw '{"MuteAudio":true,"MuteVideo":true,"RID":"High"}'

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

注意事项

前提条件

请求说明

请求参数

Body

响应结果

成功响应示例

异常响应示例

请求示例

状态码