创建云剪辑工程,支持设置标题、描述、时间线和工程封面等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Title | string | 是 | 云剪辑工程标题 | example |
Description | string | 否 | 云剪辑工程描述 | 描述 |
Timeline | string | 否 | 云剪辑工程时间线,Json格式 | {"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]} |
CoverURL | string | 否 | 云剪辑工程封面。如果为空且时间线上的video轨已经存在素材,则默认选取时间线上第一个素材封面。 | https://example.com/example.png |
TemplateId | string | 否 | 模板Id,用于快速低门槛的构建时间线。注:ProjectId、Timeline、TemplateId有且只有一个非空。当TemplateId不为空时,ClipsParam不能为空。 | ****96e8864746a0b6f3**** |
ClipsParam | string | 否 | 见模板使用文档 | |
TemplateType | string | 否 | 模板类型,创建基于模板的云剪辑工程需要填写,默认值:Timeline。 取值范围:
| Timeline |
MaterialMaps | string | 否 | 工程关联素材,多个素材以逗号(,)分隔;每种类型最多支持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*****"} |
BusinessConfig | string | 否 | 工程业务配置。一般剪辑工程可忽略。 如果是直播剪辑工程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" } |
ProjectType | string | 否 | 剪辑工程类型,EditingProject: 普通剪辑工程;LiveEditingProject: 直播剪辑工程 | LiveEditingProject |
返回参数
示例
正常返回示例
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"
}
}
错误码
访问错误中心查看更多错误码。