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

Creates an online editing project. You can specify configurations such as the title, description, timeline, and thumbnail for the project.

Operation description

Billing is based on the duration of the edited video,For more informationPlease referSeeVideoEditing .If processing fails,No charge.
After creating the editing project,You canCallSubmitMediaProducingJob - SubmitEditingCompositing jobAPISubmit mediaEditingSynthesisTask.CallSubmitLiveEditingJob - Submit liveEditingTaskSubmit liveEditingTask.

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 online editing project.	example
Description	string	No	The description of the online editing project.	Description
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.	See template usage documentation
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: a regular template. VETemplate: an advanced template. Valid values: Timeline : VETemplate :	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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
Project	object	The information about the online editing project.
ProjectId	string	The ID of the online editing project.	**01bf24bf41c78b2754cb3187**
Title	string	The title of the online editing project.	example_title
Description	string	The description of the online editing project.	example_description
Timeline	string	The timeline of the online editing project, in the JSON format. If you leave this parameter empty, an empty timeline is created and the duration of the online editing project is zero.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
TemplateId	string	The template ID.	**96e8864746a0b6f3**
ClipsParam	string	The template material parameters.	See template usage documentation
CoverURL	string	The thumbnail URL of the online editing project.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
Status	integer	The status of the online editing project. Valid values: - 1: Draft - 2: Editing - 3: Producing - 4: Produced - 5: ProduceFailed - 7: Deleted	2
StatusName	string	The status of the online editing project. For more information, see the status list.	Editing
CreateTime	string	The time when the online editing project was created.	2021-01-08T16:52:07Z
ModifiedTime	string	The time when the online editing project was last edited.	2021-01-08T16:52:07Z
Duration	number	The duration of the online editing project.	3.4200000
CreateSource	string	The method for creating the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	WebSDK
ModifiedSource	string	The method for editing the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	WebSDK
TemplateType	string	The template type of the online editing project. Valid values: - Timeline - VETemplate	Timeline
BusinessConfig	string	The business configuration of the project. This parameter can be ignored for general 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. Valid values: - EditingProject: a regular editing project. - LiveEditingProject: a live stream editing project.	LiveEditingProject
BusinessStatus	string	The business status of the project. This parameter can be ignored for general editing projects. Valid values: Reserving ReservationCanceled BroadCasting LoadingFailed LiveFinished	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 template usage documentation",
    "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.