CreateHighlightTask - 创建视频高光剪辑任务-智能媒体管理(IMM)-阿里云帮助中心

创建高光任务。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imm:CreateHighlightTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称	immtest
Sources	array<object>	是	需要处理的媒体资源列表。上限 10 个视频。
	object	否	需要处理的媒体资源
URI	string	是	媒体资源 URI（OSS URI）。当前只支持视频。	oss://test-bucket/test-object
StartTime	number	否	媒体资源的开始时间。取值范围 [0, 视频时长]。仅当 Type 为 Concat 时有效。	0
Duration	number	否	媒体片段时长。单位为秒，默认值为 0，表示到视频结束时间。仅当 Type 为 Concat 时有效。	0
Mode	string	否	高光识别模式。 Scene：场景和帧识别 Average（默认）：平均切片识别	Average
Type	string	是	处理类型。 Retrieval：高光提取 Concat：视频合成 Compose：一键成片	Retrieval
Highlight	object	否	高光配置。
Content	string	是	高光内容。宠物人物运动会议长度不能超过 100 字符。	character
Edit	object	否	剪辑配置。
Mode	string	是	剪辑模式。 Sequential：顺序模式	Sequential
BackgroundMusicMode	string	否	背景音乐模式。默认 Closed。 Random：自定义背景音乐，根据权重随机选择 Sequential：自定义背景音乐，根据顺序应用背景音乐 Closed：无背景音乐	Closed
BackgroundMusics	array<object>	否	背景音乐。当 BackgroundMusicMode 为 Random 和 Sequential 有效。当前数量上限是 1。
	object	否	背景音乐
URI	string	是	背景音乐 URI（OSS URI）。当前只支持音频。	oss://test-bucket/test-object/test.mp3
Volume	number	否	背景音乐的音量强度。取值：[0, 10]。默认 0.2。若为 1 则表示使用原始声音强度。	0.2
TransitionMode	string	否	转场模式。默认 Closed。 Auto：自动转场 Random：自定义转场，根据权重随机选择 Sequential：自定义转场，根据顺序应用转场 Closed：无转场	Closed
Transitions	array<object>	否	转场效果。当 TransitionMode 为 Random 和 Sequential 时有效。数量上限 10。
	object	否
Transition	string	是	转场效果。见：转场列表	fade
Duration	number	否	转场时长，单位秒。如果转场时长 > 片段时长 - 1，则该片段上的转场效果不会生效。取值范围 [0, 5]。	0
Weight	integer	否	转场权重。取值 [1, 100]。默认 50。当 TransitionMode 为 Random 时有效。	50
VfxEffectMode	string	否	特效模式。默认 Closed。 Auto：自动特效 Random：自定义特效，根据权重随机选择 Sequential：自定义特效，根据顺序应用特效 Closed：无特效	Closed
VfxEffects	array<object>	否	视觉特效。当 VfxEffectMode 为 Random 和 Sequential 时有效。数量上限 10。
	object	否
VfxEffect	string	是	视觉特效。见：特效列表	letterboxed
Weight	integer	否	转场权重。取值 [1, 100]。默认 50。当 VfxEffectMode 为 Random 时有效。	50
Output	object	是	输出配置。
URI	string	是	输出文件的地址。	oss://test-bucket/test-target-object.mp4
Container	string	否	当 Type 为 Concat 或者 Compose 时，Container 必填。媒体容器类型。可选容器类型如下：音视频容器：mp4、mkv、mov、asf、avi、mxf、ts、flv 重要 Container 与 URI 参数需要同时设置。	mp4
Speed	number	否	媒体倍速播放设置，取值范围为[0.5,1.0]，默认为 1.0。说明转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。	1.0
Segment	object	否	媒体切片设置。默认不进行切片。
Format	string	否	媒体切片方式。取值范围如下： hls dash	hls
Duration	number	否	切片长度。单位为秒。	1
StartNumber	integer	否	起始序号，仅支持 hls，默认为 0。	0
Video	TargetVideo	否	视频处理参数配置。重要当 Video 为空值时，会将第一路视频流（若存在）直接拷贝到输出文件。
Audio	TargetAudio	否	音频处理参数配置。重要当 Audio 为空值时，会将第一路音频流（若存在）直接拷贝到输出文件。
MaxDuration	number	否	剪辑视频的最大时长，单位秒。	10.0
UserData	string	否	用户自定义信息，在异步消息通知中会返回。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Tags	object	否	自定义标签，用于对异步任务进行搜索、过滤。	{"test":"val1"}
CredentialConfig	CredentialConfig	否	链式授权配置。如无特殊需求，请保持留空即可
Notification	Notification	否	消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es****
TaskId	string	任务 ID。	Highlight-4d51241b-04d4-4343-aa25-****

示例

正常返回示例

JSON格式

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
  "TaskId": "Highlight-4d51241b-04d4-4343-aa25-****"
}

错误码

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

变更历史

更多信息，参考变更详情。