剪辑合成参数说明_智能媒体服务(IMS)-阿里云帮助中心

本文向您介绍常用的剪辑合成参数。

OutputMediaConfig

输出成品的目标配置，JSON格式。可以设置输出成品在OSS上的URL，或者VOD Bucket 中的存储位置。输出到OSS时，输出目标的 MediaURL 必填；输出到VOD 时，StorageLocation 和 FileName 两个参数必填。

参数说明

字段名称	类型	必填项	描述
MediaURL	String	成片输出到OSS时必填	指定输出到OSS的媒资文件URL。如：http://-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4 注： OSS bucket需与调用服务所在区域相同。不支持OSS加速域名或CDN域名。输出格式支持可参见支持剪辑的媒资格式
StorageLocation	String	成片输出到VOD时必填	指定输出到VOD的媒资文件存储地址，不包含http:// 的前缀。如：outin-xxxxxx.oss-cn-shanghai.aliyuncs.com
FileName	String	成片输出到vod时必填	指定输出到VOD的媒资文件名，包含文件后缀，不包含路径。如：outputVod.mp4
Video	String	否	指定输出成品与视频流相关的配置，更多信息请参见下文 Video 详情
Width	Integer	否	输出成品的宽。可以不填，默认值是多个素材的最大宽。
Height	Integer	否	输出成品的高。可以不填，默认值是多个素材的最大高。
Bitrate	Integer	否	输出成品的码率，单位为Kbps。可以不填，默认值是多个素材的最高码率。
MaxDuration	Float	否	输出成品的最大时长，单位为秒。相关用法介绍请参见设置 MaxDuration
ProduceTemplateId	String	否	定制参数，合成模板Id，与MPS转码模板ID一致，用于设置输出成品的合成转码参数。用于特殊场景下定制视频处理，模板 ID 为 MPS 系统中的转码模板ID，可以在 MPS 产品中创建。
VodTemplateGroupId	String	否	成片输出至VOD时，请指定VOD转码模板组，并使用从视频点播控制台获取的转码模板组ID。如不需要VOD转码，请填写 "VOD_NO_TRANSCODE"。更多详情请参见转码模板。
Endpoint	String	否	云厂商的 Endpoint 输出为 S3 协议时所需
Bucket	String	否	输出云厂商的存储 Bucket 输出为 S3 协议时所需
ObjectKey	String	否	输出对象名输出为 S3 协议时所需
AccessKeyId	String	否	从对应云厂商中拿到的临时 AccessKeyId 输出为 S3 协议时所需
AccessKeySecret	String	否	从对应云厂商中拿到的临时 AccessKeySecret 输出为 S3 协议时所需

Video 详情

OutputMediaConfig 中的参数，用于指定输出成品与视频流相关的配置，配置示例见下文。

参数	类型	必填项	含义	描述
Fps	Integer	否	输出视频流帧率	取值范围：[1, 60] 默认值：25
Orientation	String	否	输出成片横竖屏	取值范围：{Horizontal, Vertical} Horizontal：横屏 Vertical：竖屏指定横屏，则会以「宽最大的横屏视频素材」的宽高作为输出成片的最大宽高指定竖屏：则会以「高最大的竖屏视频素材」的宽高作为输出成片的最大宽高如果指定了 Width 与 Height，本参数将失效
Codec	String	否	编码格式	取值集合：{H.264, H.265} 默认值：H.264
Profile	String	否	编码级别	取值集合：{baseline, main, high} 默认值：high 注意：仅 H.264 支持此参数
Crf	Integer	否	码率-质量控制因子	取值范围：[0, 51] 默认值：编码格式为 H.264 时，默认值为 23 编码格式为 H.265 时，默认值为 26 注意：如果同时设置 Crf 和 Bitrate，Bitrate 会失效
Preset	String	否	视频算法器预制	取值集合：{veryfast, fast, medium, slow, slower} 默认值：medium 注意：仅 H.264 支持此参数

参数示例

输出到OSS

当输出到 OSS ，即成片存储至用户自有oss bucket时，MediaURL 必填，其他参数可以选填。其中 Bitrate 用来设置输出成品的码率，通常码率越高越清晰，最大可以设置到 5000。 Width, Height 用来设置成品的分辨率。

{
 "MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4",
 "Bitrate": 2000,  
 "Width": 800,  
 "Height": 680
}

OSS URL 的路径格式： https://${bucket}.${oss-region-name}.aliyuncs.com/${fileKey}

bucket 是 OSS Bucket 的名称，fileKey 是OSS 文件名（包含路径和文件后缀）。

oss-region-name.aliyuncs.com 是 OSS 文件的外网 Endpoint，比如上海，北京，杭州的分别是：

oss-cn-shanghai.aliyuncs.com
oss-cn-hangzhou.aliyuncs.com 
oss-cn-beijing.aliyuncs.com

输出到VOD

当输出到 VOD 时， StorageLocation 和 FileName 两个参数必填。请到vod控制台查看可用的VOD存储地址。

