本文介绍API接口参数详情。

Input详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Bucket String 输入文件所在OSS Bucket。

需在控制台中资源控制频道里的Bucket授权页面授予此Bucket读权限给媒体处理服务,遵守OSS Bucket定义,见术语表Bucket。

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

遵守OSS Location定义,见术语表Location。

Object String 输入文件 (OSS Object)。

须进行UrlEncode,使用UTF-8编码,遵守OSS Object定义,见术语表Object。

Output详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
OutputObject String 输出的文件名(OSS Object)。
  • 须进行Url Encode,使用UTF-8编码。
  • 占位符替换示例:转码输入文件若为a/b/c.flv,若OutputObject设置为%7BObjectPrefix%7D%7BFileName%7Dtest.mp4,那么转码输出文件名:a/b/ctest.mp4
  • 输出文件名支持占位符替换规则。
    • 工作流支持的占位符:代表输入文件前缀的{ObjectPrefix}、代表输入文件名的{FileName}、代表输入文件扩展名的{ExtName}、代表转码输出文件Md5值 的{DestMd5}、代表转码输出文件平均码率的{DestAvgBitrate},以及代表媒体工作流执行实例ID的{RunId},代表工作流所处理媒体ID的{MediaId}的动态替换。
    • 非工作流支持的占位符:{ObjectPrefix}、{FileName}、{ExtName}、{DestMd5}、{DestAvgBitrate}。
  • 关于文件扩展名规则:
    • 工作流:根据转码模板容器格式自动在OutputObject后边添加扩展名。
    • 非工作流:不会自动添加扩展名,但如果容器类型为m3u8,则媒体处理服务会给Playlist自动添加扩展名 .m3u8 ,分片文件名会在Playlist后自动加一个从00001开始的5位
  • 序列号为后缀并以 - 号相连,文件扩展名为 .ts。
  • 例如:Playlist文件名为filename.m3u8,则输出第一个ts分片文件为filename-00001.ts。
TemplateId String 转码模板ID。

支持自定义转码模板与系统预置模板。

