文档

GetLiveEditingJob - 查询直播剪辑作业

更新时间:

获取剪辑合成作业的详细信息,具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。 本接口仅支持查询近一年的直播剪辑任务数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JobIdstring

直播剪辑 Jobld

****d80e4e4044975745c14b****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

****36-3C1E-4417-BDB2-1E034F****
LiveEditingJobobject

直播剪辑任务

JobIdstring

直播剪辑任务 ID

****cdb3e74639973036bc84****
ProjectIdstring

直播剪辑工程 ID

****fddd7748b58bf1d47e95****
Statusstring

直播剪辑作业状态,取值可能为如下值: -Init (初始状态) -Queuing(排队中) -Processing(处理中) -Success(成功) -Failed(失败)

Success
Clipsstring

剪辑片段列表

[{\"StartTime\": \" 2021-06-21T08:01:00Z\", \"EndTime\": \" 2021-06-21T08:03:00Z\" }]
UserDatastring

用户数据

{"key": "value'}
CreationTimestring

直播剪辑作业创建时间,格式为 utc 时间。

2020-12-23T13:33:40Z
ModifiedTimestring

直播剪辑作业修改时间,格式为 utc 时间。

2020-12-23T13:33:49Z
CompleteTimestring

直播剪辑作业完成时间,格式为 utc 时间。

2020-12-23T13:33:52Z
MediaIdstring

输出成品的资源 Id

****0cc6ba49eab379332c5b****
MediaURLstring

输出成品的资源文件 URL

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4
Codestring

剪辑合成作业错误码 注:作业失败时关注该字段

InvalidParameter
Messagestring

剪辑合成作业错误信息 注:作业失败时关注该字段

The specific parameter LiveStreamConfig is not valid.
LiveStreamConfigobject

直播剪辑配置

AppNamestring

播流所属应用名称

app
DomainNamestring

播流所属域名

domain.com
StreamNamestring

播流所属流名

streamName
MediaProduceConfigobject

直播剪辑合成配置

Modestring

剪辑模式,默认 Accurate

Accurate
OutputMediaConfigobject

输出成片的存储配置

MediaURLstring

输出成片的文件地址

https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4
StorageLocationstring

当 OutputMediaTarget 的目标为 vod-media 时, 指定 storage location 来存储媒资到 VOD; storage location 是 VOD 中的文件存储位置, 不包含 http:// 的前缀, 如:outin-xxxxxx.oss-cn-shanghai.aliyuncs.com

outin-xxxxxx.oss-cn-shanghai.aliyuncs.com
FileNamestring

当 OutputMediaTarget 的目标为 vod-media 时,指定 fileName(包含文件后缀,不含路径)作为输出文件名

test.mp4
Widthinteger

输出成品的宽。可以不填,默认值是多个素材的最大宽

640
Heightinteger

输出成品的高。可以不填,默认值是多个素材的最大高

480
Bitratelong

输出成品的码率,单位为 Kbps。可以不填,默认值是多个素材的最高码率

1000
VodTemplateGroupIdstring

合成成片输出到 vod,指定 vod 转码模板组。如不需要 VOD 转码,请填写 "VOD_NO_TRANSCODE".

VOD_NO_TRANSCODE

示例

正常返回示例

JSON格式

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "LiveEditingJob": {
    "JobId": "****cdb3e74639973036bc84****",
    "ProjectId": "****fddd7748b58bf1d47e95****",
    "Status": "Success",
    "Clips": "[{\\\"StartTime\\\": \\\" 2021-06-21T08:01:00Z\\\",  \\\"EndTime\\\": \\\" 2021-06-21T08:03:00Z\\\" }]",
    "UserData": "{\"key\": \"value'}",
    "CreationTime": "2020-12-23T13:33:40Z",
    "ModifiedTime": "2020-12-23T13:33:49Z",
    "CompleteTime": "2020-12-23T13:33:52Z",
    "MediaId": "****0cc6ba49eab379332c5b****",
    "MediaURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
    "Code": "InvalidParameter",
    "Message": "The specific parameter LiveStreamConfig is not valid.",
    "LiveStreamConfig": {
      "AppName": "app",
      "DomainName": "domain.com",
      "StreamName": "streamName"
    },
    "MediaProduceConfig": {
      "Mode": "Accurate"
    },
    "OutputMediaConfig": {
      "MediaURL": "https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4",
      "StorageLocation": "outin-xxxxxx.oss-cn-shanghai.aliyuncs.com",
      "FileName": "test.mp4",
      "Width": 640,
      "Height": 480,
      "Bitrate": 1000,
      "VodTemplateGroupId": "VOD_NO_TRANSCODE"
    }
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