文档

参数详情

更新时间:

本文介绍媒体处理中转码、工作流、管道等功能API的部分参数详细说明,包含参数类型、参数用途以及参数取值示例等内容。

Input详情

本参数被SubmitJobs - 提交转码作业引用。

参数

类型

是否必选

描述

Bucket

String

输入文件所在OSS Bucket。

遵守OSS Bucket定义,更多信息请参见基本概念

Location

String

输入OSS Bucket所在数据中心(OSS Region)。

  • OSS Bucket必须与媒体处理服务在同一个地域。

  • 遵守OSS Region定义,更多信息请参见基本概念

Object

String

输入文件的OSS路径 (OSS ObjectKey),即包含文件名在内的完整路径。

  • 遵循OSS ObjectKey定义,更多信息请参见基本概念

  • 在媒体处理API中,Object必须经过URL Encoding(基于UTF-8编码)后使用。详细说明,请参见URL Encoding说明

  • 示例:如果您的路径为阿里云/mts HD+.mp4,需要编码为%E9%98%BF%E9%87%8C%E4%BA%91/mts%20HD%2B.mp4

Referer

String

当您在OSS设置了防盗链,仅允许某些白名单地址可下载文件,则必须填写Referer。如果未设置防盗链,则无需填写。设置防盗链详细操作,请参见防盗链

  • 如果使用工作流转码,则必须在控制台设置Referer。详细操作,请参见设置防盗链

  • 如果提交单个转码作业,必须在API中填写Referer。

Output详情

本参数被SubmitJobs - 提交转码作业AddMediaWorkflow - 新增媒体工作流UpdateMediaWorkflow - 更新媒体工作流的拓扑结构引用。

参数

类型

是否必选

描述

OutputObject

String

输出文件的OSS路径(OSS ObjectKey),即包含文件名、扩展名在内的完整路径。

  • 遵循OSS ObjectKey定义,更多信息请参见基本概念

  • 支持使用占位符,详细说明请参见下文占位符替换规则

  • 文件扩展名规则

    • 使用工作流:无需指定。MPS根据模板容器格式自动在OutputObject后面添加扩展名。

    • 提交单个转码作业:必须手动指定扩展名,且扩展名需要与模板的容器格式相符。但如果容器类型为M3U8,则MPS会给Playlist自动添加扩展名.m3u8。分片文件名会在Playlist后自动添加一个从00001开始的5为序列号为后缀,并以中划线(-)相连,文件扩展名为.ts。例如:Playlist文件名为filename.m3u8,则输出第一个ts分片文件为filename-00001.ts

  • 在媒体处理API中,Object必须经过URL Encoding(基于UTF-8)编码后使用。详细说明,请参见URL Encoding说明

  • 示例:入文件路径为a/b/example.flv,若想输出文件路径为a/b/c/example+test.mp4,则OutputObject用占位符可表示为{ObjectPrefix}/c/{FileName}+test.mp4,再经过URL Encoding后,最终设置为%7BObjectPrefix%7D/c/%7BFileName%7D%2Btest.mp4。

TemplateId

String

转码模板ID。

Container

Object

容器格式(封装格式),更多信息请参见下文Container详情

  • 如设置则覆盖指定转码模板中的对应参数。

Video

Object

视频转码参数。更多信息请参见下文Video详情

  • 如设置则覆盖指定转码模板中的对应参数。

Audio

Object

音频转码参数。更多信息请参见下文Audio详情

  • 如设置则覆盖指定转码模板中的对应参数。

TransConfig

Object

转码流程参数。更多信息请参见下文TransConfig详情

  • 如设置则覆盖指定转码模板中的对应参数。

  • 示例:{"TransMode":"onepass","AdjDarMethod":"none","IsCheckVideoBitrateFail":"true","IsCheckAudioBitrateFail":"true"}

VideoStreamMap

String

输入文件中需要保留的视频流标识。取值如下:

  • 不设置:代表由MPS选择默认的1个视频流。

  • 0:v:{序号}:序号的含义是视频流列表的下标,序号从0开始。例如0:v:1,代表选择第2个视频流参与转码。

  • 0:v:代表选择所有视频流。

AudioStreamMap

String

输入文件中需要保留的音频流标识。取值如下:

  • 不设置:代表由MPS选择默认的1个音频流。通常优先选择中文、多声道、高质量的1个音频流。

  • 0:a:{序号}:序号的含义是音频流列表的下标,序号从0开始。例如0:a:1,代表选择第2个音频流参与转码。

  • 0:a:代表选择所有音频流。适合多语言配音场景。

Rotate

String

视频顺时针旋转角度。

  • 值范围:0、90、180、270。

  • 默认值:0,代表不旋转。

WaterMarks

Object[]

