阅读411 返回首页    go 阿里云

参数详情__附录_API使用手册_媒体转码-阿里云

1 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

2 Output详情

名称 类型 必填项 描述
OutputObject String 是 输出的文件名（OSS Object），须进行Url Encode，使用UTF-8编码。如果容器类型为m3u8，则媒体转码服务会给Playlist自动添加扩展名 .m3u8 ，分片文件名会在Playlist后自动加一个从00001开始的5位序列号为后缀并以 - 号相连，文件扩展名为 .ts。
例如：Playlist文件名为filename.m3u8，则输出第一个ts分片文件为filename-00001.ts。
TemplateId String 是 转码模板ID，支持自定义转码模板与系统预置模板。
WaterMarks WaterMark[] 否 JSON数组，水印列表，请参照5 转码水印参数详情，水印数组大小上限为4，既同一路输出最多支持4个水印，示例：
[{
"InputFile":{
"Bucket":"example-bucket",
"Location":"oss-cn-hangzhou",
"Object":"example-logo.png"
},
"WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a126797"
}]
Clip String 否 JSON对象，剪辑片段，请参照3 Clip详情，示例：
{
"TimeSpan":{
"Seek":"123.45",
"Duration":"3.45"
}
}
Rotate String 否 视频旋转角度，范围[0,360)，顺时针。
Container String 否 如设置则覆盖指定转码模版中的对应参数，参考7 Container详情。
Video String 否 如设置则覆盖指定转码模版中的对应参数,参考8 Video详情。
Audio String 否 如设置则覆盖指定转码模版中的对应参数，参考10 Audio详情。
TransConfig String 否 转码流程配置，如设置则覆盖指定转码模版中的对应参数，参考16 TransConfig详情。
MergeList String 否 拼接设置，最多支持4个MergeURL，示例：
{
"MergeList":[{"MergeURL":"https://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm.mp4"}]
}
MuxConfig String 否 如设置则覆盖指定转码模版中的对应参数，参考17 MuxConfig详情。
Priority String 否 任务在其对应管道内的转码优先级，范围[1-10]，默认6，最高优先级为10。
UserData String 否 用户自定义数据，最大长度1024个字节。

3 Clip详情

名称 类型 必填项 描述
TimeSpan String 否 剪辑时间区间，请参照4 TimeSpan详情

4 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

5 转码水印参数详情

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

6 水印模板配置详情

名称 类型 必填项 描述
Width String 否 输出视频上水印图片宽，值有两种形式：整数型代水印图片宽的像素值，范围[8,4096]，单位px；小数型代表相对输出视频分辨率宽的比率，范围(0,1),支持4位小数，如0.9999，超出部分系统自动丢弃。
Height String 否 输出视频上水印图片高，值有两种形式：整数型代水印图片宽的像素值，范围[8,4096]，单位px；小数型代表相对输出视频分辨率高的比率，范围(0,1),支持4位小数，如0.9999，超出部分系统自动丢弃。
Dx String 否 水印图片相对输出视频的水平偏移量，默认值是0；值有两种形式：整数型代表偏移像素，范围[-4096,4096]，单位px；小数型代表水平偏移量与输出分辨率宽的比率，范围(-1,1),支持4位小数，如0.9999，超出部分系统自动丢弃。
Dy String 否 水印图片相对输出视频的垂直偏移量，默认值是0；值有两种形式：整数型代表偏移像素，范围[-4096,4096]，单位px；小数型代表垂直偏移量与输出分辨率高的比率，范围(-1,1),支持4位小数，如0.9999，超出部分系统自动丢弃。
ReferPos String 否 水印的位置，TopRight、TopLeft、BottomRight、BottomLeft，默认值TopRight。
Type String 否 水印类型，Image、Text，默认值为Image，目前仅支持Image。

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

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

水印位置坐标说明：

水印位置

7 Container详情

名称 类型 必填项 描述
Format String 否 容器格式，默认值为mp4；视频转码支持flv、mp4、ts、m3u8、gif；音频转码支持mp3、mp4、ogg、flac；
容器格式为 gif 时，Video Codec设置只能设置为GIF；
容器格式为 flv 时，Video Codec不能设置为H.265

8 Video详情

名称 类型 必填项 描述
Codec String 否 编解码格式，支持H.264、H.265、GIF，默认值H.264。
Profile String 否 编码级别，支持baseline、main、high，默认值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 否 关键帧间最大帧数，值范围[1,100000]，默认值250。
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。
BitrateBnd String 否 视频码率范围，JSON对象字符串，见BitrateBnd详情。
目前仅H.264支持此参数
PixFmt String 否 视频颜色格式，范围yuv420p, yuvj420p等标准颜色格式，默认值yuv420p或原始颜色格式。
Remove String 否 是否删除视频流，true表示删除，false表示保留，默认值false
Crop String 否 视频画面裁切，支持2种方式。 1）自动检测黑边并裁切，设置为”border” 2）自定义裁切，参数格式：width:height:left:top。 示例：1280:800:0:140
Pad String 否 视频贴黑边。参数格式：width:height:left:top。 示例：1280:800:0:140

以下表格显示视频转码编解码格式与容器格式的组合支持情况：

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
BitrateBnd Y N N
PixFmt Y Y bgr8

9 BitrateBnd详情

名称 类型 必填项 描述
Max String 否 总码率上限，[10,50000]，单位Kbps。
Min String 否 总码率下限，[10,50000]，单位Kbps。

10 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],默认值128，单位Kbps。
Channels String 否 声道数，默认值是2；当Codec设置为 mp3 时，声道数只支持1、2;当Codec设置为 aac 时，声道数只支持1、2、4、5、6、8
Remove String 否 是否删除音频流，true表示删除，false表示保留，默认值false

