文档

GetEditingProject - 获取单个云剪辑工程

更新时间:

查询单个云剪辑工程的信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetEditingProject
  • 全部资源
    *

请求参数

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

云剪辑工程 ID

****fb2101bf24b2754cb318787dc****
RequestSourcestring

请求来源标识

-OpenAPI:默认,不会做 timeline 转换操作。

-WebSDK:若传入该字段,则会自动将工程 timeline 转换为前端风格,并将 timleine 中关联素材和工程绑定,供前端 websdk 预览。

WebSDK

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

****63E8B7C7-4812-46AD-0FA56029AC86****
Projectobject

云剪辑工程。

ProjectIdstring

云剪辑工程 ID。

****fb2101bf24b2754cb318787dc****
Titlestring

云剪辑工程标题。

样本title
Timelinestring

云剪辑工程时间线。

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]}
TemplateIdstring

模板 ID

****96e8864746a0b6f3****
ClipsParamstring

模板对应的素材参数,Json 格式,当 TemplateId 不为空时,ClipsParam 不能为空。具体格式见 普通模板创建及使用高级模板创建及使用

见模板使用文档
Descriptionstring

云剪辑工程描述。

示例描述
CoverURLstring

云剪辑工程封面。

oss://example-bucket/example.jpg
CreateTimestring

云剪辑工程创建时间。

2020-12-20T12:00:00Z
ModifiedTimestring

云剪辑工程最新修改时间。

2020-12-20T13:00:00Z
Durationlong

云剪辑工程总时长。

24.120000
Statusstring

云剪辑工程状态。 所有云剪辑工程状态列表:

-Draft

-Editing

-Producing

-Produced

-ProduceFailed

-Deleted

Editing
CreateSourcestring

云剪辑工程创建方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

OpenAPI
TemplateTypestring

云剪辑工程模版类型

-Timeline

-VETemplate

Timeline
ModifiedSourcestring

云剪辑工程编辑方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

OpenAPI
ProjectTypestring

剪辑工程类型,默认 EditingProject

- EditingProject: 普通剪辑工程

- LiveEditingProject: 直播剪辑工程

EditingProject
BusinessConfigstring

工程业务配置,一般剪辑工程可忽略。

{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
BusinessStatusstring

工程业务状态,一般剪辑工程可忽略

预约中:Reserving

预约取消:ReservationCanceled

直播中:BroadCasting

加载失败:LoadingFailed

直播结束:LiveFinished

Reserving
TimelineConvertStatusstring

工程转换状态,api 风格 timeline 转换为前端风格 timeline 是一个异步过程,只有在设置 RequestSource:WebSDK 时生效。

-Unconverted:未进行 Timeline 转换

-Converting:工程正在转换中

-Converted:工程转换完成

-ConvertFailed:工程转换失败

Converted
TimelineConvertErrorMessagestring

工程转换失败信息,只有 TimelineConvertStatus 为 ConvertFailed 时返回,工程转换的详细失败信息。

The StorageLocation must be in the same division(apiRegion) as ICE service access point.

示例

正常返回示例

JSON格式

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Project": {
    "ProjectId": "****fb2101bf24b2754cb318787dc****",
    "Title": "样本title",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "见模板使用文档",
    "Description": "示例描述",
    "CoverURL": "oss://example-bucket/example.jpg",
    "CreateTime": "2020-12-20T12:00:00Z",
    "ModifiedTime": "2020-12-20T13:00:00Z",
    "Duration": 24.12,
    "Status": "Editing",
    "CreateSource": "OpenAPI",
    "TemplateType": "Timeline",
    "ModifiedSource": "OpenAPI",
    "ProjectType": "EditingProject",
    "BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
    "BusinessStatus": "Reserving",
    "TimelineConvertStatus": "Converted",
    "TimelineConvertErrorMessage": "The StorageLocation must be in the same division(apiRegion) as ICE service access point."
  }
}

错误码

HTTP status code错误码错误信息
400InvalidParameterThe specified parameter \ is not valid.

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

  • 本页导读 (1)