媒体处理参数说明_附录_服务端API

HLS标准加密配置EncryptConfig

字段名称	类型	必填项	描述
CipherText	String	是	密文秘钥，用来获取明文秘钥。
DecryptKeyUri	String	是	根据密文秘钥获取解密秘钥地址，例如：http://decrypt.demo.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt。
KeyServiceType	String	是	密钥服务类型，默认值：KMS（阿里云密钥管理服务KMS）。

EncryptConfig参数示例

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt",
  "DecryptKeyUri":"http://decrypt.demo.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt",
  "KeyServiceType":"KMS"
}

转码作业参数替换配置 OverrideParams

字段名称	类型	必填项	描述
Watermarks	Watermark[]	否	水印替换必传
SubtitleSetting	SubtitleSetting	否	字幕替换必传说明：使用到的转码模板必须先配置字幕参数，否则不做字幕参数覆盖，详细字幕配置请参考 SubtitleConfig。覆盖的字幕文件地址必须是 Http(非Https) 的OSS地址，不支持CDN加速域名地址，例如：http://out-ddawewsrrrw86223.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass
PackageSubtitleSetting	PackageSubtitleSetting[]	否	多码率自适应打包中的字幕地址覆盖时，该参数必传
TranscodeTemplateList	TranscodeTemplate[]	否	模板参数替换必传支持转码模板中 Video、Audio、Clip、Rotate、TranscodeFileRegular 参数覆盖原画模板不支持参数覆盖参数覆盖时 TranscodeTemplateId 必传

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

TranscodeTemplateList示例

    [
        {
          "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f2268",
          "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 > 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://test.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"水印测试"
    }
  ],
  "SubtitleSetting":{
      "SubtitleList":[
        {
        "SubtitleUrl":"http://outin-40564284ef051100163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16cc112.ass",
        "CharEncode":"UTF-8"
        },
        {
        "SubtitleUrl":"http://outin-40564284ef0511e0163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d1cyy.srt",
        "CharEncode":"auto"
        }
    ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad6cd5", 
        "SubtitleUrl": "http://outin-4056428.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB7-3-3.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad6cd5",
        "SubtitleUrl": "http://outin-4056428.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB7-3-3.vtt"
      }
    ]
  }
}

水印配置 WatermarkConfig

如果水印类型为Image

参数名称	参数类型	必填项	描述
Dx	String	是	水平偏移,两种取值形式：像素值：[8,4096];画面占比值:(0,1)
Dy	String	是	垂直偏移,两种取值形式：像素值：[8,4096];画面占比值:(0,1)
Width	String	是	水印宽,两种取值形式：像素值：[8,4096];画面占比值:(0,1)
Height	String	是	水印高,两种取值形式：像素值：[8,4096];画面占比值:(0,1)
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	否	文本上边距，只支持整型数值。默认：0 范围：[0,4096]。
Left	Integer	否	文本左边距，只支持整型数值。默认：0 范围：[0,4096]。
FontSize	Integer	否	字体大小，只支持整型数值。默认值：16 范围：(4, 120)。
BorderWidth	Integer	否	描边宽度，只支持整型数值。默认：0 范围：(0,4096]。

水印时间线 Timeline

参数名称	参数类型	必填项	描述
Start	String	是	水印开始出现时间。单位：秒，取值范围：数字，默认值：0。
Duration	String	是	水印持续时间。单位：秒，取值范围：[数字，ToEND]，默认值：ToEND(整个视频结束)。

注意：Timeline暂只对图片水印生效。

截图模板配置 SnapshotTemplateConfig

参数名称	类型	必填项	描述
SnapshotType	String	是	NormalSnapshot(普通截图)、SpriteSnapshot(雪碧图) 、WebVttSnapshot(WebVtt截图)
SnapshotConfig	SnapshotConfig	是	JSON字符串，截图配置信息，不同的SnapshotType对应不同的配置内容。

普通截图配置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	SpriteSnapshotConfig	否	截雪碧图必传
Format	String	否	文件格式，取值：vtt (仅WebVttSnapshot类型支持该参数)
SubOut	SubOut	否	WebVttSnapshot截图方式下，控制截图的展示方式 (仅WebVttSnapshot类型支持该参数)

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

SubOut

参数名称	类型	必填项	描述
IsSptFrag	String	是	取值：false(截图单张分开存储)，true(截图先拼成类似雪碧图的大图统一存储)

雪碧图配置SpriteSnapshotConfig

字段名称	类型	必填项	描述
CellWidth	String	否	雪碧图中小图的宽，默认为普通截图的宽，单位：px。
CellHeight	String	否	雪碧图中小图的高，默认为普通截图的高，单位：px。
Padding	String	是	小图内边距大小，单位：px。
Margin	String	是	小图外边距大小，单位：px。
Color	String	是	雪碧图背景颜色，详细请参考颜色设置。
Columns	String	是	小图列数，取值范围：[1,10000]。
Lines	String	是	小图行数，取值范围：[1,10000]。
KeepCellPic	String	是	是否保留小图，取值：keep（保留），delete（删除）。

说明：Color暂不支持RGB值设置。

字体名称 Fontname

字体名称	描述
SimSun	宋体
WenQuanYi Zen Hei	文泉驿正黑
WenQuanYi Zen Hei Mono	文泉驿等宽正黑
WenQuanYi Zen Hei Sharp	文泉驿点阵正黑
Yuanti SC	圆体-简常规体