AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 智能媒体管理 开发参考 API参考（2020-09-30） 数据结构 TargetVideo

TargetVideo

更新时间：
产品详情
我的收藏
重要

本文中含有需要您注意的重要提示信息，忽略该信息可能对您的业务造成影响，请务必仔细阅读。

名称类型描述示例值
object

视频处理参数配置。

DisableVideoboolean

是否禁用视频流生成，取值范围如下：

  • true：禁用，输出文件中将不包含视频流。
  • false（默认）：不禁用。
false
TranscodeVideoobject

视频转码参数，空值表示禁用视频处理，输出文件中将不包含视频流。

说明 不推荐通过将该参数设为空值来禁用视频处理。
FrameRatefloat

视频帧率，默认与源视频一致。

25
FrameRateOptionstring

帧率选项。取值范围如下：

  • fixed：始终使用设置的目标视频帧率。
  • adaptive：源视频帧率小于设置的目标视频帧率时使用源视频帧率。
  • fall：源视频帧率小于设置的目标视频帧率时返回失败。

默认值：

  • 当 API 为 CreateMediaConvert 时，默认值为 fixed。
  • 当 API 为 GenerateVideoPlaylist 时，默认值为 adaptive。
说明 该参数需要与参数 FrameRate 一同设置。
fixed
Refsinteger

参考帧的数量，默认值为 2。

2
ScaleTypestring

缩放模式。取值范围如下：

  • stretch（默认）：固定宽高或长短边，强制缩放，拉伸以填满空白部分。
  • crop：等比缩放，缩放为延伸出指定宽高或长短边的矩形框外的最小分辨率，然后将超出的部分进行居中裁剪。
  • fill：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率，然后使用黑色居中填充空白部分。
  • fit：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率。
说明 该参数需要与参数 Resolution 一同设置。
crop
ResolutionOptionstring

分辨率选项。取值范围如下：

  • fixed：始终使用设置的目标视频分辨率。
  • adaptive：源视频分辨率面积小于设置的目标视频分辨率面积时使用源视频分辨率。
  • fall：源视频分辨率面积小于设置的目标视频分辨率面积时返回失败。

默认值：

  • 当 API 为 CreateMediaConvert 时，默认值为 fixed。
  • 当 API 为 GenerateVideoPlaylist 时，默认值为 adaptive。
说明 该参数需要与参数 Resolution 一同设置。
fixed
BFramesinteger

连续 B 帧的数量，默认值为 3。

3
Rotationinteger

视频顺时针旋转的度数。取值范围如下：

  • 0（默认）
  • 90
  • 180
  • 270
90
Bitrateinteger

视频流码率，单位为比特每秒（bit/s），

说明 该参数与 CRF 互斥，若该参数与参数 CRF 都为空值则按照参数 CRF 为 23 进行编码。
128000
BufferSizeinteger

动态码率下解码缓存大小，单位为比特每秒（bps）。

说明 该参数需要与参数 CRF 一起使用才有效。
4000000
Codecstring

视频编码格式。取值范围如下：

  • API 为 CreateMediaConvert 时：copy（默认），h264，h265，vp9。
    警告 当该参数为 copy 时，表示将需要处理的视频流直接拷贝到输出文件，此时 TranscodeVideo 下的其余参数无效。copy 不可用于视频拼接，通常应用于转封装场景。
  • API 为 GenerateVideoPlaylist 时：h264（默认），h265。
h264
CRFfloat

指定恒定质量模式。与参数 Bitrate 互斥，取值范围为[0,51]，数值越大画质越差，建议取值范围为[18,38]。

18
BitrateOptionstring

视频码率选项。取值范围如下：

  • fixed：始终使用设置的目标视频码率。
  • adaptive：源视频码率小于设置的目标视频码率时使用源视频码率。
  • fall：源视频码率小于设置的目标视频码率时返回失败。

默认值：

  • API 为 CreateMediaConvert 时，默认值为 fixed。
  • API 为 GenerateVideoPlaylist 时，默认值为 adaptive。
说明 该参数需要与参数 Bitrate 一同设置。
fixed
PixelFormatstring

像素格式，默认与源视频一致。取值范围如下：

  • yuv420p
  • yuv422p
  • yuv444p
  • yuv420p10le
  • yuv422p10le
  • yuv444p10le
  • yuva420p
