在输入在线媒体流后,你可以使用 StopRelayStream 停止推送在线媒体流。

接口行为

你可以调用 StopRelayStream 接口,停止推送在线媒体流。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。

接口限制

QPS 不得超过 150。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
ActionString是StopRelayStream接口名称,本接口取值:StopRelayStream
VersionString是 2020-12-01接口版本,本接口取值: 2020-12-01
Body
参数名类型必填描述
AppIdString是你的音视频应用的唯一标志
RoomIdString是房间的 ID,是房间的唯一标志
TaskIdString是任务 ID。你必须对每个任务设定 TaskId,且在进行结束任务时也须使用该 TaskId。关于 TaskId 的详细说明,参看TaskId说明 。 关于 TaskId 及以上 Id 字段的命名规则,参看 ID。
TaskId 说明:

TaskId 是任务的标识,在一个 AppId 的 RoomId 下 taskID 是唯一的,不同 AppId 或者不同 RoomId 下 TaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。

请求示例代码
Query
https://rtc.volcengineapi.com?Action=StopRelayStream&Version=2020-12-01
postscript
Body:
{
    "AppId" : "Your_AppId",
    "RoomId" : "Your_RoomId",
    "TaskId" : "Your_TaskId"
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"success",失败时为空。

正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopRelayStream",
        "Version": " 2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result":{
        "Message": "success"
    }
}
json