以下表格显示音频转码编解码格式与容器格式的组合支持情况：

Container Audio Codecs
mp3 MP3
mp4 AAC
ogg VORBIS、FLAC
flac FLAC

音频转码为公测阶段，声道数仅支持1、2。

11 SnapshotConfig参数详情

名称 类型 必填项 描述
OutputFile String 是 输出文件定义，JSON对象，见OutputFile详情，截图输出文件格式为jpg,若使用异步模式序列截图且Num不等于1，则OutputFile的Object必须包含{Count}，用于区分序列截图多张输出图片的输出地址，如序列截图输出3张图片，OutputFile的Object为{Count}.jpg，则输出图片Object依次为00001.jpg，00002.jpg，00003.jpg
Time String 是 截图时间，单位毫秒
Interval String 否 截图间隔时间，若指定则表示异步模式序列截图，且值必须大于0，默认10，单位秒
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

14 Segment详情

名称 类型 必填项 描述
Duration String 否 分片时长，整数值，单位：秒，范围[1,60]。

16 TransConfig详情

名称 类型 必填项 描述
TransMode String 否 转码模式，默认值onepass，可选范围onepass、twopass、CBR。
IsCheckReso String 否 是否检查分辨率，如果输出分辨率大于输入分辨率，则输出分辨率等于输入分辨率。true表示检查，false表示不检查，默认值false。
IsCheckResoFail String 否 是否检查分辨率，如果输出分辨率大于输入分辨率，则返回转码失败。true表示检查，false表示不检查，默认值false
IsCheckVideoBitrate String 否 是否检查视频码率，如果视频输出码率大于视频输入码率，则视频输出码率等于视频输入码率。true表示检查，false表示不检查，默认值false
IsCheckAudioBitrate String 否 是否检查音频码率，如果音频输出码率大于音频输入码率，则音频输出码率等于音频输入码率。true表示检查，false表示不检查，默认值false

17 MuxConfig详情

名称 类型 必填项 描述
Segment String 否 JSON对象，切片配置字段，详见14 Segment详情，示例：
{
"Duration":"34"
}

18 NotifyConfig详情

名称 类型 必填项 描述
Queue String 否 阿里云消息服务中创建的队列；媒体转码服务支持在管道上绑定队列，则该管道上的作业执行结束时会将执行结果发送到该队列；获取队列中的消息参见队列消息操作；管道上设置队列时，请在消息服务中预先创建队列。
Topic String 否 阿里云消息服务中创建的主题；媒体转码服务支持在管道上绑定主题，则该管道上的作业执行结束时会将执行结果发送到该主题；主题会将执行结果以消息形式推送到订阅的地址上；消息管道上设置主题时，请预先在消息服务中预先创建主题；该功能目前公测中。

19 转码作业输入详情

名称 类型 必填项 描述
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格式时此参数为必填项，详见21 InputAudio详情，示例
{
"Channels":"2",
"Samplerate":"44100"
}
Container String 否 源媒体文件容器配置，JSON对象，当输入文件为ADPCM、PCM格式时此参数为必填项，详见20 InputContainer详情，示例
{
"Format":"u8"
}

20 InputContainer详情

名称 类型 必填项 描述
Format String 是 源媒体音频格式，取值为alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le, s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, u8

21 InputAudio详情

名称 类型 必填项 描述
Channels String 是 源媒体音频声道数,范围[1,8]
Samplerate String 是 源媒体音频采样率，取值为(0, 320000], 单位Hz

22 AnalysisConfig详情

名称 类型 必填项 描述
QualityControl String 否 输出质量控制，JSON对象，见23 QualityControl详情
PropertiesControl String 否 属性控制，JSON对象，见24 PropertiesControl详情

23 QualityControl详情

名称 类型 必填项 描述
RateQuality String 否 输出质量等级，值范围(0,51]，值为整数，默认值25
MethodStreaming String 否 播放方式，network或local，默认值network

24 PropertiesControl详情

名称 类型 必填项 描述
Deinterlace String 否 强制扫描模式判定，
Auto:自动;
Force:强制做deinterlace;None:强制不做
Crop String 否 视频裁切配置,默认：自动 如此值不是空JOSN{}，则它的属性Mode必填.详情25

25 Crop详情

名称 类型 必填项 描述
Mode String 否 取值 Auto:自动; Force:强制; None:强制不做，如Crop不是空JOSN{}，则此值必填
Width Integer 否 裁切后宽，范围[8, 4096]，如MODE为Aut、None,此值失效
Height Integer 否 裁切后高，范围[8, 4096]，如MODE为Auto、None,此值失效
Top Integer 否 裁切上边距，范围[8, 4096]，如MODE为Auto、None,此值失效
Left Integer 否 裁切左边距，范围[8, 4096]，如MODE为Auto、None,此值失效

26 TransFeatures详情

名称 类型 必填项 描述
MergeList String 否 视频拼接配置字段，JSON数组，最多支持4个MergeURL。详见27 拼接参数详情，示例：[{“MergeURL”:”https://example-bucket.oss-cn-hangzhou.aliyuncs.com/k/mp4.mp4"},{"MergeURL":"https://example-bucket.oss-cn-hangzhou.aliyuncs.com/c/ts.ts","Start":"1:14","Duration":"29"}]

27 拼接参数详情

名称 类型 必填项 描述
MergeURL String 是 拼接片段地址，示例：https://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv，Object需要经过url encode，采用utf-8编码
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

28 作业输出文件详情

名称 类型 必填项 描述
URL String 否 输入文件的OSS URL，如https://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

最后更新：2016-11-24 11:23:48

  上一篇：go 删除水印模板__水印模板接口_API使用手册_媒体转码-阿里云
  下一篇：go 格式支持__附录_API使用手册_媒体转码-阿里云