如果你已经启用音频切片,你可以使用 UpdateSegment 更新已启用的切片任务的参数。
你可以调用 UpdateSegment 接口,覆盖此前在 StartSegment 或 UpdateSegment 中设定的以下参数:
IdentifierHandleDuration在使用 UpdateSegment 前,你必须已经使用 StartSegment 开启切片任务。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
QPS 不得超过 150。
使用 Post 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateSegment | 接口名称,本接口取值:UpdateSegment |
| Version | String | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
| BusinessId | String | 否 | Your_BusinessId | 业务标识 |
| RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
| TaskId | String | 是 | Your_TaskId | 切片任务 ID。你必须对每个切片任务,设定 TaskId,且在进行任务更新时也须使用该 TaskId。关于 TaskId 的详细说明,参看TaskId说明 。 关于 TaskId 及以上 Id 字段的命名规则,参看 ID。 |
| Identifier | String | 否 | Your_Identifier | 自定义文件前缀。切片名设置详情,参看切片名设置规则 |
| Handle | Bool | 否 | true | 是否在开启音视切片时,立刻开始切片。选择 True 时,开启切片;选择 False 时,不切片。默认值 true。 |
| Duration | Uint32 | 否 | 30 | 音频切片的时长。单位为秒。范围为 [1, 600],默认值为 20秒。值不合法时,自动调整为默认值。 更新该字段后,计时器会重新启动,当前切片立即停止,生成一个新切片。 |
TaskId 说明:TaskId 是任务的标识,在一个 AppId 的 RoomId 下 TaskId 是唯一的,不同 AppId 或者不同 RoomId 下 TaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。
切片名设置规则:
切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为 随机生成的 UUID。在自定义文件名时,Identifier 的命名规则参看 ID。在自定义文件名时,你需确保 identifier 命名全局唯一,否则在 TOS 平台会因文件名重复被覆盖。
http://rtc.volcengineapi.com?Action=UpdateSegment&Version=2020-12-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
}
json返回值 Result 仅在请求成功时返回"ok",失败时为空。
{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "StopSegment",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
json