调用CreateEditingProject 接口,可以创建云剪辑工程。支持设置标题、描述、时间线和工程封面等。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateEditingProject

系统规定参数。取值:CreateEditingProject

Title String example

云剪辑工程标题

Description String 描述

云剪辑工程描述

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

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

CoverURL String https://example.com/example.png

云剪辑工程封面。如果为空且时间线上的video轨已经存在素材,则默认选取时间线上第一个素材封面。

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

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

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

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

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

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

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

ProjectType String LiveEditingProject

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

返回数据

名称 类型 示例值 描述
RequestId String ******3B-0E1A-586A-AC29-742247******

Id of the request

Project Object

云剪辑工程

ProjectId String ****01bf24bf41c78b2754cb3187****

云剪辑工程ID

Title String example_title

云剪辑工程标题

Description String example_description

工程描述

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

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

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

云剪辑工程封面

Status Long 2

云剪辑工程状态。

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

-1:Draft

-2:Editing

-3:Producing

-4:Produced

-5:ProduceFailed

-7:Deleted

StatusName String Editing

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

CreateTime String 2021-01-08T16:52:07Z

云剪辑工程创建时间

ModifiedTime String 2021-01-08T16:52:07Z

云剪辑工程编辑时间

Duration Float 3.4200000

云剪辑工程时长

CreateSource String WebSDK

云剪辑工程创建方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

ModifiedSource String WebSDK

云剪辑工程编辑方式

-OpenAPI

-AliyunConsole

-WebSDK

-LiveEditingOpenAPI

-LiveEditingConsole

TemplateType String Timeline

云剪辑工程模版类型

-Timeline

-VETemplate

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

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

ProjectType String LiveEditingProject

剪辑工程类型,默认EditingProject

- EditingProject: 普通剪辑工程

- LiveEditingProject: 直播剪辑工程

BusinessStatus String Reserving

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateEditingProject
&Title=example
&Description=描述
&Timeline={"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}
&CoverURL=https://example.com/example.png
&ProjectType=EditingProject
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateEditingProjectResponse>
    <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>
    <Project>
        <ProjectId>****01bf24bf41c78b2754cb3187****</ProjectId>
        <Title>example_title</Title>
        <Description>example_description</Description>
        <Timeline>{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}</Timeline>
        <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&lt;ExpireTime&gt;&amp;OSSAccessKeyId=&lt;OSSAccessKeyId&gt;&amp;Signature=&lt;Signature&gt;&amp;security-token=&lt;SecurityToken&gt;</CoverURL>
        <Status>2</Status>
        <StatusName>Editing</StatusName>
        <CreateTime>2021-01-08T16:52:07Z</CreateTime>
        <ModifiedTime>2021-01-08T16:52:07Z</ModifiedTime>
        <Duration>3.42</Duration>
        <CreateSource>WebSDK</CreateSource>
        <ModifiedSource>WebSDK</ModifiedSource>
        <TemplateType>Timeline</TemplateType>
    </Project>
</CreateEditingProjectResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "******3B-0E1A-586A-AC29-742247******",
  "Project" : {
    "ProjectId" : "****01bf24bf41c78b2754cb3187****",
    "Title" : "example_title",
    "Description" : "example_description",
    "Timeline" : "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
    "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"
  }
}

错误码

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

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