Creates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:CreateEditingProject | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Title | string | Yes | The title of the online editing project. | example |
| Description | string | No | The description of the online editing project. | |
| Timeline | string | No | The timeline of the online editing project, in the JSON format. | {"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]} |
| CoverURL | string | No | The thumbnail URL of the online editing project. | https://example.com/example.png |
| TemplateId | string | No | The template ID. This parameter is used to quickly build a timeline with ease. Note: Only one of Timeline and TemplateId can be specified. If TemplateId is specified, ClipsParam must also be specified. | ****96e8864746a0b6f3**** |
| ClipsParam | string | No | The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information. | |
| TemplateType | string | No | The template type. This parameter is required if you create a template-based online editing project. Default value: Timeline. Valid values:
| Timeline |
| MaterialMaps | string | No | The material associated with the project. Separate multiple material IDs with commas (,). Each type supports up to 10 material IDs. | {"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 | No | The business configuration of the project. This parameter can be ignored for general editing projects. For a live stream editing project, observe the following rules: OutputMediaConfig.StorageLocation is required. OutputMediaConfig.Path is optional. If you do not specify this option, the live streaming clips are stored in the root directory by default. Valid values of OutputMediaTarget include vod-media and oss-object. If you do not specify OutputMediaTarget, the default value oss-object is used. If you set OutputMediaTarget to vod-media, the setting of OutputMediaConfig.Path does not take effect. | { "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" } |
| ProjectType | string | No | The type of the editing project. Valid values: EditingProject and LiveEditingProject. A value of EditingProject indicates a regular editing project, and a value of LiveEditingProject indicates a live stream editing project. | LiveEditingProject |
Response parameters
Examples
Sample success responses
JSONformat
{
"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"
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-11-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-03-14 | The request parameters of the API has changed | View Change Details |