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

更新音频切片 UpdateSegment

最近更新时间2024.01.12 17:07:37

首次发布时间2022.11.08 15:14:19

如果你已经启用音频切片,你可以使用 UpdateSegment 更新已启用的切片任务的参数。

使用说明

接口行为

你可以调用 UpdateSegment 接口,覆盖此前在 StartSegmentUpdateSegment 中设定的以下参数:

  • Identifier
  • Handle
  • Duration

在使用 UpdateSegment 前,你必须已经使用 StartSegment 开启切片任务。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:QPS 不得超过 150。

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=UpdateSegment&Version=2022-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringUpdateSegment接口名称。当前 API 的名称为 UpdateSegment
VersionString2022-06-01接口版本。当前 API 的版本为 2022-06-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间的 ID,是房间的唯一标志

TaskId

String

Your_TaskId

切片任务 ID。你必须对每个切片任务,设定 TaskId,且在进行任务更新时也须使用该 TaskId。
TaskId 是任务的标识,在一个 AppIdRoomIdtaskId 是唯一的,不同 AppId 或者不同 RoomIdTaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。
关于 TaskId 及以上 Id 字段的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}

Identifier

String

Your_Identifier

自定义文件前缀。
切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为 随机生成的 UUID。在自定义文件名时,Identifier 的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}
在自定义文件名时,你需确保 identifier 命名全局唯一,否则在 TOS 平台会因文件名重复被覆盖。

HandleBooleanfalse是否在开启音视切片时,立刻开始切片。选择 True 时,开启切片;选择 False 时,不切片。默认值 true
DurationInteger20音频切片的时长。单位为秒。范围为 [1, 600],默认值为 20秒。值不合法时,自动调整为默认值。 更新该字段后,计时器会重新启动,当前切片立即停止,生成一个新切片。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateSegment&Version=2022-06-01

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "MaxIdleTime": 200,
    "TargetStreams": {
        "StreamList": [
            {
                "UserId": "user1"
            },
            {
                "UserId": "user1"
            }
        ]
    },
    "Duration": 20,
    "Identifier": "Your_Identifier",
    "Handle": true
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateSegment",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。