You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/音频切片/查询音频切片任务状态 GetSegmentTask
查询音频切片任务状态 GetSegmentTask
最近更新时间：2024.07.16 15:31:22首次发布时间：2024.01.03 20:25:18
我的收藏

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需获取特定房间下音频切片任务的详细信息，你可通过调用此接口实现。

通过指定应用标识、房间 ID 以及任务 ID，你能查询到 72 小时内启动的音频切片任务的执行状态、停止原因、空闲超时设置、目标音视频流列表等参数，以及切片高级功能的配置信息等详细信息。

自动切片任务也支持查询。

注意事项

请求频率：QPS 不得超过 60。

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=GetSegmentTask&Version=2023-11-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
是
GetSegmentTask
接口名称。当前 API 的名称为 GetSegmentTask。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId
String
是
661e****543cf
你的音视频应用的唯一标志
RoomId
String
是
Room1
房间的 ID，是房间的唯一标志
TaskId
String
是
Task1
要查询的音频切片任务 ID。自动切片任务下，该字段可传入用户 UserId。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数
类型
示例值
描述
SegmentTask
Object
-
音频切片任务信息
StartTime
Long
1677477732000
任务开始时间戳，Unix 时间，单位为毫秒
EndTime
Long
0
任务结束时间戳，Unix 时间，单位为毫秒。0 表示任务未结束
Status
Long
2

任务状态。

  • 0: 未知异常状态
  • 1: 未开始
  • 2: 运行中
  • 3: 已结束
  • 4: 任务运行失败
StopReason
String
StopByAPI

任务停止的原因。

  • 返回为空：表示任务未结束
  • UnknownStopReason：未知停止原因
  • StopByAPI：用户主动调用 服务端 OpenAPI 停止
  • StartTaskFailed：任务启动失败
  • IdleTimeOut：任务超过最大空闲时间
  • UserDisconnect：自动切片任务中，切片任务对应的客户端用户主动退房。
MaxIdleTime
Integer
600
任务最大的空闲超时时间。
TargetStreams
Object
-
需要切片的音频流。
StreamList
Object[]
-
音视频流列表，由Stream组成，可以为空。为空时，表示订阅房间内所有流。在一个 StreamList 中，Stream.Index 不能重复。
Index
Integer
0
在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserId
String
user1
用户 ID，表示这个流所属的用户。
StreamType
Integer
0

流的类型。支持取值及含义如下：

  • 0：普通音视频流，
  • 1：屏幕流。
默认值为0。
Duration
Integer
40
每个音频切片的时长。
StorageConfig
Object
-
存储平台设置。其中 AK、SK 字段不返回
Type
Integer
0

存储平台类型。支持取值及含义如下：

默认值为 0。
TosConfig
Object
-
Tos 平台设置。当 Type = 0 时，需正确设置 TosConfig 的值，否则请求会报错
AccountId
String
210****990

火山引擎平台账号 ID，例如：200000000。

  • 火山引擎平台账号 ID 查看路径参看查看和管理账号信息。

  • 此账号 ID 为火山引擎主账号 ID。

  • 若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。

Region
Integer
0

不同存储平台支持的 Region 不同，具体参看 Region对照表

默认值为0。
Bucket
String
tos-vod-c****16fd9e8343
存储桶的名称。
VodConfig
Object
-
点播平台设置。当 Type = 1 时，需正确设置 VodConfig 的值，否则请求会报错
AccountId
String
210****933

火山引擎平台账号 ID，例如：200000000。

  • 火山引擎平台账号 ID 查看路径参看查看和管理账号信息。

  • 此账号 ID 为火山引擎主账号 ID。

  • 若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。

Region
Integer
0

不同存储平台支持的 Region 不同，具体参看 Region对照表

默认值为0。
Space
String
Storagespace
点播空间名称。
StorageClass
Integer
1

上传到视频点播平台时, 文件的存储类型。支持取值及含义如下：：

  • 1：标准存储。
  • 2：归档存储。
  • 3：低频存储。
默认值为 1。
关于存储类型的详细说明，参看媒资存储存储类型
AutoSetFileExtension
Boolean
false

上传到视频点播平台时, 是否需要根据文件后缀自动设置 FileExtension。关于 FileExtension 的详细说明，参看 FileExtension。

  • true：需要；
  • false：不需要。
默认值为 false。
CustomConfig
Object
-
第三方存储平台设置。当 Type = 2时，需正确设置 CustomConfig 的值，否则请求会报错
Vendor
Integer
0

第三方云存储平台。支持取值及含义如下：

  • 0：Amazon S3
  • 1：阿里云 OSS
  • 2：华为云 OBS
  • 3：腾讯云 COS
  • 4：七牛云 Kodo。
