文档

媒体处理参数说明

本文为您介绍点播API的媒体处理参数。

HLS标准加密配置EncryptConfig

字段名称

类型

必填项

描述

CipherText

String

密文密钥,用来获取明文密钥。

DecryptKeyUri

String

根据密文密钥获取解密密钥地址,例如:http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****

KeyServiceType

String

密钥服务类型,默认值:KMS(阿里云密钥管理服务KMS)。

EncryptConfig参数示例

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}
                        

转码作业参数替换配置 OverrideParams

字段名称

类型

必填项

描述

Watermarks

Watermark[]

水印替换必传。

SubtitleSetting

SubtitleSetting

字幕替换必传。

说明
  • 使用到的转码模板必须 先配置字幕参数,否则不做字幕参数覆盖,详细字幕配置请参见SubtitleConfig

  • 覆盖的字幕文件地址必须是HTTP(非HTTPS的OSS地址,不支持CDN加速域名 地址,例如:http://out-dda****.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass

PackageSubtitleSetting

PackageSubtitleSetting[]

多码率自适应打包中的字幕地址覆盖时,该参数必传。

TranscodeTemplateList

TranscodeTemplate[]

模板参数替换必传

  • 支持转码模板中 Video、Audio、Clip、Rotate、TranscodeFileRegular参数覆盖。

  • 原画模板不支持参数覆盖。

  • 参数覆盖时 TranscodeTemplateId必传。

说明

水印信息暂只支持对水印的图片文件、文字的内容替换。

TranscodeTemplateList示例

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  },
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1"
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]
                        

水印参数替换配置 Watermark

字段名称

类型

必填项

描述

WatermarkId

String

转码模板关联水印ID,视频点播控制台可查。更多信息,请参见水印管理

FileUrl

String

水印文件OSS地址。图片水印必传,文件OSS地址获取详细参见CreateUploadAttachedMedia

Content

String

文字水印内容,文字水印必传。

重要

FileUrl必须与视频源片所在存储源站保持一致。

字幕参数替换配置 SubtitleSetting

字段名称

类型

必填项

描述

SubtitleList

Subtitle

替换的字幕列表。

字幕配置 Subtitle

字段名称

类型

必填项

描述

SubtitleUrl

String

字幕文件的OSS地址(不支持HTTPS地址)。

CharEncode

String

字幕内容的编码格式,取值:

  • auto(自动检测)

  • UTF-8

  • GBK

  • BIG5

说明

CharEncode建议设置正确的编码格式,使用auto(自动检测)可能存在误检情况。

打包字幕替换参数 PackageSubtitleSetting

字段名称

类型

必填项

描述

PackageSubtitleList

PackageSubtitle[]

字幕替换必传。

打包字幕替换参数 PackageSubtitle

字段名称

类型

必填项

描述

SubtitlePackageTemplateId

String

字幕打包模板ID。

Language

String

语言类型,请参考RFC5646,例如:en-US。

说明

Language参数仅用于检索需要替换的字幕文件,而Language本身不会被替换。

SubtitleUrl

String

字幕地址,仅支持HTTP的OSS地址,不支持HTTP CDN地址和HTTPS地址。

说明

目前仅支持一个HTTP地址。

字幕文件仅支持存储在点播分配的系统Bucket中。

说明

SubtitlePackageTemplateId和Language用于检索对应需要替换的字幕地址,语言类型本身无法替换。

OverrideParams参数示例

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"水印测试"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}
                        

水印配置 WatermarkConfig

如果水印类型为Image

参数名称

参数类型

必填项

描述

Dx

String

水平偏移,两种取值形式。

  • 像素值:[8,4096]

  • 画面占比值:(0,1),其中取值为0表示画面占比0%,取值为1表示画面占比100%,取值为0.5则表示画面占比50%,其他取值含义以此类推。

Dy

String

垂直偏移,两种取值形式。

  • 像素值:[8,4096]

  • 画面占比值:(0,1),其中取值为0表示画面占比0%,取值为1表示画面占比100%,取值为0.5则表示画面占比50%,其他取值含义以此类推。

Width

String

水印宽,两种取值形式。

  • 像素值:[8,4096]

  • 画面占比值:(0,1),其中取值为0表示画面占比0%,取值为1表示画面占比100%,取值为0.5则表示画面占比50%,其他取值含义以此类推。

Height

String

水印高,两种取值形式。

  • 像素值:[8,4096]

  • 画面占比值:(0,1),其中取值为0表示画面占比0%,取值为1表示画面占比100%,取值为0.5则表示画面占比50%,其他取值含义以此类推。

ReferPos

String

水印位置:

  • BottomRight(右下)

  • BottomLeft(左下)

  • TopRight(右上)

  • TopLeft(左上)

Timeline

Timeline

水印时间线,水印效果的开始展现及结束展现时间(JSON字符串)。

重要

Timeline只对图片水印生效。

如果水印类型为Text

参数名称

参数类型

必填项

描述

Content

String

文字水印内容,例如:“文字水印”。

FontName

String

字体名称

FontColor

String

字体颜色

FontAlpha

String

字体透明度。取值范围:(0, 1],默认值:1.0。

BorderColor

String

描边颜色

Top

Integer

文本上边距,只支持整型数值。单位:px,默认值:0。取值范围:[0,4096]。

Left

Integer

文本左边距,只支持整型数值。单位:px,默认值:0。取值范围:[0,4096]。

FontSize

Integer

字体大小,只支持整型数值。默认值:16。取值范围:(4, 120)。