{ 
  "StorageLocation": "outin-*xxxxxx7d2a3811eb83da00163exxxxxx.oss-cn-shanghai.aliyuncs.com",  
  "FileName": "outputVod.mp4",  
  "Bitrate": 2000,  
  "Width": 800,  
  "Height": 680,
  "VodTemplateGroupId": "VOD_NO_TRANSCODE"
}

配置 Video 参数示例

在 OutputMediaConfig 中设置 Video 参数示例。

{
  "OutputMediaConfig": {
    "MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4",
    "Width": 800,  
    "Height": 680,
    "Video": {
      "Codec": "H.264",
      "Fps": 50,
      "Profile": "main",
      "Crf":15
    }
  }
}

ProjectMetadata

剪辑工程的元数据信息，JSON格式。

参数说明

字段名称

类型

必填项

描述

Description

String

否

剪辑工程的描述

Title

String

否

剪辑工程的标题

参数示例

{
   "Description":"描述",
   "Title":"标题"
}

EditingProduceConfig

普通剪辑合成参数，JSON格式。

参数说明

字段名称	类型	必填项	描述
AudioChannelCopy	String	否	声道复制，支持设置为left或者right。如果设置为left，则输出视频的左右声道均会被复制为输入素材的左声道。如果设置为right，则输出视频的左右声道均会被复制为输入素材的右声道。
AutoRegisterInputVodMedia	Boolean	否	是否需要将您时间线中的VOD媒资自动注册至IMS，默认为true。
AutoRegisterOutputImsMedia	Boolean	否	是否将剪辑合成的视频，自动注册到IMS媒资库中，默认为true。
OutputWebmTransparentChannel	Boolean	否	是否需要输出视频带透明通道，默认为false。如果您需要您的输出webm视频带有alpha透明通道，您需要您的输出视频MediaURL或者FileName以webm结尾，否则默认生成mp4不带透明通道，且您的时间线中有且仅有Scale类型的Effect。
CoverConfig	JSON	否	封面图参数，用户可以设置成片第几秒作为媒资封面（注意，此参数不是修改视频的第一帧，媒资封面是一张单独的图片，存储在客户OSS中，调用GetMediaInfo可获取封面地址） StartTime: 封面图位于成片的第几秒，支持四位小数。
InputMediaRegisterConfig	JSON	否	如果剪辑时间线中包含url，会自动注册成媒资，此字段为输入素材自动注册媒资的配置。 NeedSnapshot：是否截取截图，类型为Boolean，默认为true； NeedSprite：是否截取雪碧图，类型为Boolean，默认为true。
NeedSnapshot	Boolean	否	剪辑合成后自动注册的媒资，是否截取截图。默认为true。
NeedSprite	Boolean	否	剪辑合成后自动注册的媒资，是否截取雪碧图。默认为true。
PipelineId	String	否	用户自定义管道ID，一般用于多个业务线使用同一个主账号提交任务，需要将不同业务线之间的任务做资源隔离。如有需求，请提工单申请。
MaxBitrate	Integer	否	用户自定义输出视频的最大码率。当指定了该字段，且输入素材的码率大于MaxBitrate，输出视频的码率会按照MaxBitrate进行配置。不指定时，输出视频默认最大码率为5000。
KeepOriginMaxBitrate	Boolean	否	输出视频的码率是否随源，默认为false。当KeepOriginMaxBitrate为true 时，根据素材最高码率设置成片码率，上限为50000。
KeepOriginVideoMaxFps	Boolean	否	输出视频的帧率是否随源，默认为false。当KeepOriginVideoMaxFps为true时，根据素材最高帧率设置成片帧率。

参数示例

{
	"AutoRegisterInputVodMedia": true,
	"OutputWebmTransparentChannel": true,
	"CoverConfig": {
		"StartTime": 3.3
	},
	"AudioChannelCopy": "left",
  "PipelineId":"xxxd54a97cff4108b555b01166d4bxxx",
  "MaxBitrate": 5000,
  "KeepOriginMaxBitrate": false,
  "KeepOriginVideoMaxFps": false
}

MediaMetadata

剪辑输出媒资的meta信息，JSON 格式。

参数说明

字段名称	类型	必填项	描述
Title	String	否	媒资标题。长度不超过128字节。 UTF8编码。
Description	String	否	媒资描述。长度不超过1024字节 UTF8编码。
Tags	String	否	媒资标签。最多不超过16个标签。多个用逗号分隔。单个标签不超过32字节。 UTF8编码。
CateId	Long	否	媒资分类ID。

UserData

用户自定义数据，JSON格式。用户在提交合成任务时，可以将自定义数据放在userData中。若配置了合成回调，合成完成后，回调中会包含UserData字段，上限1024字节。

为方便用户使用，userData支持直接传入回调配置，详情请参考最佳实践：配置事件通知地址获取合成完成的回调。

UserData保留字段说明如下：

保留字段

字段名称

类型

必填项

描述

NotifyAddress

String

否

回调地址，支持HTTP回调（http URL）或者MNS回调（mns 队列名）。

HTTP回调示例：http://yourdomain.com/callback

MNS回调示例："ice-callback-test"，队列名必须以ice-callback打头。