WaterMarks WaterMark[] JSON数组,水印列表,参见 转码水印参数详情。
  • 水印数组大小上限为4,既同一路输出最多支持4个水印。
  • 示例:[{"InputFile":{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example-logo.png"},"WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a126797"}]
Clip String JSON对象,剪辑片段,参见 Clip详情。

示例:{"TimeSpan":{"Seek":"123.45","Duration":"3.45"}}

Rotate String 视频旋转角度。

范围:[0,360),顺时针。

Container String 如设置则覆盖指定转码模版中的对应参数,参见 Container详情。
Video String 如设置则覆盖指定转码模版中的对应参数,参见 Video详情
Audio String 如设置则覆盖指定转码模版中的对应参数,参见Audio详情
AudioStreamMap String 音频流序号。
  • 格式:0:a:{序号},
  • 序号从0开始,
  • 序号的含义是音频流列表的下标,
  • 示例:0:a:0,
  • 若不设置,选择默认的音频流。
TransConfig String 转码流程配置。如设置则覆盖指定转码模版中的对应参数,参见TransConfig详情。
MergeList String 拼接设置。最多支持4个MergeURL,参见拼接参数详情。
  • 单个拼接片段示例:[{"MergeURL":"http://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4"}]
  • 2个拼接片段示例:[{"MergeURL":"http://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4","Start":"1","Duration":"20"},{"MergeURL":"http://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm_02.mp4","Start":"5.4","Duration":"10.2"}]
MergeConfigUrl String MergeList与MergeConfigUrl两个参数只支持二选一。
  • MergeConfigUrl指定的配置文件允许50个拼接片段上限,
  • MergeConfigUrl是拼接配置文件URL地址。
  • 示例:http://jvm.oss-cn-hangzhou.aliyuncs.com/mergeConfigfile
  • 只支持存放在OSS上的配置文件,且需要保证有授权给MPS可访问权限,文件内部内容参见拼接参数详情。
  • mergeConfigfile文件内部内容示例:{"MergeList":[{"MergeURL":"http://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm.mp4"}]}
MuxConfig String 如设置则覆盖指定转码模版中的对应参数,参见MuxConfig详情。
Priority String 任务在其对应管道内的转码优先级。
  • 范围:[1-10],
  • 最高优先级:10
  • 默认值:6
UserData String 用户自定义数据,最大长度1024个字节。
M3U8NonStandardSupport String M3u8非标准支持,JSON对象,参见 M3u8非标参数详情。示例:{"TS":{"Md5Support":true,"SizeSupport":true}}
Encryption String 数据加密,只支持m3u8格式的输出
  • 示例:{"Type":"hls-aes-128","Key":"ZW5jcnlwdGlvbmtleTEyMw","KeyType":"Base64","KeyUri":"aHR0cDovL2FsaXl1bi5jb20vZG9jdW1lbnQvaGxzMTI4LmtleQ=="}
  • 参见Encryption参数详情
SubtitleConfig String JSON对象,字幕配置。
  • 参见SubtitleConfig详情。
  • 示例:{“ExtSubtitleList”:[{“Input”:{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”},“CharEnc”:”UTF-8”}]}
OpeningList String 开板列表。JSON列表。。
  • 参见开板详情。
  • 示例:[{"OpenUrl":"http://test-bucket.oss-cn-hangzhou.aliyuncs.com/opening.flv","Start":"1","Width":"1920","Height":"1080"}]
TailSlateList String 尾板列表,JSON列表
  • 参见尾板详情。
  • 示例:[{"TailUrl":"http://test-bucket.oss-cn-hangzhou.aliyuncs.com/tail.flv","Start":"1","BlendDuration":"2","Width":"1920","Height":"1080","IsMergeAudio":false,"BgColor":"White"}]
DeWatermark String 模糊处理,JSON对象。参见模糊处理详情。
Amix String 混音。

场景如加背景音乐;同一视频,两音轨合并等。

配合AudioStreamMap参数以选择输入视频的音轨做混音。

JSON列表,示例:[{“AmixURL”:“http://test-bucket.oss-cn-hangzhou.aliyuncs.com/audio.mp3",“Map”:“0:a:0”,“MixDurMode”:"longest”}]

Clip详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
TimeSpan String 剪辑时间区间。

参见TimeSpan详情。

ConfigToClipFirstPart Boolean 是否剪辑第一片,
  • false:拼接完后剪辑,默认
  • true:先剪辑第一片后拼接

TimeSpan详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Seek String 开始时间点。
  • 格式:hh:mm:ss[.SSS],
  • 取值范围 :[00:00:00.000,23:59:59.999]

或者,

  • 格式:sssss[.SSS],
  • 取值范围[0.000,86399.999]

示例:01:59:59.999或者32000.23

Duration String 持续时长。
  • 格式:hh:mm:ss[.SSS],
  • 取值范围 :[00:00:00.000,23:59:59.999] ,

或者

  • 格式:sssss[.SSS],
  • 取值范围[0.000,86399.999];

示例:01:00:59.999或者32000.23

End String 截尾时长,表示切掉尾部的若干时长。

设置此值时,参数Duration失效。

  • 格式:hh:mm:ss[.SSS]
  • 取值范围:[00:00:00.000,23:59:59.999]

或者

  • 格式:sssss[.SSS],
  • 取值范围[0.000,86399.999];

示例:01:00:59.999或者32000.23

转码水印参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
WaterMarkTemplateId String 水印模板ID。
若不设置,则使用水印模板的默认配置:
  • 水印位置TopRight,
  • 偏移量Dx、Dy取0,
  • 水印宽为输出分辨率宽的0.12倍,
  • 水印高为相对水印宽的等比缩放。
InputFile String 水印输入文件。
  • 参见InputFile详情,
  • 目前支持png图片、mov文件作为输入。
Width String 若设置,则此值覆盖水印模板对应水印图片宽,值有两种形式:
  • 整数型代水印图片宽的像素值,
    • 范围:[8,4096]
    • 单位:px
  • 小数型代表相对输出视频分辨率宽的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Height String 若设置,则此值覆盖水印模板对应水印图片高,值有两种形式:
  • 整数型代表水印图片高的像素值,
    • 范围:[8,4096],
    • 单位:px;
  • 小数型代表相对输出视频分辨率高的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Dx String 若设置,则此值覆盖水印模板对应参数,水印图片相对输出视频的水平偏移量。

默认值:0

值有两种形式:
  • 整数型代表偏移像素,
    • 范围:[8,4096],
    • 单位:px,
  • 小数型代表水平偏移量与输出分辨率宽的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Dy String 若设置,则此值覆盖水印模板对应参数,水印图片相对输出视频的垂直偏移量。

默认值:0

值有两种形式:
  • 整数型代表偏移像素,
    • 范围:[8,4096],
    • 单位:px,
  • 小数型代表垂直偏移量与输出分辨率高的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
ReferPos String 若设置,则此值覆盖水印模板对应参数,水印的位置。

值范围:TopRight、TopLeft、BottomRight、BottomLeft。

Type String 若设置,则此值覆盖水印模板对应参数。水印类型,Image、Text。
  • Image:图片水印,
  • Text:文字水印,
  • 默认值:Image
说明 若填写Text,则必须填写TextWaterMark字段。
Timeline String 若设置,则此值覆盖水印模板对应参数,动态水印。

参见Timeline详情。

TextWaterMark String JSON对象,文字水印配置,若类型为文字水印,则此配置项不能为空。
  • 参见文字水印参数详情。
  • 示例:{“Content”:”5rWL6K+V5paH5a2X5rC05Y2w”,”Top”:2,”Left”:10}

水印模板配置详情

调用接口请参见新增水印模版

参数 类型 是否必选 描述
Width String 输出视频上水印图片宽。

值有两种形式:

  • 整数型代水印图片宽的像素值,
    • 范围:[8,4096],
    • 单位:px;
  • 小数型代表相对输出视频分辨率宽的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Height String 输出视频上水印图片高,值有两种形式:
  • 整数型代水印图片高的像素值,
    • 范围:[8,4096],单位:px;
  • 小数型代表相对输出视频分辨率高的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Dx String 水印图片相对输出视频的水平偏移量。

默认值:0

值有两种形式:
  • 整数型代表偏移像素,
    • 范围:[8,4096],
    • 单位:px;
  • 小数型代表水平偏移量与输出分辨率宽的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
Dy String 水印图片相对输出视频的垂直偏移量。

默认值:0

值有两种形式:
  • 整数型代表偏移像素,
    • 范围[8,4096],
    • 单位:px;
  • 小数型代表垂直偏移量与输出分辨率高的比率,
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。
ReferPos String 水印的位置。
  • TopRight、TopLeft、BottomRight、BottomLeft
  • 默认值:TopRight
Type String 水印类型,Image、Text。
  • 默认值:Image
  • 模板暂只支持Image类型。
Timeline String 动态水印。

参见Timeline详情。

水印宽、高参数设置说明:

  • 宽、高都不设置时,水印宽取输出视频分辨率宽的0.12倍,水印高按水印原图宽高比例等比缩放;
  • 宽或高设置一边,另一边不设置时,则另一边按水印原图宽高比等比缩放;
  • 宽、高两边都设时,按实际设置值设置水印图片。
水印位置坐标说明:

Container详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Format String 容器格式。
  • 默认值:mp4
  • 视频转码支持flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)
  • 音频转码支持mp3、mp4、ogg、flac、m4a
  • 图片支持gif、WEBP
  • 容器格式为gif时,Video Codec设置只能设置为GIF,
  • 容器格式为webp时,Video Codec设置只能设置为WEBP,
  • 容器格式为flv时,Video Codec不能设置为H.265。

Video详情

调用接口请参见提交转码作业

参数 类型 是否必选 含义 描述
Codec String 编解码格式 支持H.264、H.265、GIF、WEBP。

默认值:H.264

Profile String 编码级别 支持baseline、main、high

默认值:high

  • baseline:适合移动设备,
  • main:适合标准分辨率设备,
  • high:适合高分辨率设备。

最佳实践:如果您有多个清晰度,建议最低清晰度配成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。

说明 目前仅H.264支持此参数。
Bitrate String 视频输出文件的码率
  • 值范围:[10,50000]
  • 单位:Kbps
Crf String 码率-质量控制因子
  • 值范围:[0,51]
  • 默认值:26
说明 如果设置了Crf,则Bitrate的设置失效。
Width String
  • 默认值:视频原始宽度
  • 值范围:[128,4096]
  • 单位:px
Height String
  • 默认值:视频原始高度
  • 值范围:[128,4096]
  • 单位:px
Fps String 帧率
  • 默认值:取输入文件帧率。
  • 当输入文件帧率超过60时取60,。
  • 值范围:(0,60]
  • 单位:fps
Gop String 关键帧间最大时间间隔或者最大帧数 最大时间间隔时,必传单位s。
  • 默认值:10s
  • 最大帧数时,无单位,
  • 值范围:[1,100000]
Preset String 视频算法器预置 支持veryfast、fast、medium、slow、slower。

默认值:medium

说明 目前仅H.264支持此参数。
ScanMode String 扫描模式 支持interlaced、progressive。
Bufsize String 缓冲区大小
  • 值范围:[1000,128000]
  • 默认值:6000
  • 单位:Kb
Maxrate String 视频码率峰值 值范围[10,50000],单位Kbps。
PixFmt String 视频颜色格式 范围yuv420p,yuvj420p等标准颜色格式。

默认值:yuv420p或原始颜色格式。

Remove String 是否删除视频流
  • true表示删除,
  • false表示保留,
  • 默认值:false
Crop String 视频画面裁切 支持2种方式。
  • 自动检测黑边并裁切,设置为“border”
  • 自定义裁切,参数格式:width:height:left:top。

    示例:1280:800:0:140

Pad String 视频贴黑边 参数格式:width:height:left:top。

示例:1280:800:0:140

LongShortMode String 是否开启横竖屏自适应(即:长短边模式)
  • 转码输出的宽对应输入片源的长边(竖屏为片源的高),
  • 高对应输入视频的短边(竖屏为片源的宽),
  • true表示开启,
  • false表示关闭,

默认值:false

以下表格显示视频转码编解码格式与容器格式的组合支持情况:
Container Audio Codecs Video Codecs
flv AAC、MP3 H.264
mp4 AAC、MP3 H.264、H.265
ts AAC、MP3 H.264、H.265
m3u8 AAC、MP3 H.264、H.265
gif 不支持 GIF
以下表格显示视频编解码格式与视频流配置参数的组合支持情况:
Video/Codec H.264 H.265 GIF
Profile Y N N
Bitrate Y Y N
Crf Y Y N
Width Y Y Y
Height Y Y Y
Fps Y Y Y
Gop Y Y N
Preset Y N N
ScanMode Y Y Y
Bufsize Y Y N
Maxrate Y Y N
PixFmt Y Y bgr8

Audio详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Codec String 音频编解码格式,AAC、MP3、VORBIS、FLAC。

默认值:AAC

Profile String 音频编码预置。

当Codec为 AAC时,范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。

Samplerate String 采样率。
  • 默认值:44100
  • 支持22050、32000、44100、48000、96000,
  • 单位:Hz
说明
  • 若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000;
  • 音频编解码格式为mp3时,采样率不支持96000。
Bitrate String 输出文件的音频码率。
  • 值范围:[8,1000],
  • 单位:Kbps
  • 默认值:128
Channels String 声道数。

默认值:2

说明
  • 当Codec设置为 mp3 时,声道数只支持1、2;
当Codec设置为 aac 时,声道数只支持1、2、4、5、6、8。
Remove String 是否删除音频流。
  • true表示删除,
  • false表示保留,
  • 默认值:false
Volume String 音量控制,参见Volume音量控制详情
以下表格显示音频转码编解码格式与容器格式的组合支持情况:
Container Audio Codecs
mp3 MP3
mp4 AAC
ogg VORBIS、FLAC
flac FLAC

SnapshotConfig参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Format String 截图数据类型。
  • 默认值:空
  • 可指定vtt表示输出webvtt。
BlackLevel String 多帧截图针对首帧过滤黑屏图片判定阀值。
  • 默认值:空
  • 取值范围:[30,100]

值越小,图片黑色像素的占比越小。

  • Time>0 ,参数设置无效,放弃过滤黑屏功能;
  • Time =0 ,Num>1,参数有效,且只作用于第一张图,只检测开始5秒数据,如果没有非黑屏图片,依旧返回第一帧黑屏图片;
  • Time =0 ,Num=1,强制过滤黑屏,参数无效。

如果需要首帧图片过滤纯黑屏,建议参数值设置成100。

使用示例:Time=0&Num=10 需要对首图做纯黑屏过滤,则设置BlackLevel= 100。

PixelBlackThreshold String 判断像素点是否为黑色点的阈值。
  • 取值范围:[0,255]
  • 例如:PixelBlackThreshold=70,即像素点颜色值小于70的都认为是黑点。
说明
  1. 该参数可配合BlackLevel参数来调整黑屏过滤效果。
  2. 设置PixelBlackThreshold参数取值来调整像素点为黑点的判定范围。
例如:PixelBlackThreshold=50,能过滤黑屏效果不明显,则可以相应的调整取值为PixelBlackThreshold=100来扩大黑点判定范围。
OutputFile String 输出文件定义,JSON对象。

参见截图OutputFile详情。

TileOutputFile String 输出文件定义,JSON对象,结构同OutputFile。
  • 截图输出文件格式为jpg,若使用异步模式序列拼图且Num不等于1,则TileOutputFile的Object必须包含{TileCount},用于区分序列截图多张输出图片的输出地址,如序列截图输出3张图片,TileOutputFile的Object为{TileCount}.jpg,则输出图片Object依次为00001.jpg,00002.jpg,00003.jpg。
  • 此参数在拼图配置必填,TileOutputFile代表最终拼成的大图地址。
Time String 截图时间。

单位:毫秒

Interval String 截图间隔时间。
  • 若指定则表示异步模式序列截图,Interval必须大于等于0。
  • 默认值:10
  • 单位:秒
  • 其中Interval=0表示根据视频时长平均截图。
Num String 截图数量。

若指定则表示异步模式序列截图,且必须大于0。

  • 当Time+Interval*Num的截取点超过视频时长时,后续截图自动失效,截图完成时返回实际截取的个数,
  • 当Num=1,忽略Interval参数,表示异步单张截图。
Width String 截图输出图片宽度。
  • 单位:px
  • 范围:[8,4096]
Height String 截图输出图片高度。
  • 单位:px
  • 范围:[8,4096]
FrameType String 截图类型。
  • 普通帧:normal
  • I帧:intra
默认值:intra
TileOut String 拼图配置。JSON对象。

参见TileOut拼图配置详情。

SubOut String Webvtt拼图配置,JSON对象。

参见SubOut拼图配置。

Segment详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Duration String 分片时长。
  • 整数值
  • 单位:秒
  • 范围:[1,60]

默认值:10秒

ForceSegTime String 指定分片时间列表,逗号分隔,最多可指定10个分片时间点。
  • 小数型,支持3位小数
  • 单位:秒
  • 示例:23、55、60 代表在23,55,60秒处分片

TransConfig详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
TransMode String 转码模式。
  • 默认值:onepass
  • 可选范围onepass、twopass、CBR。
AdjDarMethod String 分辨率改写方式。
  • 默认值:none
  • 可选范围rescale、crop、pad、none。
IsCheckReso String 是否检查分辨率。
  • 如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。true表示检查,
  • false表示不检查,
  • 默认值:false
IsCheckResoFail String 是否检查分辨率。
  • 如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。
  • true表示检查,
  • false表示不检查,
  • 默认值:false
IsCheckVideoBitrate String 是否检查视频码率。
  • 如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。
  • true表示检查,
  • false表示不检查,
  • 默认值:false
IsCheckAudioBitrate String 是否检查音频码率。
  • 如果音频输出码率大于音频输入码率,则音频输出码率等于音频输入码率。
  • true表示检查,
  • false表示不检查,
  • 默认值:false
IsCheckAudioBitrateFail String 当输出音频码率大于媒体源音频码率时,
  • true表示不进行转码,
  • false表示不检查,
  • 默认值:false,
  • 此值优先级大于IsCheckAudioBitrate。
IsCheckVideoBitrateFail String 当输出视频码率大于媒体源视频码率时,
  • true表示不进行转码,
  • false表示不检查,
  • 默认值:false,
  • 此值优先级大于IsCheckVideoBitrate。
AdjDarMethod参数位置说明:

MuxConfig详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Segment String JSON对象,切片配置字段。
  • 参见Segment详情。
  • 示例:{"Duration":"34"}

NotifyConfig详情

调用接口请参见更新管道

参数 类型 是否必选 描述
QueueName String 阿里云消息服务中创建的队列。
  • 媒体处理服务支持在管道上绑定队列,则该管道上的作业执行结束时会将执行结果发送到该队列;
  • 获取队列中的消息参见 队列消息操作
  • 管道上设置队列时,请您在 消息服务 中预先创建队列。
Topic String 阿里云消息服务中创建的主题。
  • 媒体处理服务支持在管道上绑定主题,则该管道上的作业执行结束时会将执行结果发送到该主题;
  • 主题会将执行结果以消息形式推送到订阅的地址上;
  • 消息管道上设置主题时,请预先在 消息服务中预先创建主题。
说明 该功能目前公测中。

转码作业输入详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Bucket String 输入文件所在OSS Bucket。
  • 需在控制台中资源控制频道里的Bucket授权页面授予此Bucket读权限给媒体处理服务。
  • 遵守OSS Bucket定义,见术语表Bucket。
Location String 输入OSS Bucket所在数据中心(OSS Location)。

遵守OSS Location定义,见术语表Location。

Object String 输入文件 (OSS Object)。
  • 须进行UrlEncode,使用UTF-8编码,
  • 遵守OSS Object定义,见术语表Object。
Audio String 源媒体文件的音频配置,JSON对象。
说明 当输入文件为ADPCM、PCM格式时此参数为必填项。
  • 参见InputAudio详情,
  • 示例:{"Channels":"2","Samplerate":"44100"}
Container String 源媒体文件容器配置,JSON对象。
说明 当输入文件为ADPCM、PCM格式时此参数为必填项。
  • 参见InputContainer详情。
  • 示例:{"Format":"u8"}

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对象。

参见 QualityControl详情

PropertiesControl String 属性控制,JSON对象。

参见PropertiesControl详情

QualityControl详情

调用接口请参见提交模板分析作业

参数 类型 是否必选 描述
RateQuality String 输出质量等级。
  • 值范围:(0,51],
  • 值为整数,
  • 默认值:25
MethodStreaming String 播放方式,network或local。

默认值:network

PropertiesControl详情

调用接口请参见提交模板分析作业

参数 类型 是否必选 描述
Deinterlace String 强制扫描模式判定。
  • Auto:自动,
  • Force:强制做deinterlace,
  • None:强制不做。
Crop String 视频裁切配置。
  • 默认:自动
  • 如此值不是空JOSN{},则它的属性Mode必填。
  • 参见Crop详情。

Crop详情

调用接口请参见提交模板分析作业

参数 类型 是否必选 描述
Mode String 取值:
  • Auto:自动,
  • Force:强制,
  • None:强制不做,

如Crop不是空JOSN{},则此值必填。

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。
  • 参见拼接参数详情。
  • 示例:[{“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"}]

拼接参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
MergeURL String 拼接片段地址。
Start String 起始时间点。
  • 格式:hh:mm:ss[.SSS]或者sssss[.SSS],
  • 示例:01:59:59.999或者32000.23
Duration String 持续时间。
  • 格式:hh:mm:ss[.SSS]或者sssss[.SSS],
  • 示例:01:59:59.999或者32000.23

作业输出文件详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
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定义,见术语表Bucket。
Location String
  • 若不制定URL,则此值必填;
  • 否则,此值失效,输出OSS Bucket所在数据中心(OSS Location)。
  • 遵守OSS Location定义,见术语表Location
Object String
  • 若不制定URL,则此值必填;
  • 否则,此值失效,输出文件 (OSS Object)须进行UrlEncode,使用UTF-8编码。
  • 遵守OSS Object定义,见术语表Object。

M3u8非标准参数支持详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
TS String JSON对象,TS文件相关非标准支持。

参见TS参数支持详情。

TS参数支持详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Md5Support Boolean 是否支持在m3u8文件中输出ts的md5值。
SizeSupport Boolean 是否支持在m3u8文件中输出ts文件的大小。

Timeline参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Start String 水印开始出现时间。
  • 单位:秒,
  • 取值范围:数字,
  • 默认值:0
Duration String 水印持续时间。
  • 取值范围:[数字,ToEND]
  • 默认值:ToEND

Encryption参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Type String 取值:hls-aes-128
Key String 加密视频的密钥。
  • 需加密,方式见KeyType。
  • 如密钥为”encryptionkey128”, 则Base64(“encryptionkey128”), 或 KMS(Base64(“encryptionkey128”)
KeyUri String 密钥的访问url,使用BASE64进行编码。
KeyType String 密钥Key不能明文传输给MPS,需要加密,方式为 Base64 或 KMS 如使用KMS。
说明 请您联系我们,我们提供主密钥,Base64为基础加密方式,KMS方式是在基础方式上,又使用KMS进行加密。

SubtitleConfig详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
ExtSubtitleList ExtSubtitle[] JSON数组,最多4个,外部字幕列表。
  • 参见ExtSubtitle。
  • 示例:[{“Input”:{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”},“CharEnc”:”UTF-8”}]

ExtSubtitle详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Input String JSON对象,外部输入字幕文件。
  • 目前支持srt、ass格式,
  • 参见 Input详情,
  • 示例:{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}
说明
  • 目前支持{ObjectPrefix}、{FileName}、{ExtName}动态替换。
  • 示例:转码输入文件Object:a/b/c/test.flv,
  • 字幕文件用动态规则可表示为:{ObjectPrefix}{FileName}-cn.srt,需经URLEncode,Object设置为:%7bObjectPrefix%7d%7bFileName%7d-cn.srt。那么MPS会认为外挂字幕文件地址为:a/b/c/test-cn.srt
CharEnc String 外部字幕字符编码。
  • 范围:UTF-8、GBK、BIG5、auto,
  • 默认:auto,
说明 外部字幕字符编码设置为auto时,存在误检情况,建议您指定具体的字符编码。

Opening详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
OpenUrl String 开板视频的OSS URL地址。
Start String 相对正片视频的开始时间。
  • 从0开始延迟多长时间后,显示开板视频。
  • 单位:秒,
  • 默认值:0
Width String 宽。
  • 范围:(0,4096)
  • -1、full
    • -1代表片源的值,
    • full表示填满画面。
  • 默认为:-1
Height String 高。
  • 范围:(0,4096)
  • -1、full,
    • -1代表片源的值,
    • full表示填满画面。
  • 默认为:-1

TailSlate详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
TailUrl String 尾板视频的OSS URL地址
BlendDuration String 正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认0。
Width String 宽,范围(0,4096)、-1、full,-1代表片源的值,full表示填满画面。默认为-1
Height String 高,范围(0,4096)、-1、full,-1代表片源的值,full表示填满画面。默认为-1
IsMergeAudio Boolean 是否要拼接尾板视频的音频内容,默认为true
BgColor String 如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为White,取值见bgcolor

文字水印参数详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Content String 文字水印内容,内容需做Base64编码。

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

FontName String 默认:“SimSun”。

参见 支持的字体

FontSize Int 字体大小。
  • 默认值:16
  • 范围:(4, 120)
FontColor String 字体颜色。

取值参见FontColor

FontAlpha Int 字体透明度。
  • 范围:(0, 1],
  • 默认:1.0
Top Int 文本上边距。
  • 默认:0
  • 范围:[0,4096]
Left Int 文本左边距。
  • 默认:0
  • 范围:[0,4096]
BorderWidth Int 描边宽度。
  • 默认:0
  • 范围:(0,4096]
BorderColor String 描边颜色。

截图OutputFile详情

调用接口请参见提交截图作业

参数 类型 是否必选 描述
Bucket String 截图输出文件所在OSS Bucket。

遵守OSS Bucket定义,见术语表Bucket。

Location String 截图输出OSS Bucket所在数据中心(OSS Location)。

遵守OSS Location定义,见术语表Location。

Object String 截图输出文件 (OSS Object)。
  • 截图输出文件格式为jpg,输出文件名须进行UrlEncode,使用UTF-8编码。
占位符替换示例:截图输入文件若为a/b/c.flv,若Object设置为%7BObjectPrefix%7D%7BFileName%7D%7BCount%7D.jpg,那么批量截图输出文件名:a/b/c00001.jpg,a/b/c00002.jpg…
截图输出文件名支持占位符替换
  • 工作流支持的占位符:代表输入文件前缀的{ObjectPrefix}、代表输入文件名的{FileName}、代表输入文件扩展名的{ExtName}、代表截图时间点的{SnapshotTime}、代表批量截图第几张的{Count}、以及代表媒体工作流执行实例ID的{RunId}、代表工作流所处理媒体ID的{MediaId}的动态替换。
  • 非工作流支持的占位符:代表输入文件前缀的{ObjectPrefix}、代表输入文件名的{FileName}、代表输入文件扩展名的{ExtName}、代表截图时间点的{SnapshotTime}、代表批量截图第几张的{Count}

批量截图说明:若使用异步模式序列截图且Num不等于1,则OutputFile的Object必须包含%7BCount%7D,用于区分序列截图多张输出图片的输出地址,如序列截图输出3张图片,OutputFile的Object为%7BCount%7D.jpg,则输出图片Object依次为00001.jpg,00002.jpg,00003.jpg。

TileOut拼图配置详情

调用接口请参见提交截图作业

参数 类型 是否必选 描述
Lines String 图片拼合行数。
  • 整型,
  • 取值范围:(0,10000],
  • 默认:10
Columns String 图片拼合列数。
  • 整型,
  • 取值范围:(0,10000],
  • 默认:10
CellWidth String 单图片宽度。

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

CellHeight String 单图片高度。

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

Margin String 外框宽度。
  • 默认:0
  • 单位:px
Padding String 图片间距,默认0,单位px
Color String 背景颜色。
  • 取值范围:颜色关键字,random,
  • 默认:black,
  • 其中颜色关键字支持三种格式,比如黑色,支持Black,black,#000000
IsKeepCellPic String 是否保留单图片。
  • 取值范围:true、false,
  • 默认:true

MultiBitrateVideoStream详情

调用接口请参见新增媒体工作流

参数 类型 是否必选 描述
URI String 视频流输出名称,必须以.m3u8结尾,示例:a/b/test.m3u8,格式:^[a-z]{1}[a-z0-9./-]+$

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 多码流数组。
  • 参见MultiBitrateVideoStream详情
示例:[{“RefActivityName”: “video-1”,”ExtXStreamInfo”: {“BandWidth”: “111110”,”Audio”: “auds”,”Subtitles”: “subs” }}]

MultiBitrateVideoStream详情

调用接口请参见新增媒体工作流

参数 类型 是否必选 描述
RefActivityName String 关联的活动名称
ExtXStreamInfo Json 码流属性。
  • 参见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。

SubOut Webvtt拼图配置详情

调用接口请参见提交截图作业

参数 类型 是否必选 描述
IsSptFrag String 图片是否拼合输出。
  • true表示拼合输出,
  • 默认:false

模糊处理详情

JSON对象:
{
        "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
            }
        ]
    }
                
pts:字符,指对象帧的时间戳。单位:毫秒(ms)。
  • L:数字,指模糊处理区域的左边距。
  • T:数字,指模糊处理区域的上边距。
  • W:数字,指模糊处理区域的宽度。
  • H:数字,指模糊处理区域的高度。

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

以上demo中,三个pts(0,128000,250000)对应的描述信息为:
  • 0ms开始,对距离视频画面左上角10✖️10像素处,大小为10✖️10像素的Logo,以及距离左边距100像素,上边距0.1✖️(src_height)的位置10✖️10的Logo进行模糊处理。
  • 128000ms处,表示停止对Logo进行模糊处理,即,[0~128000]为对Logo进行模糊处理的时间段。
  • 250000ms开始,在左边距0.2✖️(src_width)、上边距0.1✖️(src_height)处,对大小为宽0.01✖️(src_width),高0.05✖️(src_height)的Logo进行模糊处理。

AdaptationSet详情

调用接口请参见新增媒体工作流

参数 类型 是否必选 描述
Group String 必填,组名,如dash文件中的
<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,如dash文件中的
<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://bucketname.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。

Volume音量控制详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
Method String 音量调整方式。

可选值为auto, dynamic, linear。

IntegratedLoudnessTarget String 目标音量,数字。
  • 取值范围:[-70, -5]
  • 需指定Method为dynamic。
  • 默认值:-6
TruePeak String 最大峰值,数字。
  • 取值范围:[-9, 0]
  • 需指定Method为dynameic。
  • 默认值:-1
LoudnessRangeTarget String 音量范围,数字。
  • 取值范围:[1, 20]
  • 需指定Method为dynamic。
  • 默认值:8

Amix混音详情

调用接口请参见提交转码作业

参数 类型 是否必选 描述
AmixURL String 需要被混音的背景音轨媒体。

取值为:OSS地址或字符串"input"。

input场景:同一视频两路音轨合并。

Map String 在AmixURL中选取目标音轨,取值为:0:a:{audio_index}, 如0:a:0。
MixDurMode String 取值:first、longest。
  • first:意为输出媒体的时长以输入媒体的时长为准,
  • longest:意为输出媒体的时长以两个媒体中时长最长的为准
  • 默认为:longest