Create an online editing project using CreateEditingProject - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Creates a cloud editing project. You can set the title, description, timeline, and project cover.

Operation description

Billing is based on the duration of the output video produced by editing and compositing. For details, see Video clip. No fees are charged if the processing is failed.
After you create an editing project, you can invoke SubmitMediaProducingJob - Submit a media editing and compositing node to commit a media editing and compositing node. Invoke SubmitLiveEditingJob - Submit a live editing node to commit a live editing node.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateEditingProject

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Title	string	Yes	The title of the cloud editing project.	example
Description	string	No	The description of the cloud editing project.	Description
Timeline	string	No	The timeline of the cloud editing project in JSON format.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
CoverURL	string	No	The cover URL of the cloud editing project.	https://example.com/example.png
TemplateId	string	No	The template ID, which is used to quickly build a timeline with minimal effort. Important Either Timeline or TemplateId must be specified, but not both. If TemplateId is specified, ClipsParam must also be specified.	**96e8864746a0b6f3**
ClipsParam	string	No	The material parameters corresponding to the template in JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information about the format, see Create and use a standard template and Create and use an advanced template.	See the template user guide.
TemplateType	string	No	The templatetype. Specify this parameter when you create a template-based cloud editing project. Default value: Timeline. Valid values: Timeline: standard template. VETemplate: advanced template. Valid values: Timeline : Standard template. VETemplate : Advanced template.	Timeline
MaterialMaps	string	No	The materials associated with the project. Separate multiple materials with commas (,). A maximum of 10 material IDs are supported for each type.	{"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 standard editing projects. For live editing projects, OutputMediaConfig.StorageLocation is required. If OutputMediaConfig.Path is not specified, the produced live clips are stored in the root path by default. OutputMediaTarget can be set to vod-media or oss-object. Default value: oss-object. When OutputMediaTarget is set to vod-media, 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. EditingProject: standard editing project. LiveEditingProject: live editing project.	LiveEditingProject

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	****3B-0E1A-586A-AC29-742247****
Project	object	The cloud editing project.
ProjectId	string	The ID of the cloud editing project.	**01bf24bf41c78b2754cb3187**
Title	string	The title of the cloud editing project.	example_title
Description	string	The description of the project.	example_description
Timeline	string	The timeline of the cloud editing project in JSON format. For more information about the structure, see TimeLine. If this field is empty, an empty timeline is created and the total duration of the cloud editing project is 0.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
TemplateId	string	The template ID.	**96e8864746a0b6f3**
ClipsParam	string	The template material parameters.	See the template user guide.
CoverURL	string	The cover URL of the cloud editing project.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
Status	integer	The status of the cloud editing project. Valid values: 1: Draft. 2: Editing. 3: Producing. 4: Produced. 5: ProduceFailed. 7: Deleted.	2
StatusName	string	The status name of the cloud editing project, corresponding to the status name in the status list.	Editing
CreateTime	string	The creation time of the cloud editing project.	2021-01-08T16:52:07Z
ModifiedTime	string	The modification time of the cloud editing project.	2021-01-08T16:52:07Z
Duration	number	The duration of the cloud editing project.	3.4200000
CreateSource	string	The creation source of the cloud editing project. OpenAPI AliyunConsole WebSDK LiveEditingOpenAPI LiveEditingConsole	WebSDK
ModifiedSource	string	The modification source of the cloud editing project. OpenAPI AliyunConsole WebSDK LiveEditingOpenAPI LiveEditingConsole	WebSDK
TemplateType	string	The template type of the cloud editing project. Timeline VETemplate	Timeline
BusinessConfig	string	The business configuration of the project. This parameter can be ignored for standard editing projects.	{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
ProjectType	string	The type of the editing project. Default value: EditingProject. EditingProject: standard editing project. LiveEditingProject: live editing project.	LiveEditingProject
BusinessStatus	string	The business status of the project. This parameter can be ignored for standard editing projects. Reserving: The live stream is being reserved. ReservationCanceled: The reservation is canceled. BroadCasting: The live stream is broadcasting. LoadingFailed: Loading failed. LiveFinished: The live stream has ended.	Reserving

Examples

Success response

JSON format

{
  "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": "See the template user guide.",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.