说明 yuva420p 仅在 API 为 CreateMediaConvert 时可用，且参数 Codec 必须为 vp9。
yuv420p
AdaptiveResolutionDirectionboolean

是否开启长短边自适应。取值范围如下：

  • true（默认）：是，此时参数 Resolution 的格式为长边×短边。
  • false：否，此时参数 Resolution 的格式为宽×高。
true
MaxBitrateinteger

动态码率下限定最大码率。使用该参数时，必须指定参数 BufferSize。

说明 该参数需要与参数 CRF 一起使用才有效。
128000
GOPSizeinteger

关键帧间隔帧数，默认值为 150。

说明 API 为 GenerateVideoPlaylist 时不支持该参数。
60
Resolutionstring

输出视频的分辨率，格式为宽 x 高，默认与源视频播放分辨率一致。支持同时配置宽高或单独配置宽或高，也可配合参数 AdaptiveResolutionDirection 同时配置长短边或单独配置长边或短边，单边取值范围为（0,4096]。

  • 示例 1：若 AdaptiveResolutionDirection 为 false，1280x720表示设置宽为 1280，高为 720；1280x表示设置宽为 1280，高与源视频一致；x720表示设置高为 720，宽与源视频一致。
  • 示例 2：若 AdaptiveResolutionDirection 为 true，1280x720表示设置长边为 1280，短边为 720；1280x表示设置长边为 1280，短边与源视频一致；x720表示设置短边为 720，长边与源视频一致。
说明 若源视频存在旋转信息，宽高、长短边的判断以旋转后的情况为准，即以播放分辨率为准。
640x480
FilterVideoobject

视频处理参数，参数 TranscodeVideo 为空时或TranscodeVideo.Codec为 copy 时，本参数无效。

说明 API 为 GenerateVideoPlaylist 时不支持设置此参数。
Delogosarray<object>

对视频上某矩形部分进行模糊处理，用于去除 Logo、台标等。

object

视频模糊处理参数。

Dxfloat

取值为整数或小数时的不同含义如下：

  • 0（默认）：偏移像素和水平偏移量与输出分辨率高的比率都为 0。
  • 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。
  • 小数：表示水平偏移量与输出分辨率高的比率，取值范围为(0,1)。
0
Dyfloat

默认值为 0。取值为整数或小数时的不同含义如下：

  • 0（默认）：偏移像素和垂直偏移量与输出分辨率高的比率都为 0。
  • 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。
  • 小数：表示垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。
0
StartTimedouble

添加马赛克的开始时间，单位为秒（s）。默认为从视频起始时间开始。

0
Durationdouble

添加马赛克的持续时间，单位为秒（s），默认值持续到视频结束。

15
Heightfloat

马赛克的高度，默认值为小数型的 1.0，即占满输出视频高度，取值为整数或小数时的不同含义如下：

  • 整数：像素值，单位为像素（px），取值范围为[1,4096]。
  • 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1)。
40
ReferPosstring

添加马赛克的基准位置。取值范围如下：

  • topleft（默认）：左上角
  • topright：右上角
  • bottomright：右下角
  • bottomleft：左下角
topleft
Widthfloat

马赛克的宽度，默认值为小数型的 1.0，即占满输出视频宽度，取值为整数或小数时的不同含义如下：

  • 整数：像素值，单位为像素（px），取值范围为[1,4096]。
  • 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1)。
100
Speedfloat

视频倍速播放设置，取值范围为[0.5,1.0]，默认值为 1.0。

