实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考音频切片更新音频切片 UpdateSegment
复制全文
下载 pdf更新音频切片 UpdateSegment
文档反馈
问问助手调用 UpdateSegment 接口，更新正在进行的音频切片任务的配置，如切片时长、是否立即开始切片等。
注意事项
请求频率：QPS 不得超过 150。
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=UpdateSegment&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：UpdateSegment
接口名称。当前 API 的名称为 UpdateSegment。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
AppId String 必选 示例值：66****3cf
BusinessId String 可选 示例值：B****3
业务标识
RoomId String 必选 示例值：Room1
目标房间 ID。
TaskId String 必选 示例值：Task1
要更新的切片任务 ID。
Identifier String 可选 示例值：Identifier1
自定义文件前缀。
切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为 随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}。
在自定义文件名时，你需确保 identifier 命名全局唯一，否则在 TOS 平台会因文件名重复被覆盖。
Handle Boolean 可选 示例值：false
是否在开启音视切片时，立刻开始切片。
- true：立刻开启切片。
- false：不切片。
默认值 true。
Duration Integer 可选 示例值：20
音频切片的时长。单位为秒。取值范围为 [1, 600]，默认值为 20。 更新该字段后，计时器会重新启动，当前切片立即停止，生成一个新切片。
返回参数
其中返回值 Result 仅在请求成功时返回 ok，失败时为空。
请求示例
POST https://rtc.volcengineapi.com?Action=UpdateSegment&Version=2023-11-01
{
"AppId": "66****3cf",
"BusinessId": "B****3",
"RoomId": "Room1",
"TaskId": "Task1",
"MaxIdleTime": 200,
"TargetStreams": {
"StreamList": [
{
"UserId": "user1"
},
{
"UserId": "user1"
}
]
},
"Duration": 20,
"Identifier": "Identifier1",
"Handle": true
}
返回示例
{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "UpdateSegment",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
错误码
最近更新时间：2026.03.13 10:26:42
这个页面对您有帮助吗？
有用
有用
无用
无用