默认值为 0。
Region
Integer
0

不同存储平台支持的 Region 不同，具体参看 Region对照表

默认值为0。
Bucket
String
tos-vod-c****16fd9e8343
存储桶的名称。
AccessKey
String
AKLTMzV****NDcyNjU
第三方存储平台账号的密钥。需确保此账号对存储桶有写权限。不建议开启读权限
SecretKey
String
TVRjMl****aadf==
第三方存储平台账号的密钥
VeImageXConfig
Object
-
VeImageX 平台设置。当 Type = 3时，需正确设置 VeImageXConfig 的值，否则请求会报错
AccountId
String
210****933

火山引擎平台账号 ID，例如：200000000。

  • 火山引擎平台账号 ID 查看路径参看查看和管理账号信息。
  • 此账号 ID 为火山引擎主账号 ID。
  • 若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。
Region
Integer
0

不同存储平台支持的 Region 不同，具体参看 Region对照表

默认值为 0。
ServiceId
String
oomo****adgcs
服务 ID。
你可以在 veImageX 控制台 服务管理页面，通过创建好的图片服务中获取服务 ID。
你也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Control
Object
-
切片高级功能
Align
Boolean
false

是否开启切片对齐功能，你可以使用该功能，对齐各个用户音频切片的开始和结束时刻。

  • false：关闭音频切片对齐。在某个切片周期中，如果用户有发送音频流的行为，即生成音频切片。如果用户在切片的周期中，有部分时间未发布音频，返回的音频切片时长会小于切片周期。各个用户音频切片开始时间不一定一致。
  • true：开启音频切片对齐。在某个切片周期中，如果用户有发送音频流的行为，即生成音频切片。切片长度和切片周期相等，且各个用户音频切片开始的时间一致。如果用户在切片的周期中，有部分时间未发布音频，切片长度不变，这段时间呈现静音帧。如果用户在某个切片周期中始终没有发布音频，则不生成音频切片。
默认值为false。
Mixed
Boolean
false

是否开启合流切片功能。

  • False：只会对 TargetStreams 中指定的音频流分别切片。
  • True：除了会对 TargetStreams 中指定的音频流分别切片，还会对指定的音频流进行混音，生成合流切片，合流切片对应的用户名为 mixed。此时，任务创建后，不管是否有人上麦，会持续回调混音切片。

默认值为 false。
不同平台的回调参看：

操作 Android API iOS API Windows API
本地麦克风录制和远端所有用户混音后的音频数据回调 onMixedAudioFrame onMixedAudioFrame: onMixedAudioFrame
IgnoreSilence
Boolean
false

是否忽略静音切片。

  • true：忽略。
  • false：不忽略。
默认值为 false
RedundantDuration
Integer
2

冗余切片时长，单位为毫秒。

当前 RTC 按照传入的Duration值进行固定时长切片,可能存在敏感词被截断，未被识别的情况。此时你可以添加冗余切片，即上一段切片的末尾指定时长，来避免此情况，此时切片的时长变为RedundantDuration + Duration。
例如：当 Duration = 20，redundantDuration = 3 时，最终输出的前三个文件时长为：[0-20], [17-40], [37-60]。
Identifier
String
getsegmenttask
自定义文件前缀。
Handle
Boolean
true
是否在开启音视频切片时，立刻开始切片。

请求示例

GET https://rtc.volcengineapi.com?Action=GetSegmentTask&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&TaskId=Task1

返回示例

{
  "Result": {
    "SegmentTask": {
      "StartTime": 1677477732000,
      "EndTime": 0,
      "Status": 2,
      "StopReason": "",
      "TargetStreams": {
        "StreamList": [
          {
            "Index": 0,
            "UserId": "user0",
            "StreamType": 0
          },
          {
            "Index": 1,
            "UserId": "user1",
            "StreamType": 0
          }
        ]
      },
      "Handle": true,
      "Identifier": "getsegmenttask",
      "MaxIdleTime": 600,
      "Duration": 40,
      "Control": {
        "Align": true,
        "Mixed": true,
        "RedundantDuration": 3,
        "IgnoreSilence": true
      },
      "StorageConfig": {
        "Type": 0,
        "TosConfig": {
          "AccountId": "210****990",
          "Region": 0,
          "Bucket": "tos-vod-cn-v****d9e8343******"
        },
        "VodConfig": {
          "Region": 0
        },
        "VeImageXConfig": {
          "Region": 0
        },
        "CustomConfig": {
          "Vendor": 0,
          "Region": 0
        }
      }
    }
  },
  "ResponseMetadata": {
    "RequestId": "20230****10420",
    "Action": "GetSegmentTask",
    "Version": "2023-11-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  }
}

错误码

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