说明
  • 转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。
    •
    注意
  • 仅适用于 CreateMediaConvertTask API。
    •
    		1.0
    Desensitizationobject

    视频脱敏配置。

    注意
  • 仅适用于 CreateMediaConvertTask API。
    •
    LicensePlateobject

    车牌脱敏配置。

    MinSizeinteger

    最小车牌尺寸阈值，用于设置需要脱敏车牌的最小尺寸。若识别到的车牌宽度或高度小于该阈值，则不会对车牌进行脱敏。 单位为像素，默认值为 0，表示不对车牌尺寸进行限制。

    		0.4
    Confidencefloat

    车牌置信阈值，用于设置车牌识别的置信度下限。若识别到的车牌置信值小于该阈值，则不会对车牌进行脱敏。

    • 取值范围：0.0 ~ 1.0。
    • 默认值：0.0（表示不进行置信度过滤）。
    		0.4
    Faceobject

    人脸脱敏配置。

    MinSizeinteger

    最小人脸尺寸阈值，用于设置需要脱敏人脸的最小尺寸。若识别到的人脸宽度或高度小于该阈值，则不会对人脸进行脱敏。 单位为像素，默认值为 0，表示不对人脸尺寸进行限制。

    		0.4
    Confidencefloat

    人脸置信阈值，用于设置人脸识别的置信度下限。若识别到的人脸置信值小于该阈值，则不会对人脸进行脱敏。

    • 取值范围：0.0 ~ 1.0。
    • 默认值：0.0（表示不进行置信度过滤）。
    		0.4
    Watermarksarray<object>

    视频水印列表。

    object

    视频水印信息。

    StartTimedouble

    添加水印的开始时间，单位为秒（s），默认从视频起始时间开始。

    		0
    FontColorstring

    水印文字的字体颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。

    注意 当参数Type取值为text时此参数生效。

    		red
    BorderColorstring

    水印文字的描边颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。

    注意 当参数Type取值为text时此参数生效。

    		red
    Durationdouble

    添加水印持续的时间，单位为秒（s），默认值持续到视频结束。

    		0
    FontAphafloat

    文字水印的字体透明度。取值范围为(0,1]，默认值为 1，表示完全不透明。

    注意 当参数Type取值为text时此参数生效。

    		0.8
    BorderWidthinteger

    文字水印的描边宽度，单位为像素（px）。取值只能为整数，取值范围为[0,4096]，默认值为 0。

    注意 当参数Type取值为text时此参数生效。

    		2
    URIstring

    水印文件的 OSS 地址，支持的格式为 PNG 和 MOV。

    OSS 地址规则为oss://<bucket>/<object>，其中<bucket>为和当前项目处于同一地域的 OSS Bucket 名称，<object>为包含文件扩展名的文件完整路径。

    注意 当参数Type取值为file时此参数生效。

    		oss://test-bucket/watermark.jpg
    Typestring

    水印类型。取值范围如下：

    • text（默认）：文字水印。
    • file：图片或动图水印。
    		text
    Dxfloat

    取值为整数或小数时不同含义如下：

    • 0（默认）：偏移像素和水平偏移量与输出分辨率高的比率都为 0。
    • 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。
    • 小数：表示水平偏移量与输出分辨率高的比率，取值范围为(0,1)。
    		0
    Dyfloat

    取值为整数或小数时的不同含义如下：

    • 0（默认）：表示偏移像素和垂直偏移量与输出分辨率高的比率都为 0。

    • 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。

    • 小数：表示垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。

    		0
    FontSizeinteger

    文字水印的字体大小，默认值为 16。取值为整数，取值范围为(4,120)。

    注意 当参数Type取值为text时此参数生效。

    		18
    Contentstring

    文字水印的内容，默认值为空。

    注意 当参数Type取值为text时此参数生效。

    		example
    FontNamestring

    文字水印的字体名称。取值范围如下：

    • SourceHanSans-Regular（默认）
    • SourceHanSans-Bold
    • SourceHanSerif-Regular
    • SourceHanSerif-Bold

    注意 当参数Type取值为text时此参数生效。

    		SourceHanSans-Bold
    Heightfloat

    水印图片的高度，默认值为原水印图片的高度。取值为整数或小数时的不同含义如下：

    • 整数：表示去除 Logo 高度的像素值，单位为像素（px），取值范围为[1,4096]。
    • 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1)。
    		40
    ReferPosstring

    添加水印的基准位置。取值范围如下：

    • topleft（默认）：左上角
    • topright：右上角
    • bottomright：右下角
    • bottomleft：左下角
    		topleft
    Widthfloat

    水印图片的宽度，默认值为原水印图片的宽度。取值为整数或小数时的不同含义如下：

    • 整数：表示去除 Logo 宽度的像素值，单位为像素（px），取值范围为[1,4096]。
    • 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1)。
    		80
    Streamarray

    需要处理的源文件视频流索引号列表。空值（默认）表示处理索引号最小的视频流（第一路视频流），索引号大于 100 表示处理所有视频流。

    • 示例：[0,1]处理索引号为 0 和 1 的视频流；[1]处理索引号为 1 的视频流；[101]处理所有视频流。
    说明 只处理索引号存在的视频流，索引号对应的视频流不存在时将忽略该索引号。
    integer

    需要处理的视频流索引号。

    		0
    上一篇：Runtime下一篇：TaskInfo