文档

ProduceEditingProjectVideo - 视频合成

将一个或多个视频合成为成品。可以通过时间线参数直接提交源视频,也可以先创建云剪辑工程,再提交合成。

接口说明

  • 请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。云剪辑为付费功能,计费详情,请参见剪辑合成计费

  • 该接口返回合成任务的提交结果,不保证接口返回时视频已合成完毕。合成任务将进入后台排队,异步执行。

  • 云剪辑时间线所使用的视频资源,既可以是素材管理中的素材,也可以是媒体库中的视频。

  • 合成视频依据 ProjectId 与 Timeline 进行,具体逻辑如下:

    • ProjectId 与 Timeline 不能同时为空,否则合成视频没有任何依据。
    • 如果 ProjectId 为空,Timeline 不为空,则自动创建一个云剪辑工程,以 Timeline 为时间线,同时提取 Timeline 中引用的素材并设置为云剪辑工程的素材,之后进行视频合成。
    • 如果 ProjectId 不为空,Timeline 为空,则根据 ProjectId 获取最新保存的 Timeline,并以此进行视频合成。
    • 如果 ProjectId 与 Timeline 均不为空,则以传入的 Timeline 为准,进行视频合成,同时更新对应的云剪辑工程(Timeline 和云剪辑工程素材)。如果填写其他字段,则对相应的云剪辑工程字段进行更新。
  • 视频合成完成后,会自动上传到视频点播中,因此,视频合成完成之后,点播服务会发送媒体合成完成视频上传完成的事件通知。合成视频转码完成后,会发送视频单个清晰度转码完成视频全部清晰度转码完成的事件通知。

  • 您还可以为合成视频添加特效。更多详情,请参见特效

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:ProduceEditingProjectVideoWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectIdstring

云剪辑工程 ID。可通过以下方式获取:

fb2101bf24b4cb318787dc****
Timelinestring

云剪辑工程时间线,JSON 格式。具体结构定义,请参见 Timeline

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac59615a54328bc3443****"},{"MediaId":"da87a9cff645cd88bc6d8326e4****"}]}]}
Titlestring

云剪辑工程标题。

剪辑合成测试
Descriptionstring

云剪辑工程描述。

描述
CoverURLstring

云剪辑工程封面。

https://example.aliyundoc.com/6AB4D0E1E1C7446888351****.png
MediaMetadatastring

合成视频的元数据,JSON 格式。具体结构定义,请参见 MediaMetadata

{"Description":"合成视频描述","Title":"合成userData测试"}
ProduceConfigstring

合成配置,JSON 格式。具体结构定义,请参见 ProduceConfig

说明 当地域为除上海以外的其他地域时,StorageLocation 字段必填。
{"TemplateGroupId":"6d11e25ea30a4c465435c74****"}
UserDatastring

自定义设置,为 JSON 字符串,支持消息回调等设置。具体结构定义,请参见 UserData

说明 此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。
{"Extend":{"width":1280,"id":"028a8e56b1ebf6bb7afc74****","height":720},"MessageCallback":{"CallbackURL":"https://example.aliyundoc.com/2016-08-15/proxy/httpcallback/testcallback/","CallbackType":"http"}}
AppIdstring

应用 ID。默认取值: app-1000000。使用说明,请参见多应用

app-****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58****
MediaIdstring

合成的视频 ID。

说明
  • 视频合成接口同步返回合成的视频 ID。
  • 接口返回 MediaId,表示视频合成已进入异步处理阶段。
  • 006204a11bb386bb25491f95f****
    ProjectIdstring

    云剪辑工程 ID。

    fb2101bf24b4cb318787dc****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
      "MediaId": "006204a11bb386bb25491f95f****",
      "ProjectId": "fb2101bf24b4cb318787dc****"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-11-02OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:AppId
    • 本页导读 (1)
    文档反馈