文档

CreateEditingProject - 创建云剪辑工程

更新时间:

创建云剪辑工程,支持设置标题、描述、时间线和工程封面等。

调试

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

授权信息

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

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

请求参数

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

云剪辑工程标题

example
Descriptionstring

云剪辑工程描述

描述
Timelinestring

云剪辑工程时间线,Json 格式

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}
CoverURLstring

云剪辑工程封面。

https://example.com/example.png
TemplateIdstring

模板 Id,用于快速低门槛的构建时间线。注:Timeline、TemplateId 有且只有一个非空。当 TemplateId 不为空时,ClipsParam 不能为空。

****96e8864746a0b6f3****
ClipsParamstring

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

见模板使用文档
TemplateTypestring

模板类型,创建基于模板的云剪辑工程需要填写,默认值:Timeline。 取值范围:

  • Timeline 普通模板
  • VETemplate 高级模板
Timeline
MaterialMapsstring

工程关联素材,多个素材以逗号(,)分隔;每种类型最多支持 10 个素材 ID.

{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\"appName\":\"testrecord\",\"domainName\":\"test.alivecdn.com\",\"liveUrl\":\"rtmp://test.alivecdn.com/testrecord/teststream\",\"streamName\":\"teststream\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}
BusinessConfigstring

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

如果是直播剪辑工程 OutputMediaConfig.StorageLocation 必填, OutputMediaConfig.Path 不填默认合成的直播片段存储在根路径下

OutputMediaTarget 可选填 vod-media/oss-object, 不填默认 oss-object

OutputMediaTarget 为 vod-media 时,Path 不生效。

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

剪辑工程类型,EditingProject: 普通剪辑工程;LiveEditingProject: 直播剪辑工程

LiveEditingProject

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

******3B-0E1A-586A-AC29-742247******
Projectobject

云剪辑工程

ProjectIdstring

云剪辑工程 ID

****01bf24bf41c78b2754cb3187****
Titlestring

云剪辑工程标题

example_title
Descriptionstring

工程描述

example_description
Timelinestring

云剪辑工程时间线,Json 格式。具体结构定义参见配置 TimeLine 说明。当该字段为空时,则创建一个空的时间线,且云剪辑工程的总时长为 0。

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}
TemplateIdstring

模板 Id

****96e8864746a0b6f3****
ClipsParamstring

模板素材参数

见模板使用文档
CoverURLstring

云剪辑工程封面

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>
Statuslong

云剪辑工程状态。

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

-1:Draft

-2:Editing

-3:Producing

-4:Produced

-5:ProduceFailed

-7:Deleted

2
StatusNamestring

云剪辑状态名称,对应状态列表中状态名称。

Editing
CreateTimestring

云剪辑工程创建时间

2021-01-08T16:52:07Z
ModifiedTimestring

云剪辑工程编辑时间

2021-01-08T16:52:07Z
Durationfloat

云剪辑工程时长

3.4200000
CreateSourcestring

云剪辑工程创建方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

WebSDK
ModifiedSourcestring

云剪辑工程编辑方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

WebSDK
TemplateTypestring

云剪辑工程模版类型

-Timeline

-VETemplate

Timeline
BusinessConfigstring

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

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

剪辑工程类型,默认 EditingProject

- EditingProject: 普通剪辑工程

- LiveEditingProject: 直播剪辑工程

LiveEditingProject
BusinessStatusstring

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

  • 预约中:Reserving
  • 预约取消:ReservationCanceled
  • 直播中:BroadCasting
  • 加载失败:LoadingFailed
  • 直播结束:LiveFinished
Reserving

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Project": {
    "ProjectId": "****01bf24bf41c78b2754cb3187****",
    "Title": "example_title",
    "Description": "example_description",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "见模板使用文档",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
    "Status": 2,
    "StatusName": "Editing",
    "CreateTime": "2021-01-08T16:52:07Z",
    "ModifiedTime": "2021-01-08T16:52:07Z",
    "Duration": 3.42,
    "CreateSource": "WebSDK",
    "ModifiedSource": "WebSDK",
    "TemplateType": "Timeline",
    "BusinessConfig": "{ \"OutputMediaConfig\" :    { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\"   }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
    "ProjectType": "LiveEditingProject",
    "BusinessStatus": "Reserving"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-23API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-03-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:TemplateType
  • 本页导读 (1)