本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。
在实时音视频通话场景中，若需调整音频切片任务的配置，你可通过调用此接口实现。
你可以调用 UpdateSegment 接口，覆盖此前在 StartSegment 或 UpdateSegment 中设定的以下参数：
IdentifierHandleDuration请求频率：QPS 不得超过 150。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | UpdateSegment | 接口名称。当前 API 的名称为 UpdateSegment。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AppId | String | 是 | 661e****543cf | 你的音视频应用的唯一标志，参看获取 AppId。 |
BusinessId | String | 否 | B****23 | 业务标识 |
RoomId | String | 是 | Room1 | 房间的 ID，是房间的唯一标志 |
TaskId | String | 是 | Task1 | 切片任务 ID。你必须对每个切片任务，设定 TaskId，且在进行任务更新时也须使用该 TaskId。
[a-zA-Z0-9_@\-\.]{1,128} |
Identifier | String | 否 | Identifier1 | 自定义文件前缀。 切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为 随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}。在自定义文件名时，你需确保 identifier 命名全局唯一，否则在 TOS 平台会因文件名重复被覆盖。 |
Handle | Boolean | 否 | false | 是否在开启音视切片时，立刻开始切片。
true。 |
Duration | Integer | 否 | 20 | 音频切片的时长。单位为秒。取值范围为 [1, 600]，默认值为 20。 更新该字段后，计时器会重新启动，当前切片立即停止，生成一个新切片。 |
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。
POST https://rtc.volcengineapi.com?Action=UpdateSegment&Version=2023-11-01 { "AppId": "661e****543cf", "BusinessId": "B****23", "RoomId": "Room1", "TaskId": "Task1", "MaxIdleTime": 200, "TargetStreams": { "StreamList": [ { "UserId": "user1" }, { "UserId": "user1" } ] }, "Duration": 20, "Identifier": "Identifier1", "Handle": true }
{ "Result": "ok", "ResponseMetadata": { "RequestId": "20230****10420", "Action": "UpdateSegment", "Version": "2023-11-01", "Service": "rtc", "Region": "cn-north-1" } }
您可访问公共错误码，获取更多错误码信息。