水印列表,将图片或文字压制到画面中。如设置则覆盖指定水印模板中的对应参数。更多信息请参见转码水印参数详情

  • 一次转码任务最多添加4个水印。

  • 单个图片水印示例:["WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a12****"},{"InputFile":{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example-logo.png"},{"Timeline":{"Start":"0","Duration":"ToEND"}}]

  • 单个文字水印示例:["Type":"Text","TextWaterMark":"{"Content":"5rWL6K+V5paH5a2X5rC05Y2w","FontName":"SimSun","FontSize":"16","Top":2,"Left":10}]

DeWatermark

Object

模糊处理。更多信息请参见模糊处理详情

  • 示例:{"0": [{"l":10,"t":10,"w":10,"h":10},{"l":100,"t":0.1,"w":10,"h":10}],"128000": [],"250000": [{"l":0.2,"t":0.1,"w":0.01,"h":0.05}]}

SubtitleConfig

Object

硬字幕配置,将外部字幕文件硬压到画面中。更多信息请参见SubtitleConfig详情

  • 一次转码任务最多压制4个字幕文件。

  • 示例:{"ExtSubtitleList":[{"Input":{"Bucket":"example-bucket-****","Location":"oss-cn-hangzhou","Object":"example.srt"},"CharEnc":"UTF-8"}]}

Clip

Object

片段剪辑。更多信息请参见下文Clip详情

  • 示例:{"TimeSpan":{"Seek":"00:01:59.999","End":"18000.30"},"ConfigToClipFirstPart":false},代表先拼接再整体剪辑,剪辑从1分59秒999毫秒开始,截取到距离片尾剩余5分30毫秒为止。

MergeList

Object[]

拼接列表,将输入文件和片段依次拼接合成为一个视频。更多信息请参见下文MergeList拼接参数详情

  • MergeListMergeConfigUrl只支持二选一,MergeConfigUrl优先级更高。

  • 一次转码任务最多添加4个MergeURL,如需拼接更多片段请使用MergeConfigUrl

  • 单个拼接片段示例:[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4"}]

  • 2个拼接片段示例:[{"MergeURL":"http://exampleBucket****m.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4","Start":"1","Duration":"20"},{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_comm_02.mp4","Start":"5.4","Duration":"10.2"}]

MergeConfigUrl

String

拼接配置文件的OSS存储地址。

  • MergeListMergeConfigUrl只支持二选一,MergeConfigUrl优先级更高。

  • 文件只支持存储于OSS上,存储地址示例:http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/mergeConfigfile

  • 文件内容为多个MergeURL,请按拼接顺序填写,最多支持50个片段拼接。格式请参见MergeList拼接参数详情。文件内容示例:{"MergeList":[{"MergeURL":"http://exampleBucket****m.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4","Start":"1","Duration":"20"},{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_comm_02.mp4","Start":"5.4","Duration":"10.2"}]}

重要

拼接的片段过多、过长都会影响服务性能,可能导致转码失败。如您有专业的拼接制作需求,请使用智能媒体服务的剪辑服务。详细说明,请参见智能媒体服务

OpeningList

Object[]

开板列表。开板是一种特殊的拼接效果,将开板视频嵌入在输入视频开头中,以画中画的方式展示。更多信息请参见OpeningList详情

  • 一次转码任务最多添加2个开板视频,请按拼接顺序填写。

  • 示例:[{"OpenUrl":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv","Start":"1","Width":"1920","Height":"1080"},{"OpenUrl":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/opening_02.flv","Start":"1","Width":"-1","Height":"full"}]

TailSlateList

Object[]

尾板列表。尾板是一种特殊的拼接效果,将尾板视频拼接在输入视频结尾处,以淡入淡出的效果过渡展示。更多信息请参见TailSlateList详情

  • 一次转码任务最多添加2个尾板视频,请按拼接顺序填写。

  • 示例:[{"TailUrl":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_01.flv","Start":"1","BlendDuration":"2","Width":"1920","Height":"1080","IsMergeAudio":false,"BgColor":"White"}]

Amix

Object[]

混音配置。适用于同一视频的多音轨合并、增加背景音乐等。更多信息请参见Amix混音详情

  • 一次转码任务最多添加4个Amix混音文件。

  • 将输入文件的两路音频流混音示例:[{"AmixURL":"input","MixDurMode":"longest","Start":"1","Duration":"2"}]

  • 添加外部文件与输入文件混音示例:[{"AmixURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail.flv","Map":"0:a:1","MixDurMode":"longest","Start":"1","Duration":"2"}]

MuxConfig

Object

打包配置。更多信息请参见下文MuxConfig详情

  • 如设置则覆盖指定转码模板中的对应参数。

  • 示例:{"Segment":{"Duration":"10","ForceSegTime":"1,2,4,6,10,14,18"},代表在第1、2、4、6、10、14、18、20、30、40、50...秒处强制分片。

M3U8NonStandardSupport

Object

M3U8非标准支持。更多信息请参见M3U8非标准参数支持详情

  • 示例:{"TS":{"Md5Support":true,"SizeSupport":true}},代表支持输出ts的md5,支持输出ts的文件大小。

Encryption

String

加密配置,仅当Container为m3u8时生效。更多信息请参见Encryption参数详情

  • 示例:{"Type":"hls-aes-128","Key":"ZW5jcnlwdGlvbmtleTEyMw","KeyType":"Base64","KeyUri":"aHR0cDovL2FsaXl1bi5jb20vZG9jdW1lbnQvaGxzMTI4LmtleQ=="}

UserData

String

用户自定义数据,最大长度1024个字节。

Priority

String

任务在其对应管道内的转码优先级。

  • 值范围:[1,10],1优先级最低,10优先级最高。

  • 默认值:6。

  • 最佳实践:管道有并发限制,当您提交大量任务可能出现排队时,建议将时效性、重要内容设置为高优先级。

Container详情

本参数被Output.Container引用。

参数

类型

是否必选

描述

Format

String

容器格式(封装格式)。

  • 格式支持:更多格式和与Codec的兼容要求,请参见格式支持

    • 视频:3gp、avi、flv、f4v、fmp4、mkv、mov、mp4、ts、mxf、webm、m3u8、hls-fmp4、mpd、cmaf-hls、cmaf-dash。

    • 音频:aac、m4a、mp2、mp3、mp4、ogg、flac、m3u8、hls-fmp4、mpd、cmaf-hls、cmaf-dash。

    • 动图:gif、webp。

  • 默认值:mp4。

TransConfig详情

本参数被Output.TransConfig引用。

参数

类型

是否必选

描述

TransMode

String

视频转码模式。仅Codec为H.264、H.265、AV1时生效,且不同模式必须搭配Video的Bitrate、Crf正确设置。详细说明请参见下文视频码率控制模式。取值如下:

  • CBR:固定码率模式。

  • onepass:一般用于ABR。编码速度较twopass更快。

  • twopass:一般用于VBR。编码速度较onepass更慢。

  • fixCRF:Crf质量控制模式。

  • 默认值:有Bitrate为onepass。没有Bitrate为fixCRF,Crf使用默认值。

AdjDarMethod

String

分辨率改写方式。当Width或Height都填写时才生效,可以和LongShortMode搭配使用。

IsCheckReso

String

是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一,IsCheckResoFail优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,按输入视频分辨率转码。

  • false:不检查。

  • 默认值:false。

IsCheckResoFail

String

是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一,本参数优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,返回转码失败。

  • false:不检查。

  • 默认值:false。

IsCheckVideoBitrate

String

是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一,IsCheckVideoBitrateFail优先级更高。

  • true:检查。当输入视频码率小于输出设置时,按输入视频码率转码。

  • false:不检查。

  • 默认值:false。

IsCheckVideoBitrateFail

String

是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一,本参数优先级更高。

  • true:检查。当输入视频码率小于输出设置时,返回转码失败。

  • false:不检查。

  • 默认值:false。

IsCheckAudioBitrate

String

是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一,IsCheckAudioBitrateFail优先级更高。

  • true:检查。当输入音频码率小于输出设置时,按输入音频码率转码。

  • false:不检查。

  • 默认值:

    • 参数为空,并且codec和输入源不一样:false。

    • 参数为空,并且codec和输入源一样:true。

IsCheckAudioBitrateFail

String

是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一,本参数优先级更高。

  • true:检查。当输入音频码率小于输出设置时,返回转码失败。

  • false:不检查。

  • 默认值:false。

视频码率控制模式

请根据视频码率控制模式,设置对应的TransMode、Bitrate、vbv(Maxrate、Bufsize)、Crf参数。

视频率控制模式

TransMode设置

码率相关参数设置

CBR固定码率模式

CBR

Bitrate=Maxrate=Bufsize。

ABR平均码率模式

onepass或不指定

需指定Bitrate。

可选指定Maxrate和Bufsize控制峰值码率波动范围。

VBR动态码率模式

twopass

需指定Bitrate、Maxrate和Bufsize参数。

Crf质量控制模式

fixCRF

需指定Crf,若不指定则按对应codec的默认Crf值生效。

可选指定Maxrate和Bufsize控制峰值码率波动范围。

不指定

不能指定Bitrate,将按对应codec的默认Crf值生效。

Video详情

本参数被Output.Video引用。

参数

类型

是否必选

描述

Remove

String

是否删除视频流。

  • true:删除。则本节所有Video相关参数失效。

  • false:保留。

  • 默认值:false。

Codec

String

视频编码格式。

  • 可选值:H.264、H.265、AV1、GIF、WEBP。更多格式和与Container的兼容要求,请参见格式支持

  • 默认值:H.264。

Width

String

宽度(或长边)。当LongShortMode为false或未设置时,代表宽度。当LongShortMode为true时,代表视频的长边。

  • 单位:px。

  • 值范围:[128,4096],必须为偶数。

  • 默认值

    • WidthHeight都未设置:使用输入视频的原始宽度(或长边)。

    • 当仅设置Height:按照输入视频的原始比例来计算。

Height

String

高度(或短边)。当LongShortMode为false或未设置时,代表视频的高度。当LongShortMode为true时,代表视频的短边。

  • 单位:px。

  • 值范围:[128,4096],必须为偶数。

  • 默认值

    • WidthHeight都未设置:使用输入视频的原始高度(或短边)。

    • 当仅设置Width:按照输入视频的原始比例计算。

LongShortMode

String

是否开启横竖屏自适应(又称,长短边自适应)。当Width或Height至少填写一项时生效。

  • true:开启。

  • false:关闭。

  • 默认值:false。

  • 最佳实践:如果您的输入视频既有横屏视频也有竖屏视频,为了避免视频拉伸变形,请开启横竖屏自适应开关,并结合分辨率参数设置等比缩放。示例请参见设置横竖屏自适应

Fps

String

帧率。

  • 单位:fps,帧每秒。

  • 值范围:(0,60]。

  • 默认值:输入文件的视频原始帧率,超过60时取60。

  • 常见值:24、25、30。

MaxFps

String

最大帧率。

Gop

String

设置相邻两个I帧之间的时间或者帧数间隔。

说明

Gop值越大,压缩率越高,但编码速度越低、且流媒体单个分片时长越长、播放器seek响应时间越长。更多信息请参见基本概念

  • 关键帧间最大时间间隔:{时间}s,时间范围[1,100000]。

  • 关键帧间最大帧数间隔:{帧数},帧数范围[1,100000]。

  • 默认值:10s,代表每10s一个关键帧。

  • 最佳实践:流媒体播放场景下,为了提高播放器开播速度和seek响应时长,建议设置为[2,7]s。

Bitrate

String

输出文件的视频平均码率。使用CBR、ABR、VBR码控必须设置Bitrate,且TransMode需正确配对设置。详细说明请参见视频码率控制模式

  • 单位:Kbps。

  • 值范围:-1、[10,50000]。-1代表使用输入视频的原始码率。

  • 最佳实践:

    • CBR固定码率模式:需设置TransMode为CBR,且Bitrate=Maxrate=Bufsize。

    • ABR平均码率模式:需设置TransMode为onepass,且指定Bitrate。还可指定Maxrate和Bufsize控制码率波动范围。

    • VBR动态码率模式:需设置TransMode为twopass,且指定Maxrate(或BitrateBnd)和Bufsize参数。

BitrateBnd

String

输出文件的视频平均码率范围。

  • 仅Codec为H.264时生效。

  • 示例:{"Max":"5000","Min":"1000"}

Maxrate

String

输出文件的视频码率峰值。详细说明请参见视频码率控制模式

  • 单位:Kbps。

  • 值范围:[10,50000]。

Bufsize

String

码率控制缓冲区大小。用于控制码率波动。详细说明请参见视频码率控制模式

说明

Bufsize值越大,码率的波动越大,视频质量越高。

  • 单位:Kb。

  • 值范围:[1000,128000]。

  • 默认值:6000。

Crf

String

质量控制因子。使用Crf码控必须设置Crf,且TransMode需设置为fixCRF,详细说明请参见视频码率控制模式

说明

Crf值越大,视频质量越低,压缩率越高。

  • 值范围:[20,51]。

  • 默认值:Codec为H.264时,默认值为23;Codec为H.265时,默认值为26;Codec为AV1时,默认值为32。

  • 最佳实践:

    • 0为无损,51为最差。建议取值[23,29]。您可根据画面复杂度进行调节。每增加或减少6,码率会减少一半或增加一倍,通常同等清晰度下动画片可以比实拍设置得更高。

    • Crf以质量为目标,输出视频码率不可预知,可结合Maxrate、Bufsize来控制码率波动范围。

Qscale

String

视频质量控制值(VBR模式可用)。

说明

Qscale值越大,视频质量越低,压缩率越高。

  • 仅Codec为H.264时生效。

  • 值范围:[0,51]。

Profile

String

编码级别。更多信息请参见基本概念

  • 仅Codec为H.264时生效。

  • 可选值:baseline、main、high。

  • 默认值:high。

  • 最佳实践:一个视频输出多清晰度时,建议最低清晰度设置baseline,以保证最低端设备可播放。其他清晰度设置为main或high。

Preset

String

H.264编码器预置模式。

说明

编码器选择越快的速度模式,视频质量越低。

  • 仅Codec为H.264时生效。

  • 可选值:veryfast、fast、medium、slow、slower。

  • 默认值:medium。

ScanMode

String

扫描模式。取值如下:

  • 不设置:按输入文件的原始模式。

  • auto:自动去隔行。

  • progressive:顺序扫描(逐行扫描)。

  • interlaced:交叉扫描(隔行扫描)。

  • 默认值:空,即不设置。

最佳实践:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。

  • 如果您设置了顺序扫描交叉扫描,但与原视频模式不符,会导致转码失败。

  • 建议您设置原视频模式自动去隔行,以提高兼容性。

PixFmt

String

视频颜色格式。

  • 使用原始颜色格式:PixFmt=""。

  • 指定格式可选值:yuv420p、yuvj420p、yuv422p、yuvj422p、yuv444p、yuvj444p、yuv444p161e、pc、bt470bg、 smpte170m等。 当Codec为GIF时,支持bgr8。

Crop

String

视频画面剪裁。支持自动去黑边或自定义剪裁。

  • 请在输入视频分辨率大于输出视频分辨率时使用。不要设置分辨率改写参数AdjDarMethod。

  • 自动去黑边:border。

  • 自定义剪裁:参数格式为{width}:{height}:{left}:{top}。

    • width:剪裁后,输出视频的宽度。

    • height:剪裁后,输出视频的高度。

    • left:输出画面距离原画面的左边距。

    • top:输出画面距离原画面的上边距。

  • 自定义剪裁示例:1920:800:0:140。示例

Pad

String

视频贴黑边。

  • 请在输入视频分辨率小于输出视频分辨率时使用。不要设置分辨率检查参数IsCheckReso和IsCheckResoFail、不要设置分辨率改写参数AdjDarMethod。

  • 参数格式:{width}:{height}:{left}:{top}。

    • width:贴黑边后,输出视频的宽度。

    • height:贴黑边后,输出视频的高度。

    • left:原画面距离输出画面的左边距。

    • top:原画面距离输出画面的上边距。

  • 示例:1920:1080:0:140。视频贴黑边

Audio详情

本参数被Output.Audio引用。

参数

类型

是否必选

描述

Remove

String

是否删除音频流。

  • true:删除。则本节所有Audio相关参数失效。

  • false:保留。

  • 默认值:false。

Codec

String

音频编解码格式。

  • 可选值:AAC、AC3、EAC3、MP2、MP3、FLAC、OPUS、VORBIS、WMA-V1、WMA-V2、pcm_s16le。更多格式和与Container的兼容要求,请参见格式支持

  • 默认值:AAC。

说明

转码时将音频编码格式设置为AC3、EAC3,会将您的普通音频转码为杜比格式,配合阿里云播放器SDK可以在杜比设备上开启杜比专属音效。杜比音效制作属于音视频增强服务,中国内地按3.5元/分钟计费,不额外收取音频转码费用。详细说明,请参见音视频增强费用

Profile

String

音频编码级别。

  • 仅Codec为AAC时生效。

  • 可选值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。更多信息请参见基本概念

  • 默认值:aac_low。

Bitrate

String

输出文件的音频码率。

  • 单位:Kbps。

  • 值范围:[8,1000]。

  • 默认值:128。

  • 常见值:64、128、256。

Samplerate

String

采样率。

  • 单位:Hz。

  • 可选值:22050、32000、44100、48000、96000。

    说明

    不同封装和编码格式支持的采样率不同,完整信息请参见采样率支持。例如:音频Codec为MP3时,所有封装格式的采样率不支持96000,且封装格式为FLV时,采样率仅支持22050、44100。

  • 默认值:44100

Channels

String

声道数。

  • 可选值:0、1、2、4、5、6、8。

    • 音频Codec为MP3、OPUS时,支持0、1、2。

    • 音频Codec为AAC、FLAC时,支持0、1、2、4、5、6、8。

    • 音频Codec为VORBIS时,支持2。

    • Format为mpd时,不支持8。

  • 默认值:2。

  • 若要保留原声道数,请设置为0。

Volume

String

音量控制,详细信息请参见下文Volume音量控制详情

  • 仅支持输出一路音频流时设置,多音频流不支持。

Volume音量控制详情

本参数被Output.Audio.Volume引用。

参数

类型

是否必选

描述

Method

String

音量调整方式。

  • auto:自动调整。

  • dynamic:动态调整。

  • linear:线性调整。

  • 默认值:dynamic。

Level

String

相对输入音频的音量提升的幅度。

  • 当指定Method为linear时生效。

  • 单位:db。

  • 值范围:不超过20db。

  • 默认值:-20db。

IntegratedLoudnessTarget

String

目标音量。

  • 当指定Method为dynamic时生效。

  • 单位:db。

  • 值范围:[-70,-5]。

  • 默认值:-6。

TruePeak

String

最大峰值。

  • 当指定Method为dynamic时生效。

  • 单位:db。

  • 值范围:[-9,0]。

  • 默认值:-1。

LoudnessRangeTarget

String

相对目标音量的波动范围。

  • 当指定Method为dynamic时生效。

  • 单位:db。

  • 值范围:[1,20]。

  • 默认值:8。

转码水印参数详情

本参数被Output.WaterMarks引用。

参数

类型

是否必选

描述

Type

String

水印类型。

  • Text:文字水印。此时必须设置TextWaterMark。

  • Image:图片水印。此时必须设置图片水印相关参数。

  • 默认值:Image。

TextWaterMark

Object

文字水印配置。更多信息请参见文字水印参数详情

  • 若Type为Text文字水印,此参数必填。

  • 示例:{"Content":"5rWL6K+V5paH5a2X5rC05Y2w","FontName":"SimSun","FontSize":"16","Top":2,"Left":10}

InputFile

Object

图片水印文件,使用OSS的Bucket、Location、Object描述文件位置。

  • 格式及扩展名要求:PNG静态图片(扩展名.png)、PNG动图(扩展名.apng)、MOV文件(扩展名.mov)、GIF文件(扩展名.gif)。

  • 文件只支持存储于OSS上,参数规范请参见Input详情

  • 在媒体处理API中,Object必须经过URL Encoding(基于UTF-8编码)后使用。

  • 示例:{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example-logo.png"}

说明

给HDR视频添加非HDR图片水印可能会导致偏色。

WaterMarkTemplateId

String

图片水印模板ID。若不设置,则图片水印相关参数使用以下默认配置:

  • 图片水印位置:TopRight。

  • 图片水印水平偏移量Dx、垂直偏移量Dy:0。

  • 图片水印宽度:为输出分辨率宽的0.12倍。

  • 图片水印高度:为相对水印宽的等比缩放。

  • 图片水印显示时间:从头到尾。

ReferPos

String

图片水印的位置。

  • 可选值:TopRight、TopLeft、BottomRight、BottomLeft。

Dx

String

图片水印相对输出视频的水平偏移量。如设置则覆盖指定水印模板中的对应参数。有两种设置方式:

  • 整数型,代表偏移像素。

    • 单位:px。

    • 值范围:[8,4096]。

  • 小数型,代表水平偏移量与输出分辨率宽的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分自动丢弃。

Dy

String

图片水印相对输出视频的垂直偏移量。有两种设置方式:

  • 整数型,代表偏移像素。

    • 单位:px。

    • 值范围:[8,4096]。

  • 小数型,代表垂直偏移量与输出分辨率高的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分自动丢弃。

Width

String

图片水印宽度。有两种设置方式:

  • 整数型,代表水印图片宽的像素值。

    • 范围:[8,4096]。

    • 单位:px。

  • 小数型,代表相对输出视频分辨率宽的百分比。

    • 范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

Height

String

图片水印高度。有两种设置方式:

  • 整数型,代表水印图片高的像素值。

    • 范围:[8,4096]。

    • 单位:px。

  • 小数型,代表相对输出视频分辨率高的比率。

    • 范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

Timeline

String

图片水印的显示时间。更多信息请参见Timeline参数详情

文字水印参数详情

本参数被Output.WaterMarks.TextWaterMark引用。

参数

类型

是否必选

描述

Content

String

文字水印内容,内容需做Base64编码。

  • 示例:添加文字水印“测试文字水印”,那么Content的值为“5rWL6K+V5paH5a2X5rC05Y2w”。

说明

传入特殊字符(比如emoji、单引号)会导致水印输出截断或失败。请先对特殊字符进行转义后再传入。

FontName

String

字体。

FontSize

Int

字号。

  • 值范围:(4,120)。

  • 默认值:16。

FontColor

String

字体颜色。

  • 可选值:请参见FontColor的name。

  • 默认值:black。

FontAlpha

Float

字体透明度。

  • 值范围:(0,1]。

  • 默认值:1.0。

BorderWidth

Int

描边宽度。

  • 单位:px。

  • 值范围:[0,4096]。

  • 默认值:0。

BorderColor

String

描边颜色。

  • 可选值:请参见BorderColor的name。

  • 默认值:Black。

Top

Int

文本上边距。

  • 单位:px。

  • 值范围:[0,4096]。

  • 默认值:0。

Left

Int

文本左边距。

  • 单位:px。

  • 值范围:[0,4096]。

  • 默认值:0。

Timeline参数详情

本参数被Output.WaterMarks.Timeline引用。

参数

类型

是否必选

描述

Start

String

图片水印开始出现时间。

  • 格式:sssss[.SSS]。

  • 值范围: [0.000,86399.999]。如果开始时间超过片长则转码失败。

  • 默认值:0。

  • 示例:18000.30。

Duration

String

图片水印持续时间。

  • ToEND:代表水印持续显示直到片尾。

  • {持续时长}:格式sssss[.SSS],单位秒。

  • 默认值:ToEND。

水印模板配置详情

本参数被AddWaterMarkTemplate - 新增水印模板UpdateWaterMarkTemplate - 更新水印模板接口引用 。

参数

类型

是否必选

描述

Type

String

水印类型。

  • Image:图片水印。

  • 默认值:Image。

ReferPos

String

图片水印的位置。

  • 可选值:TopRight、TopLeft、BottomRight、BottomLeft。

  • 示例:使用ReferPos、Dx、Dy描述位置请见下图。

Dx

String

图片水印相对输出视频的水平偏移量。有两种设置方式:

  • 整数型,代表偏移像素。

    • 单位:px。

    • 值范围:[8,4096]。

  • 小数型,代表水平偏移量与输出分辨率宽的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分自动丢弃。

Dy

String

图片水印相对输出视频的垂直偏移量。有两种设置方式:

  • 整数型,代表偏移像素。

    • 单位:px。

    • 值范围:[8,4096]。

  • 小数型,代表垂直偏移量与输出分辨率高的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分自动丢弃。

Width

String

图片水印宽度。有两种设置方式:

  • 整数型:代表水印图片宽的像素值。

    • 单位:px。

    • 范围:[8,4096]。

  • 小数型:代表相对输出视频分辨率宽的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

Height

String

图片水印高度。有两种设置方式:

  • 整数型:代表水印图片高的像素值。

    • 单位:px。

    • 范围:[8,4096]。

  • 小数型:代表相对输出视频分辨率高的比率。

    • 值范围:(0,1)。

    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

Timeline

String

动态水印。更多信息请参见Timeline参数详情

使用ReferPos、Dx、Dy描述水印位置说明:

使用Width、Height描述水印宽、高说明:

  • 宽、高都不设置时,水印宽取输出视频分辨率宽的0.12倍,水印高按水印原图宽高比例等比缩放。

  • 宽或高设置一边,另一边不设置时,则另一边按水印原图宽高比等比缩放。

  • 宽、高两边都设时,按实际设置值设置水印图片。

模糊处理详情

本参数被Output.DeWatermark引用。

{
//0ms开始,对距离视频画面左上角10×10像素处,大小为10×10像素的Logo,以及距离左边距100像素,上边距0.1×(src_height)的位置10×10的Logo进行模糊处理。
       "0": [
              {
                "l": 10,
                "t": 10,
                "w": 10,
                "h": 10
              },
              {
                "l": 100,
                "t": 0.1,
                "w": 10,
                "h": 10
              }
            ],
  //128000ms开始,停止对Logo进行模糊处理,即,[0~128000]ms为对Logo进行模糊处理的时间段。
     "128000": [],
  //250000ms开始,在左边距0.2×(src_width)、上边距0.1×(src_height)处,对大小为宽0.01×(src_width),高0.05×(src_height)的Logo进行模糊处理。
  "250000": [
              {
                "l": 0.2,
                "t": 0.1,
                "w": 0.01,
                "h": 0.05
              }
            ]
 }     

字段说明

  • pts:字符,指对象帧的时间戳。单位:毫秒(ms)。

  • l:指模糊处理区域的左边距。

  • t:指模糊处理区域的上边距。

  • w:指模糊处理区域的宽度。

  • h:指模糊处理区域的高度。

当l、t、w、h的值大于 1 时,表示绝对像素值。否则,表示相对片源分辨率的比例值。无论是比例值还是绝对值,都会在最终处理时进行截整处理。

SubtitleConfig详情

本参数被Output.SubtitleConfig引用。

参数

类型

是否必选

描述

ExtSubtitleList

Object[]

外部字幕列表。更多信息请参见ExtSubtitle详情

  • 一次转码任务最多压制4个字幕文件。

  • 示例:[{"Input":{"Bucket":”example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"},"CharEnc":"UTF-8"}]

ExtSubtitle详情

本参数被Output.SubtitleConfig.ExtSubtitle引用。

参数

类型

是否必选

描述

Input

String

外部字幕文件,使用OSS的Bucket、Location、Object描述文件位置。

  • 支持使用srt、ass格式。会读取文件内的颜色信息。

  • 文件只支持存储于OSS上,参数规范请参见Input详情

  • 支持使用占位符,详细说明请参见占位符替换规则

  • 在媒体处理API中,Object必须经过URL Encoding说明基于UTF-8编码)后使用。

  • 示例:转码输入文件路径为a/b/example.flv,若字幕文件路径为a/b/example-cn.mp4,则字幕文件的Object用占位符可表示为{ObjectPrefix}{FileName}-cn.srt。再经过URL Encoding后,最终可设置为{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"%7bObjectPrefix%7d%7bFileName%7d-cn.srt"}

说明

如果字幕文件的时长超过了视频时长,以视频时长为准。如果字幕的文字过多,无法在一行内展示完整,超出部分字幕会被截断。

CharEnc

String

外部字幕字符编码。

  • 可选值:UTF-8、GBK、BIG5、auto。

  • 默认:auto。

说明

外部字幕字符编码设置为auto时,存在误检情况,建议您指定具体的字符编码。

FontName

String

字幕字体。

FontSize

Int

字幕字号。

  • 值范围:(4,120)。

  • 默认值:16。

Clip详情

本参数被Output.Clip引用。

参数

类型

是否必选

描述

TimeSpan

String

剪辑时间区间。 更多信息请参见下文TimeSpan详情

  • 设置持续时长示例:{"Seek":"00:01:59.999","Duration":"18000.30"},代表从1分59秒999毫秒开始,截取到第5分30毫秒为止。

  • 设置截尾时长示例:{"Seek":"00:01:59.999","End":"18000.30"},代表从1分59秒999毫秒开始,截取到距离片尾剩余5分30毫秒为止。

ConfigToClipFirstPart

Boolean

是否对第一个剪辑片段进行剪辑。

  • true:先剪辑第一个片段,再拼接(转码)。

  • false:先拼接(转码),再剪辑。

  • 默认值:false。

TimeSpan详情

本参数被Output.Clip.TimeSpan引用。

参数

类型

是否必选

描述

Seek

String

开始时间点。可以设置剪辑的开始时间点。默认从开头截取。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:00:01:59.999或18000.30。

Duration

String

持续时长。可以设置相对于开始时间点(Seek)的剪辑时长。默认从开始时间点(Seek)到结尾的全部内容。Duration和End参数只支持二选一,设置End则Duration失效。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:00:01:59.99 或18000.30。

End

String

截尾时长,表示切掉尾部的若干时长。Duration和End参数只支持二选一,设置End则Duration失效。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:00:01:59.999或18000.30。

MergeList拼接参数详情

本参数被Output.MergeList引用。

参数

类型

是否必选

描述

MergeURL

String

拼接片段OSS地址。

  • 在媒体处理API中,Object必须经过URL Encoding说明(基于UTF-8编码)后使用。

  • 示例:http://exampleBucket****m.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4

Start

String

起始时间点。拼接视频时,如果您期望只截取部分内容输出到最终视频,可以设置截取的开始时间点。默认从开头截取。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:01:59:59.999或32000.23。

Duration

String

持续时间。拼接视频时,如果您期望只截取部分内容输出到最终视频,可以设置相对于开始时间点(Start)的截取时长。默认从开始时间点(Start)到结尾的全部内容。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:01:59:59.999或者32000.23。

OpeningList详情

本参数被Output.OpeningList引用

参数

类型

是否必选

描述

OpenUrl

String

开板视频的OSS地址。

  • 在媒体处理API中,Object必须经过URL Encoding说明(基于UTF-8编码)后使用。

  • 示例:http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv

Start

String

相对正片视频的开始时间。从0开始延迟多长时间后显示开板视频。

  • 单位:秒。

  • 默认值:0。

Width

String

输出开板视频的宽。有3种设置方式:

  • 指定宽:单位px,值范围[0,4096]。

  • -1:代表等于输入开板视频的宽。

  • full:代表填满正片视频画面。

  • 默认值:-1。

说明

输出的开板视频会以正片视频中心点为基准,居中对齐。开板视频不要超过正片视频宽,否则效果未知。

Height

String

输出开板视频的高。有3种设置方式:

  • 指定宽:单位px,值范围[0,4096]。

  • -1:代表等于输入开板视频的高。

  • full:代表填满正片视频画面。

  • 默认值:-1。

说明

输出的开板视频会以正片视频中心点为基准,居中对齐。开板视频不要超过正片视频高,否则效果未知。

TailSlateList详情

本参数被Output.TailSlateList引用。

参数

类型

是否必选

描述

TailUrl

String

尾板视频的OSS URL地址。

  • 在媒体处理API中,Object必须经过URL Encoding说明(基于UTF-8编码)后使用。

  • 示例:http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_01.flv

BlendDuration

String

正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。

  • 单位:秒。

  • 默认值:0。

Width

String

输出尾板视频的宽。有3种设置方式:

  • 指定宽:单位px,值范围[0,4096]。

  • -1:代表等于输入尾板视频的宽。

  • full:代表填满正片视频画面。

  • 默认值:-1。

说明

输出的尾板视频会以正片视频中心点为基准,居中对齐。尾板视频不要超过正片视频宽,否则效果未知。

Height

String

输出尾板视频的高。有3种设置方式:

  • 指定宽:单位px,值范围[0,4096]。

  • -1:代表等于输入尾板视频的高。

  • full:代表填满正片视频画面。

  • 默认值:-1。

说明

输出的尾板视频会以正片视频中心点为基准,居中对齐。尾板视频不要超过正片视频高,否则效果未知。

IsMergeAudio

Boolean

是否要拼接尾板视频的音频内容。

  • true:拼接。

  • false:不拼接。

  • 默认值:true。

BgColor

String

当尾板视频的宽、高小于正片时,空白处填充的背景色。

  • 可选值:请参见bgcolor的name。

  • 默认值:White。

Amix混音详情

本参数被Output.Amix引用。

参数

类型

是否必选

描述

AmixURL

String

需要被混音的音频流。支持2种模式:

  • input:适用于同一视频的多音轨合并。代表将输入文件中的两路音频流合并。

  • OSS地址:适用于添加外部背景音乐。代表将输入文件的一路音频流与OSS地址中的目标音频流合并。示例:http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail.flv

Map

String

在AmixURL中选取目标音频流,需搭配AudioStreamMap参数指定Input文件中要混音的另一路音频流序号。

  • 格式:0:a:{序号},序号的含义是音频流列表的下标,序号从0开始。

  • 示例:0:a:1,代表选择第2个音频流参与混音。

MixDurMode

String

混音后输出文件的时长模式。

  • first:代表以输入文件的时长为准。

  • longest:代表以输入文件和AmixURL中时长最长的为准。

  • 默认值:longest。

Start

String

起始时间点。混音时,如果您期望只截取部分内容输出到最终音频,可以设置截取的开始时间点。默认从开头截取。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:00:01:59.999或18000.30。

Duration

String

持续时间。混音时,如果您期望只截取部分内容输出到最终音频,可以设置相对于开始时间点(Start)的截取时长。默认从开始时间点(Start)到结尾的全部内容。

  • 格式:hh:mm:ss[.SSS]或sssss[.SSS]。

  • 值范围:[00:00:00.000,23:59:59.999]或[0.000,86399.999]。

  • 示例:00:01:59.999或18000.30。

MuxConfig详情

本参数被Output.MuxConfig引用。

参数

类型

是否必选

描述

Segment

String

分片配置字段。更多信息请参见Segment详情

  • 仅当Container为m3u8、hls-fmp4、mpd、cmaf时生效。

  • 示例:{"Duration":"10","ForceSegTime":"1,2,4,6,10,14,18"}。代表在第1、2、4、6、10、14、18、20、30、40、50...秒处强制分片。

Segment详情

本参数被Output.MuxConfig.Segment引用。

参数

类型

是否必选

描述

Duration

Int

分片时长。

  • 单位:秒。

  • 值范围:[1,60]。

  • 默认值:10。代表在第10、20、30、40秒处强制分片。

ForceSegTime

String

指定分片时间点列表。时间点之间逗号分隔,最多指定10个。

  • 格式:{时间点},{时间点},{时间点}。

  • 时间点格式:小数型,最多3位小数。

  • 时间点单位:秒。

  • 示例:1,2,4,6,10,14,18,代表在第1、2、4、6、10、14、18秒处强制分片。

M3U8非标准参数支持详情

本参数被Output.M3U8NonStandardSupport引用。

参数

类型

是否必选

描述

TS

Object

TS文件相关非标准支持。更多信息请参见TS参数支持详情

TS参数支持详情

本参数被Output.M3U8NonStandardSupport.TS引用。

参数

类型

是否必选

描述

Md5Support

Boolean

是否支持在M3U8文件中输出ts的md5值。

SizeSupport

Boolean

是否支持在M3U8文件中输出ts文件的大小。

Encryption参数详情

本参数被Output.Encryption引用。

参数

类型

是否必选

描述

Type

String

视频的加密方式。取值如下:

  • hls-aes-128:标准加密。

KeyType

String

密钥的加密方式。

  • Base64:基础加密方式。

  • KMS:密钥管理服务KMS方式。使用KMS服务生成明文密钥、密文密钥。

Key

String

加密视频的密文密钥。请根据密钥的加密方式填写。

  • Base64:

    • 请填写明文密钥经过Base64加密后生成的密文密钥。

    • 明文密钥内容自定义,长度最多16位。

    • 示例:明文密钥"encryptionkey128"对应的密文密钥"ZW5jcnlwdGlvbmtleTEyOA=="。

  • KMS:

    • 调用KMS的GenerateKMSDataKey,传入主密钥,KeySpec选择AES_128,获取密文密钥CiphertextBlob。

说明

我们提供主密钥,请您联系我们

KeyUri

String

解密服务地址。解密服务需由您自己搭建。

  • KeyUri不能明文传输给MPS,需经过Base64加密。

  • 示例:如访问URL为http://aliyun.com/document/hls128.key,则经过Base64加密后传入“aHR0cDovL2FsaXl1bi5jb20vZG9jdW1lbnQvaGxzMTI4LmtleQ==”。

SkipCnt

String

开头不加密分片数量,可以便于视频快速起播。

  • 示例:3。

占位符替换规则

文件路径支持使用以下占位符。

示例:输入文件路径为a/b/example.flv,若想输出文件路径为a/b/c/example+test.mp4,则OutputObject需要使用{ObjectPrefix}、{FileName}占位符,再经过URL Encoding后,最终设置为%7BObjectPrefix%7D/c/%7BFileName%7D%2Btest.mp4

占位符说明

转码Output

字幕Input

截图OutputFile

占位符

说明

使用工作流转码

提交转码作业

字幕

使用工作流截图

提交截图作业

{ObjectPrefix}

输入文件前缀

支持

支持

支持

支持

支持

{FileName}

输入文件名

支持

支持

支持

支持

支持

{ExtName}

输入文件扩展名

支持

支持

支持

支持

支持

{DestMd5}

输出文件的Md5值

支持

支持

不支持

不支持

不支持

{DestAvgBitrate}

输出文件的平均码率

支持

支持

不支持

不支持

不支持

{SnapshotTime}

截图时间点

不支持

不支持

不支持

支持

支持

{Count}

批量截图的图片序号

不支持

不支持

不支持

支持

支持

{RunId}

工作流执行实例ID

支持

不支持

不支持

不支

不支持

{MediaId}

工作流媒体ID

支持

不支持

不支持

不支

不支持

SnapshotConfig参数详情

本参数被SubmitSnapshotJob - 提交截图作业引用。

重要

截图作业分为同步和异步模式。异步模式不保证时效性,在提交截图作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证截图已经生成。执行完成后需要调用QuerySnapshotJobList - 查询截图作业结果接口轮询执行结果,或通过为管道绑定MNS消息接收执行结果 ,详细说明请参见接收消息通知。只要设置了Interval和Num中的任何一个参数,就表示使用异步模式。

参数

类型

是否必选

描述

Num

String

截图数量。

  • 只要指定了Interval和Num中的任何一个参数,则表示使用异步模式。且Num必须大于0。

  • 同步单张截图:NumInterval不设置。代表在指定Time时间点截取1张。

  • 异步单张截图:Num=1。代表在指定Time时间点截取1张。

  • 异步多张截图:Num>1。代表从指定Time时间点开始,按指定Interval(或默认值10秒)的间隔截取指定Num张数。当TimeIntervalNum的截取点超过视频时长时,后续截图自动失效,截图完成时返回实际截取的张数。

  • 异步平均截图:Num>1,且Interval=0。代表从指定Time时间点开始,均匀截取Num张图片。

Time

String

截图开始时间。

  • 单位:毫秒

  • Time超过视频时长会返回截图失败。

  • 指定时间点截图场景中,此参数无需设置。其他截图场景此参数必填

    说明

    在指定时间点截图场景中,MPS会取的TimeArrayTimeArray参数中最小的一个时间点,转换为毫秒,即为该场景下的Time值,如果用户输出路径中设置占位符{SnapshotTime},则取Time时间进行替换。

Interval

String

截图间隔时间。

  • 若指定则表示使用异步模式截图。

  • 异步多张截图:Interval>0 。单位:秒。

  • 异步平均截图:Interval=0。

  • 默认值:10。当指定Num且此参数未设置时按默认值提交。

TimeArray

Array

指定时间点数组,指定时间点截图时必填。

  • 单位毫秒,整数,不可重复。

  • 时间点不能超过片源长度,否则会导致截图失败。

  • 可有序或无序提交。推荐您提交有序时间点,无序提交时,将由MPS进行排序。

重要
  • 指定该参数时,NumTimeInterval均不指定。如指定则提示参数指定错误InvalidParameter.Ambiguity。

  • 指定时间点截图支持媒体处理SDK3.3.60及以上版本。版本查询入口请单击查询

FrameType

String

截图类型。

  • 默认值:intra。

  • normal:普通帧。画质稍差,执行速度较慢。优点是可以根据设置的时间点精确截取图像。

  • intra:关键帧。因为视频编码的特点,关键帧图像的优点是画质好,执行速度快。但由于视频中关键帧是间隔一段时间才会出现,所以截图时间点不精确,会在设置的时间点附近寻找相应的关键帧。且若GOP值大于截图间隔时间,会因为找不到足够多的关键帧,而导致截图数量低于设置值。

说明

指定时间点截图场景仅支持normal(普通帧)截图。

Width

String

截图输出图片宽度。

  • 单位:px。

  • 值范围:[8,4096]。建议为偶数。

  • 默认值:

    • 当宽和高都未设置:按输入文件的视频原始宽度。

    • 当仅设置高:按照输入文件等比例计算。

Height

String

截图输出图片高度。

  • 单位:px。

  • 值范围:[8,4096]。建议为偶数。

  • 默认值:

    • 当宽和高都未设置:按输入文件的视频原始高度。

    • 当仅设置宽:按照输入文件等比例计算。

BlackLevel

String

首帧黑屏检测参数,画面中黑色像素占据画面的比例,超过该比例值则认为是黑屏。黑色像素定义见PixelBlackThreshold参数。

生效条件:

  • Time=0,参数生效,过滤黑屏。Time>0,放弃过滤黑屏。

  • 当Time=0且Num=1或不指定,检测开始5秒数据,如果有非黑屏图片,则截取非黑屏图片;否则返回截图失败。

  • 当Time=0且Num>1,参数只对第一张截图生效,检测开始5秒数据,如果有非黑屏图片,则截取非黑屏图片;如果全是黑屏图片,则截取第一帧黑屏图片。

参数说明:

  • 值范围:[30,100]。

  • 默认值:100。

  • 最佳实践:纯黑请设置成100。

  • 示例:Time=0且Num=10,代表要对首图做黑屏过滤。

PixelBlackThreshold

String

首帧黑屏检测参数,像素的颜色值,小于该阈值则认为是黑色像素。

  • 值范围:[0,255]。0为纯黑色,255为纯白色。

  • 最佳实践:如果过滤效果不明显,可以提高值来扩大黑色像素的判定范围。建议从30开始尝试。

  • 示例:100,即像素的颜色值小于100的都认为是黑色像素。

Format

String

输出格式。

  • vtt:代表输出webvtt,请同时设置SubOut参数控制是否生成webvtt文件。

  • 默认值:空,代表jpg。

SubOut

Object

Webvtt配置。更多信息请参见SubOut Webvtt配置详情

  • Formatvtt时必填。

TileOut

Object

拼图配置。 更多信息请参见TileOut拼图配置详情

  • 配置后会生成拼图大图,并存储到TileOutputFile。

  • 不配置则不生成拼图。

OutputFile

Object

输出的单张小图文件,使用OSS的Bucket、Location、Object描述文件位置。更多信息请参见OutputFile截图详情

  • 截图文件格式为jpg。

  • 示例:{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.jpg"}。

TileOutputFile

Object

输出的拼图大图文件,使用OSS的Bucket、Location、Object描述文件位置。结构同OutputFile。

  • 当配置了TileOut,即生成拼图时必填。

  • 拼图文件格式为jpg。

  • 示例:{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.jpg"}。

说明
  • 当Num>1时,Object必须包含占位符{TileCount},经过URL Encoding后为%7BTileCount%7D,用于区分多张截图的输出地址。如要截取3张图片,Object为%7BTileCount%7D.jpg,则输出图片Object依次为00001.jpg,00002.jpg,00003.jpg。

  • 当既要在OutputFile保留单张小图,又在TileOutputFile保留拼图大图时,请设置不同的Object,以免被覆盖。

SubOut Webvtt配置详情

本参数被SnapshotConfig.SubOut引用。

参数

类型

是否必选

描述

IsSptFrag

String

是否生成webvtt索引文件。

  • true:生成webvtt索引文件。并跟随截图文件存储到同一路径。

  • false:不生成webvtt索引文件,只输出截图。

  • 默认:false。

TileOut拼图配置详情

本参数被SnapshotConfig.TileOut引用。

参数

类型

是否必选

描述

Lines

Int

图片拼合行数。

  • 值范围:(0,10000]。

  • 默认:10。

Columns

Int

图片拼合列数。

  • 值范围:(0,10000]。

  • 默认:10。

CellWidth

String

单图片宽度。

  • 单位:px。

  • 默认值:截图输出分辨率宽度。

CellHeight

String

单图片高度。

  • 单位:px。

  • 默认值:截图输出分辨率高度。

Padding

String

单图图片间距。

  • 单位:px。

  • 默认值:0。

Margin

String

外框宽度。

  • 默认:0。

  • 单位:px。

Color

String

背景颜色。间距、外框和未填充图片的区域会显示该颜色。

  • 值范围:颜色关键字,random。其中颜色关键字支持三种格式,比如黑色,支持Black,black,#000000。

  • 默认:black。

IsKeepCellPic

String

是否保留单张小图。

  • true:保留,并且单图会存储到OutputFile中。

  • false:不保留。

  • 默认:false,不保留。

OutputFile截图详情

参数

类型

是否必选

描述

Bucket

String

单张小图输出文件所在的OSS Bucket。

  • 遵守OSS Bucket定义,更多信息请参见基本概念

Location

String

单张小图输出文件所在的OSS Bucket的地域(OSS Region)。

  • OSS Bucket必须与媒体处理服务在同一个地域。

  • 遵守OSS Region定义,更多信息请参见基本概念

Object

String

单张小图输出文件的OSS路径(OSS ObjectKey)。

  • 即包含文件名、扩展名在内的完整路径。遵循OSS ObjectKey定义,更多信息请参见基本概念

  • 支持使用占位符,详细说明请参见占位符替换规则

  • 文件扩展名:仅支持jpg。

  • 在媒体处理API中,Object必须经过URL Encoding说明(基于UTF-8编码)后使用。

说明
  • 当Num>1时,Object必须包含占位符{Count},经过URL Encoding后为%7BCount%7D,用于区分多张截图的输出地址。如要截取3张图片,Object为%7BCount%7D.jpg,则输出图片Object依次为00001.jpg,00002.jpg,00003.jpg。

  • 当既要在OutputFile保留单张小图,又在TileOutputFile保留拼图大图时,请设置不同的Object,以免被覆盖。

NotifyConfig详情

本参数被AddPipeline - 添加管道UpdatePipeline - 更新管道:名称、状态及通知设定接口引用。

参数

类型

是否必选

描述

QueueName

String

绑定的MNS队列。绑定后,当该管道上的作业执行结束时,会将执行结果发送到该队列。消息设置请参见接收消息通知

Topic

String

绑定的MNS主题。绑定后,当该管道上的作业执行结束时,会将执行结果发送到该主题。主题会以消息形式推送到多个队列或订阅的地址上,消息设置请参见接收消息通知

转码作业输入详情

参数

类型

是否必选

描述

Bucket

String

输入文件所在OSS Bucket。

  • 需在控制台中资源控制频道里的Bucket授权页面授予此Bucket读权限给媒体处理服务。

  • 遵守OSS Bucket定义,更多信息请参见术语表

Location

String

输入OSS Bucket所在数据中心(OSS Location)。

遵守OSS Location定义,更多信息请参见术语表

Object

String

输入文件 (OSS Object)。

  • 遵循RFC 2396(UTF-8编码,并进行URLEncode,更多信息,请参见URL Encoding说明)。

  • 遵守OSS Object定义,更多信息请参见术语表

Audio

String

源媒体文件的音频配置,JSON对象。

说明

当输入文件为ADPCM、PCM格式时,此参数为必填项。

  • 更多信息请参见InputAudio详情

  • 示例:{"Channels":"2","Samplerate":"44100"}

Container

String

源媒体文件容器配置,JSON对象。

说明

当输入文件为ADPCM、PCM格式时此参数为必填项。

InputContainer详情

参数

类型

是否必选

描述

Format

String

源媒体音频格式。

取值:alaw、f32be、f32le、f64be、f64le、mulaw、 s16be, s16le, s24be、s24le、s32be、s32le、s8、u16be、u16le、 u24be、u24le、u32be、u32le、u8

InputAudio详情

参数

类型

是否必选

描述

Channels

String

源媒体音频声道数。 范围:[1,8]。

Samplerate

String

源媒体音频采样率。

  • 范围:(0,320000]

  • 单位:Hz

AnalysisConfig详情

参数

类型

是否必选

描述

QualityControl

String

输出质量控制,JSON对象。 更多信息请参见AnalysisConfig详情

PropertiesControl

String

属性控制,JSON对象。 更多信息请参见PropertiesControl详情

QualityControl详情

参数

类型

是否必选

描述

RateQuality

String

输出质量等级。

  • 值范围:(0,51)

  • 值为整数

  • 默认值:25

MethodStreaming

String

播放方式,network或local。

默认值:network

PropertiesControl详情

参数

类型

是否必选

描述

Deinterlace

String

强制扫描模式判定。

  • Auto:自动。

  • Force:强制做deinterlace。

  • None:强制不做。

Crop

String

视频裁切配置。

  • 默认:自动。

  • 如此值不是空JSON{},则它的属性Mode必填。

  • 更多信息请参见Crop详情

Crop详情

参数

类型

是否必选

描述

Mode

String

如Crop不是空JSON{},则此值必填。取值:

  • Auto:自动

  • Force:强制

  • None:强制不做

Width

Integer

裁切后宽。

  • 范围:[8,4096]

  • 如MODE为Auto、None,此值失效

Height

Integer

裁切后高。

  • 范围:[8,4096]

  • 如MODE为Auto、None,此值失效

Top

Integer

裁切上边距。

  • 范围:[8,4096]

  • 如MODE为Auto、None,此值失效

Left

Integer

裁切左边距。

  • 范围:[8,4096]

  • 如MODE为Auto、None,此值失效

TransFeatures详情

参数

类型

是否必选

描述

MergeList

String

视频拼接配置字段。

  • JSON数组,最多支持4个MergeURL。更多信息请参见MergeList拼接参数详情

  • 示例:[{"MergeURL":"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/k/mp4.mp4"},{"MergeURL":"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/c/ts.ts","Start":"1:14","Duration":"29"}]

作业输出文件详情

参数

类型

是否必选

描述

URL

String

输入文件的OSS URL。

  • 示例:http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example.flv

  • 若不指定URL,则Bucket、Location、Object必填。

Bucket

String

  • 若不指定URL,则此值必填。

  • 否则,此值失效,输出文件所在OSS Bucket,需在控制台中资源控制频道里的Bucket授权页面授予此Bucket写权限给媒体处理服务。

  • 遵守OSS Bucket定义,更多信息请参见术语表

Location

String

  • 若不指定URL,则此值必填。

  • 否则,此值失效,输出OSS Bucket所在数据中心(OSS Location)。

  • 遵守OSS Location定义,更多信息请参见术语表

Object

String

  • 若不指定URL,则此值必填。

  • 若此值失效,输出文件 (OSS Object)遵循RFC 2396(UTF-8编码,并进行URLEncode,更多信息,请参见URL Encoding说明)。

  • 遵守OSS Object定义,更多信息请参见术语表

MultiBitrateVideoStream详情

参数

类型

是否必选

描述

URI

String

视频流输出名称,必须以.m3u8结尾,示例:a/b/test.m3u8,格式:^[a-z]{1}[a-z0-9./-]+$。

RefActivityName

String

关联的活动名称。

ExtXStreamInfo

Json

码流属性。示例:{"BandWidth": "111110","Audio": "auds","Subtitles": "subs"}

ExtXMedia详情

参数

类型

是否必选

描述

Name

String

必填项,描述,对应于HLS V5协议的NAME,最多64字节,UTF-8。

Language

String

可选项,语言类型,RFC5646,对应于HLS V5协议LANGUAGE。

URI

String

必填,资源路径。

示例:a/b/c/d/audio-1.m3u8,格式:^[a-z]{1}[a-z0-9./-]+$。

MasterPlayList详情

参数

类型

是否必选

描述

MultiBitrateVideoStreams

JsonArray

多码流数组。示例:[{"RefActivityName": "video-1","ExtXStreamInfo": {"BandWidth": “111110”,"Audio":"auds","Subtitles": "subs"}}]

ExtXStreamInfo详情

参数

类型

是否必选

描述

BandWidth

String

带宽。总码率上限,必填项,对应于HLS V5协议的BANDWIDTH。

Audio

String

音频流分组ID。可选,对应于HLS V5协议的AUDIO。

Subtitles

String

字幕流分组ID。可选,对应于HLS V5协议的SUBTITLES。

AdaptationSet详情

参数

类型

是否必选

描述

Group

String

必填,组名,示例如下:

<AdaptationSet group="videostreams" mimeType="video/mp4" par="4096:1744"
              minBandwidth="258157" maxBandwidth="10285391" minWidth="426" maxWidth="4096"
              minHeight="180" maxHeight="1744" segmentAlignment="true"
              startWithSAP="1">

Lang

String

语言。音频和字幕活动时,可填。

Representation详情

参数

类型

是否必选

描述

Id

String

必填,流ID,示例如下:

<Representation id="240p250kbps" frameRate="24" bandwidth="258157"
              codecs="avc1.4d400d" width="426" height="180">

URI

String

必填,资源路径。示例:a/b/c/d/video-1.mpd,格式:^[a-z]{1}[a-z0-9./-]+$。

InputConfig详情

参数

类型

是否必选

描述

Format

String

必填,字幕文件的输入格式。支持 stl、ttml、vtt。

InputFile

String

{"Bucket":"example-bucket-****","Location":"oss-cn-hangzhou","Object":"example-logo****.png"}
              或
              {"URL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/subtitle/test****.chs.vtt"}

VideoCensorConfig详情

名称

类型

必填项

描述

OutputFile

String

视频截图结果的保存地址。

例如:"{"Bucket":"test-bucket-****","Location":"oss-cn-shanghai","Object":"output{Count}.jpg"}"

其中{Count}是占位符,图片Object依次为output00001.jpg,output00002.jpg等。

VideoCensor

String

是否需要审核视频内容,默认为true。

设置为false时,必须确保相同的媒体输入文件之前提交过作业,并且是执行成功状态,否则这次请求会被拒绝。

BizType

String

默认common。定制业务类型。

Scope

String

审核结果范围,包括:

  • abnormal:仅包含审核有问题结果。

  • all:包含所有结果。

默认:abnormal。