BorderWidth

Integer

描边宽度,只支持整型数值。单位:px,默认值:0。取值范围:(0,4096]。

水印时间线 Timeline

参数名称

参数类型

必填项

描述

Start

String

水印开始出现时间。单位:秒,取值范围:数字,默认值:0。

Duration

String

水印持续时间。单位:秒,取值范围:[数字,ToEND],默认值:ToEND(整个视频结束)。

重要

Timeline暂只对图片水印生效。

字体名称 Fontname

字体名称

描述

SimSun

宋体

WenQuanYi Zen Hei

文泉驿正黑

WenQuanYi Zen Hei Mono

文泉驿等宽正黑

WenQuanYi Zen Hei Sharp

文泉驿点阵正黑

Yuanti SC

圆体-简,常规体

视频截图

截图模板配置

SnapshotTemplateConfig

名称

类型

是否必填

描述

SnapshotType

String

截图类型。取值:

  • NormalSnapshot:普通截图。

  • SpriteSnapshot:雪碧图。

  • WebVttSnapshot:WebVtt截图。

SnapshotConfig

JSON

截图模板配置信息,不同的SnapshotType对应不同的模板配置内容。详细信息,请参见下文SnapshotConfig

SnapshotConfig

说明

雪碧图是先截取普通截图,然后将普通截图拼成雪碧图,所以无论是普通截图或是雪碧截图,SnapshotConfig参数都必传。

参数名称

类型

是否必填

描述

FrameType

String

截图的帧类型,取值:

  • intra:关键帧。

  • normal:普通帧。

Count

Long

需要截取的图片数量,单位:张。

Interval

Long

截图的间隔时间,必须大于等于0,单位:秒。其中,Interval为0表示按照Count数根据视频时长平均截图。

SpecifiedOffsetTime

Long

截图指定时间的起始点,单位:毫秒。

Width

Integer

截图宽,取值范围:[8,4096],默认原片宽,单位:px。

Height

Integer

截图高,取值范围:[8,4096],默认原片高,单位:px。

SpriteSnapshotConfig

JSON

雪碧图配置,截图类型为雪碧图(SnapshotType取值为SpriteSnapshot)时,本参数必传。详细信息,请参见下文SpriteSnapshotConfig

Format

String

输出的截图文件格式,取值:vtt (仅WebVttSnapshot类型支持该参数)。

SubOut

JSON

WebVttSnapshot截图方式下,控制截图的展示方式(仅WebVttSnapshot类型支持该参数)。详细信息,请参见下文SubOut

SpriteSnapshotConfig

参数名称

类型

是否必填

描述

CellWidth

String

雪碧图中小图的宽 ,默认为普通截图的宽,单位:px。

CellHeight

String

雪碧图中小图的高,默认为普通截图的高,单位:px。

Padding

String

小图内边距大小,单位:px。

Margin

String

小图外边距大小,单位:px。

Color

String

雪碧图背景颜色,更多信息,请参见颜色设置

说明

Color暂不支持RGB值设置。

Columns

String

小图列数 ,取值范围:[1,10000]。

Lines

String

小图行数,取值范围:[1,10000]。

KeepCellPic

String

是否保留小图,取值:

  • keep:保留。

  • delete:删除。

SubOut

参数名称

类型

是否必填

描述

IsSptFrag

String

取值:

  • false:截图单张分开存储。

  • true:截图先拼成类似雪碧图的大图统一存储。

截图模板示例

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

视频动图

动图模板配置

DynamicImageTemplateConfig

参数名称

类型

是否必填

描述

Name

String

动图模板名称。

Video

JSON

动图画面参数配置。详细信息,请参见下文Video

Container

JSON

动图输出格式配置。详细信息,请参见下文Container

Clip

JSON

动图裁剪参数配置。详细信息,请参见下文Clip

SetDefaultCover

String

截取的动图是否默认设置成视频封面。取值:

  • true:默认设置成视频封面。

  • false:不设置成视频封面。

Video

说明
  • 若Width(宽)和Height(高)都不设置,则输出的动图的尺寸和原片保持一致。

  • 若仅设置Width(宽),则输出的动图的Height(高)会按照原片等比例进行缩放。

  • 若仅设置Height(高),则输出的动图的Width(宽)会按照原片等比例进行缩放。

参数名称

类型

是否必填

描述

Width

String

输出动图的宽,取值范围:[128,4096]。

Height

String

输出动图的高,取值范围:[128,4096]。

Fps

String

帧率,取值范围:(0,60]。

Container

参数名称

类型

是否必填

描述

Format

String

动图输出格式。取值:

  • webp

  • gif

Clip

参数名称

类型

是否必填

描述

TimeSpan

JSON

动图截取时间线配置。详细信息,请参见下文TimeSpan

TimeSpan

说明
  • 如需按持续时长的方式截取动图,则需同时传入SeekDuration参数;如需按去首尾的方式截取动图,则需同时传入SeekEnd参数。

  • 如果同时传入了SeekDurationEnd参数,将按照SeekEnd参数来生效。

参数名称

类型

是否必填

描述

Seek

String

视频动图截取的开始时间点。

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

    示例:0

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

    示例:00:00:05.003

Duration

String

视频裁剪的持续时长。

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

    示例:15

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

    示例:00:00:10.003

End

String

视频裁剪需要丢弃的尾部时长。传入此参数时,传入的Duration参数失效。

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

    示例:12000.55

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

    示例:00:00:15.003

动图模板示例

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}