UpdateProject - 更新剪辑工程--视频点播-火山引擎

文档中心

立即注册

导航

UpdateProject - 更新剪辑工程

最近更新时间：2025.11.04 17:25:16首次发布时间：2025.10.24 19:49:14

调用 UpdateProject 接口通过工程 ID 更新剪辑工程信息，包括基本信息、上传视频时的相关参数、剪辑视频的相关参数、画布配置和轨道信息等最新剪辑参数。

请求说明

请求方式：POST
请求地址：https://vod.volcengineapi.com?Action=UpdateProject&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateProject`	接口名称。当前 API 的名称为 `UpdateProject`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
GroupId	String	是	`g03ce0xxxxxxxxxxx2g`	工程所属分组的 ID。
ProjectId	String	是	`p03efxxxxxxxxxxxxxxxk74bm0`	工程 ID。
ProjectName	String	否	`新建项目-lozm19gfpr`	工程名称。
LatestEditParam	Object	否	`-`	工程的最新视频剪辑参数。
Project	Object	否	`-`	工程的基本信息。
Version	String	是	`1.0.0`	工程的版本号。
Name	String	是	`新建项目-lozm19gfpr`	工程名称。
CreateTime	Integer	是	`1759060604253`	工程创建的时间戳，单位为毫秒。
UpdateTime	Integer	是	`1760842914243`	工程最后一次更新的时间戳，单位为毫秒。
Tag	String	是	`TrackEditor`	工程标签。
Upload	Object	否	`-`	上传视频时的相关参数。
SpaceName	String	是	`yhss`	上传视频时指定的存储空间名称。
VideoName	String	是	`新建项目-lozm19gfpr-0928-20:06`	上传视频时指定的视频名称。
FileName	String	是	`/新建项目-lozm19gfpr-0928-20:06.mp4`	上传视频文件的完整路径，包含文件名和扩展名。
Output	Object	否	`-`	输出视频的相关参数配置。
Alpha	Boolean	是	`false`	输出视频中是否包含 alpha 通道。默认值为 `false`。说明 `Alpha` 的优先级高于 `VideoCodec`。当 `Alpha` 为 `true` 时，`VideoCodec` 默认采用 `VP9`，而不再关注您设置的 `VideoCodec` 参数。
Fps	Integer	是	`30`	输出视频的帧率。单位为 fps。默认值为 30。
Codec	Object	是	`-`	输出视频的编码参数配置。
VideoCodec	String	是	`h264`	输出视频的视频编码格式。取值如下： `h264`: （默认）H.264 `vp9`: VP9 `h265`: H.265
Preset	String	是	`slow`	用于调节视频编码速度和质量。默认值为 `slow` 。仅当 `VideoCodec` 设为 `h264`、`h265` 时生效。
Crf	Integer	是	`23`	恒定质量因子 CRF。默认值为 `23`。说明仅当 `VideoCodec` 设为 `h264`、`h265` 时生效。
AudioCodec	String	是	`aac`	音频编码格式。默认值为 `aac`。
AudioBitrate	Integer	是	`128`	音频编码码率。默认值为 128。单位为 kbps。
DisableVideo	Boolean	是	`false`	是否禁用视频输出。 `false`: （默认）保存视频。 `true`: 禁用视频输出。
DisableAudio	Boolean	是	`false`	是否禁用音频输出： `false`: （默认）保存音频。 `true`: 禁用音频输出。
Cover	Object	是	`-`	输出视频的封面配置，包含是否禁用封面和封面时间点设置。
DisableCover	Boolean	是	`false`	是否禁用输出视频的封面： `false`: （默认）保存封面。 `true`: 禁用封面。
CoverTime	Integer[]	是	`[1000,2000,3000]`	封面时间点数组，用于指定输出视频封面的时间点，单位为毫秒。
Format	String	是	`mp4`	视频输出的格式类型，取值如下。 `MP4` `DASH` `HLS` `FLV` `TS`
Canvas	Object	否	`-`	视频剪辑的画布配置，包含画布的宽度、高度和背景颜色。
Width	Integer	是	`1920`	视频文件的宽度，单位为像素。取值范围为 [160,8192]。
Height	Integer	是	`1080`	视频文件的高度，单位为像素。取值范围为 [160,8192]。
BackgroundColor	String	是	`#000000FF`	视频剪辑画布的背景颜色。RGBA 类型，默认值为 `#00000000`。
Track	String[][]	否	`-`	视频剪辑的轨道列表信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Result	Integer	`1`	接口操作的结果状态码，`1`表示操作成功。

请求示例

POST https://vod.volcengineapi.com?Action=UpdateProject&Version=2018-01-01
{
  "GroupId": "g03ce0xxxxxxxxxxx2g",
  "ProjectId": "p03efxxxxxxxxxxxxxxxk74bm0",
  "LatestEditParam": {
    "Project": {
      "Version": "1.0.0",
      "Name": "新建项目-lozm19gfpr",
      "CreateTime": 1759060604253,
      "UpdateTime": 1760842914243,
      "Tag": "TrackEditor"
    },
    "Upload": {
      "SpaceName": "yhss",
      "VideoName": "新建项目-lozm19gfpr-0928-20:06",
      "FileName": "/新建项目-lozm19gfpr-0928-20:06.mp4"
    },
    "Output": {
      "Alpha": false,
      "Fps": 30,
      "Codec": {
        "VideoCodec": "h264",
        "Preset": "slow",
        "Crf": 23,
        "AudioCodec": "aac",
        "AudioBitrate": 128
      },
      "DisableVideo": true,
      "DisableAudio": false,
      "Cover": {
        "DisableCover": false,
        "CoverTime": [
          null
        ]
      },
      "Format": "mp4"
    },
    "Canvas": {
      "Width": 1920,
      "Height": 1080,
      "BackgroundColor": "#000000FF"
    },
    "Track": [
      [
        ""
      ]
    ]
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "UpdateProject",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": 1
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。