点播API的基本数据类型_视频点播(VOD)-阿里云帮助中心

本文为您介绍点播API的基本数据类型。

媒资基本信息

Video：音视频信息

名称	类型	描述
VideoId	String	音视频ID。
Title	String	音视频标题。
Description	String	音视频描述。
Duration	Float	音视频时长，单位：秒。
CoverURL	String	音视频封面URL。
Status	String	音视频状态。具体的参数说明请参见Status：音视频状态。
CreationTime	String	音视频创建时间。使用UTC时间。
Size	Long	音视频源文件大小，单位：字节。
Snapshots	String[]	视频截图URL数组。
CateId	Long	音视频分类ID。
CateName	String	音视频分类名称。
Tags	String	音视频标签，多个使用英文逗号（,）分隔。
TemplateGroupId	String	音视频转码时使用的转码组ID。
StorageLocation	String	音视频文件的存储地址。
AppId	String	应用ID。

Status：音视频状态

取值	描述	说明
Uploading	上传中	音视频的初始状态，表示正在上传。如果您的音视频长时间处于上传中，请参见为什么我上传的文件一直处于上传中？。处于该状态下的音视频仅可以删除，无法进行其他操作，即无法对上传中的音视频发起转码处理、视频截图、媒资审核等其他操作。
UploadFail	上传失败	由于网络或源文件损坏等原因可能导致上传失败，建议重试或更换源文件上传。当使用断点续传上传时，由于无法判断上传是否失败，因此断点续传的音视频不会出现该状态。处于该状态下的音视频仅可以删除，无法进行其他操作，即无法对上传失败的音视频发起转码处理、视频截图、媒资审核等其他操作。
UploadSucc	上传完成	由于业务设计或其他原因，上传时跳过了默认的转码处理环节，导致视频未能生成有效的播放流时，则视频会被标记为上传完成的状态；当后续经过转码处理得到有效播放流后，该视频会转为正常状态。处于该状态下的音视频可以正常发起转码处理、视频截图和媒资审核的操作。
Transcoding	转码中	表示音视频正在进行转码处理。处于初次转码中的视频，无有效播放流，无法通过接口获取到播放地址，您可以通过视频转码完成的事件通知（单个清晰度转码完成或全部清晰度转码完成）来判断转码状态。
TranscodeFail	转码失败	通常是由于您的视频源文件存在问题而导致转码失败。您可以在视频转码完成的事件通知（单个清晰度转码完成或全部清晰度转码完成）中获取ErrorMessage失败信息，或参见转码常见问题排查转码失败的原因。
Checking	审核中	如果在视频点播控制台 > 审核管理 > 审核设置中开启了先审后发，则当音视频上传到视频点播中转码成功后，将默认进入审核流程，音视频状态将会被标记为审核中，后续，您必须要去发起人工审核，否则该音视频将一直处于审核中状态。处于该状态下的音视频，只能在视频点播控制台播放或通过审核安全IP进行播放，您将无法通过API或SDK获取到音视频的播放地址用于播放，但对于已经外泄的有效播放地址仍可以正常播放。处于该状态下的音视频可以正常发起转码处理、视频截图的操作。说明请注意此处审核中描述的为音视频的状态（在视频点播控制台 > 媒资库 > 音/视频中的状态列查看），需要区别于机审状态的审核中（在视频点播控制台 >审核管理 > 视频审核中的机审状态列查看）。机审状态的审核中仅描述机器审核作业的状态，而音视频状态的审核中描述了包含机器审核和人工审核作业的状态。
Blocked	屏蔽	处于该状态下的音视频，只能在视频点播控制台播放或通过审核安全IP进行播放，您将无法通过API/SDK获取到音/视频的播放地址用于播放，但对于已经外泄的有效播放地址仍可以正常播放。处于该状态下的音视频仅可以删除，无法进行其他操作，即无法对屏蔽的音视频发起转码处理、视频截图、媒资审核等其他操作。
Normal	正常	当音视频存在至少一路有效的播放流时，该音视频会处于正常状态。处于该状态下的音视频可以进行所有操作，包括发起转码处理、视频截图、媒资审核、播放等其他操作。
ProduceFail	合成失败	表示视频剪辑合成失败。使用视频点播的云剪辑进行剪辑合成时，请确保剪辑合成所使用的媒资都处于正常状态，否则易导致视频合成失败。

ImageInfo：图片信息

名称	类型	描述
ImageId	String	图片ID。
URL	String	图片URL（如果配置了CDN域名则为CDN地址，否则为OSS地址）。
Title	String	图片标题。
Tags	String	图片标签。
ImageType	String	图片类型。
CateId	Long	分类ID。
CateName	String	分类名称。
Description	String	描述。
StorageLocation	String	文件存储地址。
Mezzanine	Mezzanine	图片源信息。
CreationTime	String	图片创建时间。使用UTC时间。
Status	String	图片状态。具体的参数说明请参见Status：图片状态。
AppId	String	应用ID。

Status：图片状态

取值	描述	说明
Uploading	上传中	图片的初始状态，表示正在上传。如果您的图片长时间处于上传中，请参见为什么我上传的文件一直处于上传中？。
UploadFail	上传失败	由于网络或源文件损坏等原因可能导致上传失败，建议重试或更换源文件上传。
Normal	正常	图片上传成功。

AttachedMediaInfo：辅助媒资信息

名称	类型	描述
MediaId	String	辅助媒资ID。
URL	String	辅助媒资URL（如果配置了CDN域名则为CDN地址，否则为OSS地址）。
Title	String	标题。
Tags	String	标签。
Type	String	辅助媒资类型。
Categories	Category[]	分类列表。
Description	String	描述。
StorageLocation	String	文件存储地址。
CreationTime	String	辅助媒资创建时间。使用UTC时间。
ModificationTime	String	辅助媒资更新时间。使用UTC时间。
Status	String	辅助媒资状态。具体的参数说明请参见Status：辅助媒资状态。
AppId	String	应用ID。

Status：辅助媒资状态

取值	描述	说明
Uploading	上传中	初始状态，表示辅助媒资正在上传。
Normal	正常	辅助媒资上传成功。
UploadFail	失败	辅助媒资上传失败。

媒资源文件信息

Mezzanine：音视频源文件信息

名称	类型	描述
VideoId	String	视频ID。
FileName	String	文件名称。
Duration	String	文件时长，单位：秒。
Status	String	源文件状态。具体的参数说明请参见Status：音视频源文件状态。
CreationTime	String	文件创建时间。使用UTC时间。
Height	Long	文件高度，单位：Px。
Width	Long	文件宽度，单位：Px。
Fps	String	文件帧率，每秒多少帧。
FileURL	String	文件地址。
Bitrate	String	文件码率，单位：Kbps。
Size	Long	文件大小，单位：字节。
OutputType	String	输出文件类型。取值： oss：源站地址。 cdn：加速地址。
VideoStreamList	VideoStream[]	视频流信息列表。
AudioStreamList	AudioStream[]	音频流信息列表。

VideoStream：视频流信息

名称	类型	描述
Index	String	视频流序号，标识视频流在整个媒体流中的位置。
CodecName	String	编码格式简述名。
CodecLongName	String	编码格式长述名。
Profile	String	编码预置。
CodecTimeBase	String	编码时基。
CodecTagString	String	编码格式标记文本。
CodecTag	String	编码格式标记。
Width	Long	视频分辨率宽。
Height	Long	视频分辨率长。
HasBFrames	String	是否有B帧。
Sar	String	编码信号分辨率比。
Dar	String	编码显示分辨率比。
PixFmt	String	像素格式。
Level	String	编码等级。
Fps	String	目标帧率。
AvgFPS	String	平均帧率。
Timebase	String	时基。
StartTime	String	起始时间。
Duration	String	时长。
NumFrames	String	总帧数。
Lang	String	语言。
Rotate	String	视频旋转角度，取值范围：[0，360)。

AudioStream：音频流信息

名称	类型	描述
Index	String	音频流序号，标识音频流在整个媒体流中的位置。
CodecName	String	编码格式简述名。
CodecLongName	String	编码格式长述名。
CodecTimeBase	String	编码时基。
CodecTagString	String	编码格式标记文本。
CodecTag	String	编码格式标记。
SampleFmt	String	采样格式。
SampleRate	String	采样率。
Channels	String	声道数。
ChannelLayout	String	声道输出样式。
Timebase	String	时基。
StartTime	String	起始时间。
Duration	String	时长。
Bitrate	String	码率。
NumFrames	String	总帧数。
Lang	String	语言。

Status：音视频源文件状态

取值	描述	备注
Uploading	上传中	文件的初始状态，表示正在上传。
Normal	正常	文件上传成功。
UploadFail	失败	文件上传失败。
Deleted	删除	文件被删除。

Mezzanine：图片源文件信息

名称	类型	描述
FileURL	String	图片OSS URL。
OriginalFileName	String	上传文件名称。
FileSize	Long	文件大小，单位：字节。
Width	Integer	图片宽度，单位：Px。
Height	Integer	图片高度，单位：Px。

URL批量拉取上传

URLUploadInfo：URL上传信息

名称	类型	描述
JobId	String	Job ID。
UploadURL	String	上传URL地址。
MediaId	String	上传视频ID。
FileSize	String	文件大小。单位：字节。
Status	String	URL上传任务状态。具体的参数说明请参见Status：URL上传任务状态。
CreationTime	String	创建时间。
CompleteTime	Long	完成时间。
UserData	String	用户自定义字段。
ErrorCode	String	错误码。
ErrorMessage	String	错误信息。

Status：URL上传任务状态

取值	描述
PENDING	提交任务成功，等待处理。
PROCESSING	开始处理任务。
DOWNLOADING	文件下载中。
DOWNLOAD_SUCCESS	文件下载完成。
DOWNLOAD_FAIL	文件下载失败。
UPLOADING	文件上传中。
UPLOAD_SUCCESS	上传成功。
UPLOAD_FAIL	上传失败。
SUCCESS	任务成功，且回调完成。

音视频播放

VideoBase：视频基本信息

名称	类型	描述
VideoId	String	视频ID。
Title	String	视频标题。
Duration	String	视频时长，单位：秒。
CoverURL	String	视频封面。
Status	String	视频状态。
CreationTime	String	视频创建时间。使用UTC时间。
MediaType	MediaType	媒体文件类型。取值： video：视频。 audio：纯音频。

说明

播放接口默认返回CDN加速地址。未配置域名时，播放接口返回OSS源站地址，此时只有MP4格式地址可用于播放。

PlayInfo：视频播放信息

名称	类型	描述
Bitrate	String	视频流码率，单位：Kbps。
Definition	String	视频流清晰度定义。取值： FD：流畅。 LD：标清。 SD：高清。 HD：超清。 OD：原画。 2K：2K。 4K：4K。
Specification	String	音视频转码输出规格，更多取值信息，请参见输出规格说明。
Duration	String	视频流长度，单位：秒。
Encrypt	Long	视频流是否加密流。取值： 0：否。 1：是。
EncryptType	String	视频流加密类型。取值： AliyunVoDEncryption：阿里云视频加密（私有加密）。 HLSEncryption：HLS标准加密。
PlayURL	String	视频流的播放地址。
Format	String	视频流格式。若媒体文件为视频，取值： mp4 m3u8 若是纯音频，取值：mp3。
Fps	String	视频流帧率，每秒多少帧。
Size	Long	视频流大小，单位：字节。
Width	Long	视频流宽度，单位：Px。
Height	Long	视频流高度，单位：Px。
StreamType	String	媒体流类型。若媒体流为视频，取值：video。若是纯音频，取值：audio。
JobId	String	媒体流转码的作业ID，作为媒体流的唯一标识。
WatermarkId	String	当前媒体流关联的水印ID。
Status	String	视频流状态，取值： Normal：正常状态，标记的是每种清晰度和格式的一路最新转码完成的流的状态。 Invisible：不可见状态，当每种清晰度和格式有多路重复的转码流时，除了最新的一路流会被标记为正常状态，其他流会被标记为不可见状态。
NarrowBandType	String	窄带高清类型。取值： 0：普通。 1.0：窄带高清1.0。 2.0：窄带高清2.0。仅当配置了窄带高清1.0内置转码模板的清晰度时才会生效，更多信息，请参见TranscodeTemplate：转码模板配置。
CreationTime	String	创建时间。使用UTC时间。
ModificationTime	String	更新时间。使用UTC时间。

VideoMeta：视频Meta信息

名称	类型	描述
VideoId	String	视频ID。
Title	String	视频标题。
Duration	Float	视频时长，单位：秒。
CoverURL	String	视频封面。
Status	String	视频状态。

媒资搜索

Media：媒体信息

名称	类型	描述
MediaId	String	媒体ID。
CreationTime	String	媒体创建时间。使用UTC时间。
MediaType	String	媒体文件类型。取值： video：视频。 audio：音频。 image：图片。 attached：辅助媒资。
Video	Video	视频信息。
Audio	Audio	音频信息。
Image	Image	图片信息。
AttachedMedia	AttachedMedia	辅助媒资信息。

媒资分类

Category：媒资分类

名称	类型	描述
CateId	Long	视频分类ID。
CateName	String	分类名称，最大64字节，UTF8编码。
ParentId	Long	父分类ID，一级分类父ID为-1。
Level	Long	分类层级，一级分类层级为0。

直播转点播

LiveRecordVideo：直转点录制视频信息

名称	类型	描述
StreamName	String	直播流名称。
DomainName	String	域名。
AppName	String	App名称。
PlaylistId	String	播单ID。
RecordStartTime	String	录制开始时间。
RecordEndTime	String	录制结束时间。
Video	Video	视频信息。

云剪辑-剪辑合成

EditingProject：云剪辑工程

名称	类型	描述
ProjectId	String	云剪辑工程ID。
Title	String	云剪辑工程标题。
CreationTime	String	云剪辑工程创建时间。UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。例如，2017-01-11T12:00:00Z（为北京时间2017年1月11日20点0分0秒）。
ModifiedTime	String	云剪辑工程最新修改时间。UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。例如，2017-01-11T12:00:00Z（为北京时间2017年1月11日20点0分0秒）。
Status	String	云剪辑工程状态。
Description	String	云剪辑工程描述。
Timeline	String	云剪辑工程时间线。Json格式。
Duration	String	云剪辑工程总时长，与Timeline的总时长一致。
CoverURL	String	云剪辑工程封面URL。

ProjectStatus：云剪辑工程状态

取值	描述	说明
Normal	草稿	云剪辑工程创建的初始状态。
Producing	合成中	无。
Produced	合成成功	无。
ProduceFailed	合成失败	无。

Material：云剪辑工程素材信息

说明

该类型指广义的素材，既包括素材管理中的素材，也包括媒体库中的视频。

名称	类型	描述
MaterialId	String	素材ID。
Title	String	素材标题。
Description	String	素材描述。
Duration	Float	素材时长，单位：秒，精确到小数点后4位。
CoverURL	String	素材封面URL。
Status	String	素材状态。
CreationTime	String	素材创建时间，为UTC时间
Size	Long	素材源文件大小，单位：字节。
CateId	Long	素材分类ID。
CateName	String	素材分类名称。
Tags	String	素材标签，多个标签使用英文逗号（,）分隔。
Snapshots	String[]	素材截图URL数组。
Sprites	String[]	素材雪碧图URL数组。

ProduceConfig：视频合成配置

名称	类型	描述
TemplateGroupId	String	视频合成完毕之后，以合成的文件为源文件，启动转码时所使用的转码模板组ID，类似上传完成后的转码过程。该字段为非必填项，当为空时，则使用转码设置的默认模板组进行转码；当不为空时，会使用该指定的模板组进行转码。可在控制台转码设置里查看模板组ID。
TemplateId	String	视频合成时使用的合成模板ID，用于生成媒体资源的源文件。该字段为非必填项。当取值为空时，则使用云剪辑内置的模板进行合成。如果合成目标为视频文件，内置模板的编码格式为H.264，容器格式为MP4。如果有其他需求希望指定合成参数（如动图合成、智能字幕合成、M3U8快剪、自定义合成参数支持等），可填写宜搭信息申请模板。
Width	Integer	视频合成输出画面的宽，单位：Px。该字段为非必填项，默认值与Timeline所使用的素材源文件分辨率有关：取其最大宽高。例如：Timeline使用了3个素材，其源文件分辨率分别为：1280＊720，1920＊1080，720＊1280，则目标成片的分辨率为1920＊1280。
Height	Integer	视频合成输出画面的高，单位：Px。该字段为非必填项，默认值与Timeline所使用的素材源文件分辨率有关：取其最大宽高。例如：Timeline使用了3个素材，其源文件分辨率分别为：1280＊720，1920＊1080，720＊1280，则目标成片的分辨率为1920＊1280。
StorageLocation	String	文件的存储地址（除上海区域外的其他区域必填）。

MediaMetadata：合成视频的媒资元数据

名称	类型	描述
Title	String	合成视频标题，长度不超过128个字节，UTF8编码。
Description	String	合成视频描述，长度不超过1024个字节，UTF8编码。
CoverURL	String	合成视频自定义封面URL地址。
CateId	String	合成视频分类ID，请在视频点播控制台 > 配置管理 > 媒资管理配置 > 分类管理里编辑或查看分类的ID。
Tags	String	合成视频标签，单个标签不超过32字节，最多不超过16个标签。多个标签使用英文逗号（,）分隔，UTF8编码。

云剪辑-Timeline（适用于新版编辑器）

说明

不同服务地域对云剪辑能力的支持情况不同，使用前，请先确认您的服务地域是否支持，具体支持情况，请参见服务地域。旧版编辑器的云剪辑数据类型相关参数解释，请参见云剪辑数据类型（适用于旧版编辑器）。

Timeline：时间线信息

时间线是将素材按照视频创意进行编排和特效设计的产物。时间线主要包含轨道、素材、效果3种对象。

名称	类型	是否必填	描述
VideoTracks	VideoTrack[]	否，视频轨为空时，音频轨必须非空。	视频轨列表。多个轨道的层叠顺序与数组元素顺序一致，如：数组的第一个元素图层的t在最底层，第二个元素的图层在其之上，以此类推。
AudioTracks	AudioTrack[]	否，音频轨为空时，视频轨必须非空。	音频轨列表。
SubtitleTracks	SubtitleTrack[]	否	字幕轨列表。
EffectTracks	EffectTrack[]	否	特效轨列表。

VideoTrack：视频轨信息

视频轨VideoTrack用于编排图像素材，包括视频素材和图片素材。

名称	类型	是否必填	描述
Type	String	否	默认为普通视频轨。当Type=Effect时，当前轨道可当做特效轨使用，VideoTrackClips可填入EffectTrackItem。
MainTrack	Boolean	否	用于指定当前轨道是否为主轨道。默认为 False。
VideoTrackClips	VideoTrackClip[]	是	视频轨素材片段列表。

AudioTrack：音频轨信息

音频轨AudioTrack用于编排音频素材，包括纯音频素材和带音频的视频素材。

名称	类型	是否必填	描述
MainTrack	Boolean	否	用于指定当前轨道是否为主轨道。默认为 False。
AudioTrackClips	AudioTrackClip[]	是	音频轨素材片段列表。

SubtitleTrack：字幕轨信息

字幕轨SubtitleTrack用于编排字幕，包括横幅文字和外挂字幕。

名称	类型	是否必填	描述
SubtitleTrackClips	SubtitleTrackClip[]	是	字幕轨素材片段列表。

EffectTrack：特效轨信息

特效轨EffectTrack用于为视频整体添加特效，支持滤镜、VFX。

名称	类型	是否必填	描述
EffectTrackItems	EffectTrackItem[]	是	特效轨片段列表。

VideoTrackClip：视频轨素材信息

视频轨素材VideoTrackClip的范围包括视频素材和图片素材。

In、Out、TimelineIn、TimelineOut标记了对素材截取的位置以及素材在时间线中的位置，如：想把一段视频的5~10s放在时间线15s~20s位置上，则：In=5, Out=10, TimelineIn=15, TimelineOut=20。

名称	类型	是否必填	描述
MediaId	String	否	视频轨素材片段对应的媒体ID。媒体ID在某些场合也叫音/视频ID（VideoId）或图片ID（ImageId）。
Type	String	否	素材片段类型，默认Video。取值： Video（视频） Image（图片） GlobalImage（全局图片，默认按照最长视频轨时间计算该图片时长。）示例：视频轨道中使用全局图片GlobalImage
X	Float	否	表示图片或视频左上角距离输出视频左上角的横向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频宽的占比。当取值为≥2的整数时，表示绝对像素。
Y	Float	否	表示图片或视频左上角距离输出视频左上角的纵向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频高的占比。当取值为≥2的整数时，表示绝对像素。
Width	Float	否	表示图片在输出视频中的宽度。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频宽的占比。当取值为≥2的整数时，表示绝对像素。
Height	Float	否	表示图片在输出视频中的高度。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频高的占比。当取值为≥2的整数时，表示绝对像素。
AdaptMode	String	否	视频尺寸自适应模式类型，默认为Fill，必须同时设置视频轨道Width和Height，该模式才会生效，此时Width和Height为目标区域宽高，视频会在目标区域内自适应缩放。 Contain：被替换的内容将被缩放，在填充目标区域的同时保留其长宽比。 Cover：被替换的内容在保持其宽高比的同时填充整个目标区域。如果对象的宽高比与内容框不相匹配，该对象将被剪裁以适应目标区域。 Fill：默认逻辑，被替换的内容正好填充目标内容框。整个对象将完全填充此框。如果对象的宽高比与内容框不相匹配，那么该对象将被拉伸以适应目标区域。
In	Float	否	素材片段相对于素材的入点，在素材类型是音视频时使用。单位：秒，精确到小数点后4位。如果In不填，默认为0。
Out	Float	否	素材片段相对于素材的出点，在素材类型是音视频时使用。单位：秒，精确到小数点后4位。如果Out不填，默认为素材时长。
MaxOut	Float	否	素材片段相对于素材的最大出点值。如果设置该值，素材片段相对于素材的出点将会设置为素材时长与该值中的较小者。在素材为音视频时使用。单位：秒，精确到小数点后4位。如果填入Out值，MaxOut值将失效。示例：视频轨中设置出点MaxOut
Duration	Float	否	素材片段的时长，一般在素材类型是图片时使用。单位：秒，精确到小数点后4位。
DyncFrames	Int	否	动图的帧率，在素材类型是图片且为动图时使用。示例：使用GIF贴纸
TimelineIn	Float	否	素材片段相对于时间线的入点。单位：秒，精确到小数点后4位。如果TimelineIn不填，则会按照素材片段顺序相接的方式自动计算TimelineIn。
TimelineOut	Float	否	素材片段相对于时间线的出点。单位：秒，精确到小数点后4位。如果TimelineOut不填，则会按照素材片段顺序相接的方式自动计算TimelineOut。
Speed	Float	否	视频素材速率，取值范围为0.1~100，如：Speed=2，则将视频做2倍速处理，Clip的Duration减半，并合成到成片中。示例：音视频变速
MaskVideoUrl	String	否	遮罩视频地址。一般为带Alpha通道的视频，用于为原视频添加透明通道效果。仅支持传入OSS外网地址。
Effects	Effect[]	否	素材片段的效果列表。

AudioTrackClip：音频轨素材信息

音频轨素材AudioTrackClip的范围包括纯音频素材、有音频流的视频素材。

名称	类型	是否必填	描述
MediaId	String	否	音频轨素材片段对应的媒体ID。
In	Float	否	素材片段相对于素材的入点。单位：秒，精确到小数点后4位。如果In不填，默认为0。
Out	Float	否	素材片段相对于素材的出点。单位：秒，精确到小数点后4位。如果Out不填，默认为素材时长。
TimelineIn	Float	否	素材片段相对于时间线的入点。单位：秒，精确到小数点后4位。如果TimelineIn不填，则会按照素材片段顺序相接的方式自动计算TimelineIn。
TimelineOut	Float	否	素材片段相对于时间线的出点。单位：秒，精确到小数点后4位。如果TimelineOut不填，则会按照素材片段顺序相接的方式自动计算TimelineOut。
Speed	Float	否	音频素材速率，取值范围0.1~100，如：Speed=2，则将音频做2倍速处理，Clip的Duration减半，并合成到成片中。示例：音视频变速
Effects	Effect[]	否	素材片段的效果列表。
LoopMode	Boolean	否	素材片段在时间线中循环播放效果。True：循环播放；False（默认值）：正常不循环。示例：音频循环播放

SubtitleTrackClip：字幕轨素材信息

字幕轨素材SubtitleTrackClip的范围包括字幕素材。

名称	类型	是否必填	描述
Type	String	是	字幕素材类型。取值： Subtitle：外挂字幕文件 Text：横幅文字
SubType	String	否	字幕素材子类型。取值： srt：外挂srt字幕 ass：外挂ass字幕字幕素材类型为横幅文字时，可忽略该字段。
FileURL	String	否	字幕文件对应的OSS地址。当字幕类型为外挂字幕时必填。格式为： https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt 示例：直接使用字幕文件进行剪辑说明 FileURL仅支持OSS外网地址，不支持OSS加速地址、CDN地址或其他HTTP URL。
X	Float	否	当字幕类型为横幅文字时，表示文字左上角距离输出视频左上角的横向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频宽的占比。当取值为>=2的整数时，表示绝对像素。
Y	Float	否	当字幕类型为横幅文字时，表示文字左上角距离输出视频左上角的纵向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频高的占比。当取值为>=2的整数时，表示绝对像素。
TimelineIn	Float	否	当字幕类型为横幅文字时，表示文字出现在时间线的起始位置。单位：秒，精确到小数点后4位。如果TimelineIn不填，则会按照素材顺序相接的方式自动计算TimelineIn。
TimelineOut	Float	否	当字幕类型为横幅文字时，表示文字出现在时间线的结束位置。单位：秒，精确到小数点后4位。如果TimelineOut不填，则会按照素材顺序相接的方式自动计算TimelineOut。
Content	String	否	当字幕类型为横幅文字时必填，表示文字内容。
Font	String	否	当字幕类型为横幅文字时，表示文字的字体。默认为SimSun，宋体。具体支持的字体列表参见：字体列表。
FontSize	Int	否	当字幕类型为横幅文字时，表示文字的字号。
FontColor	String	否	当字幕类型为横幅文字时，表示文字的颜色，格式为#后跟16进制值。例如：#ffffff。
FontColorOpacity	String	否	当字幕类型为横幅文字时，表示文字的透明度，取值0-1，默认1。1为不透明，0为完全透明。
FontFace	FontFace	否	当字幕类型为横幅文字时，表示文字的字体外观。
Spacing	Int	否	当字幕类型为横幅文字时，表示横幅文字字间距。单位：像素值，默认为0。
Angle	Float	否	当字幕类型为横幅文字时，表示横幅文字逆时针旋转角度。单位：度，默认为0。
BorderStyle	Int	否	设置横幅文字边框和阴影格式。取值1或3，1=边框+阴影，3=不透明底框。默认为1。
Outline	Int	否	当字幕类型为横幅文字时，表示横幅文字描边宽度。单位：像素值，默认为0。
OutlineColour	String	否	当字幕类型为横幅文字时，表示横幅文字描边颜色，格式为#后跟16进制值。例如：#ffffff。
Shadow	Int	否	当字幕类型为横幅文字时，表示横幅文字投下阴影的深度，单位：像素值，默认为0。
BackColour	String	否	当字幕类型为横幅文字时，表示横幅文字阴影颜色，格式为#后跟16进制值。例如：#ffffff。
Alignment	String	否	当字幕类型为横幅文字时，用于设置定位对齐方式，默认为TopLeft。取值： TopLeft：视频左上角 TopCenter：视频竖直中轴线上侧 TopRight：视频右上角 CenterLeft：视频水平中轴线左侧 CenterCenter：视频中心位置 CenterRight：视频水平中轴线右侧 BottomLeft：视频左下角 BottomCenter：视频竖直中轴线下侧 BottomRight：视频右下角
AdaptMode	String	否	横幅文字当超出视频宽度或超出指定TextWidth时进行自动换行或缩放。取值： AutoWrap：自动换行 AutoScale：自动缩放 AutoWrapAtSpaces：只在空格位置自动换行（适用于纯英文字幕自动换行场景）
TextWidth	Integer	否	字幕文本框宽度，当设置AdaptMode时生效。将按照该值设置文本框宽度进行自动换行或缩放。不填写时，会按照视频宽度进行自动换行或缩放。单位：像素值。
FontUrl	String	否	当字幕类型为横幅文字时，支持使用用户OSS的字体文件路径来生成字幕，支持ttf、otf、woff三种格式的字体文件。例如：https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf
EffectColorStyle	String	否	当字幕类型为横幅文字时，表示横幅文字花字样式类型。花字种类及效果请参见花字效果示例。
AaiMotionInEffect	String	否	当字幕类型为横幅文字时，表示横幅文字入场特效类型。字幕入场特效种类及效果请参见入场特效。
AaiMotionIn	Float	否	当字幕类型为横幅文字时，表示横幅文字入场特效时长。单位：秒，精确到小数点后4位，如果AaiMotionIn不填，默认0.5s，如果文本时长小于0.5，则为总时长减去出场时长。
AaiMotionOutEffect	String	否	当字幕类型为横幅文字时，表示横幅文字出场特效类型。字幕出场特效种类及效果请参见出场特效。
AaiMotionOut	Float	否	当字幕类型为横幅文字时，表示横幅文字出场特效时长，单位秒，精确到小数点后4位，如果AaiMotionOut不填，默认0.5s，如果文本时长小于0.5，则为总文本时长。
AaiMotionLoopEffect	String	否	当字幕类型为横幅文字时，表示横幅文字循环特效类型，不可与字幕入场或者出场特效同时生效。循环特效种类以及效果请参见循环特效。
Ratio	Float	否	当字幕类型为横幅文字时，表示横幅文字循环特效播放速度，精确到小数点后4位。不填默认为1，大于1表示加速循环，小于1表示慢速循环。

EffectTrackItem：特效轨片段信息

特效轨片段EffectTrackItem，类型包括VFX、滤镜。

名称	类型	是否必填	描述
Type	String	是	特效轨片段类型，支持：VFX、Filter。
SubType	String	是	特效轨片段子类型，支持的特效种类及效果请参见特效效果示例及滤镜效果示例。
TimelineIn	Float	否	特效片段出现在时间线的起始位置。单位：秒，精确到小数点后4位。如果TimelineIn不填，则默认为0。
TimelineOut	Float	否	特效片段出现在时间线的结束位置。单位：秒，精确到小数点后4位。如果TimelineOut不填，则默认为视频结束时间。
Duration	Float	否	特效片段出现在时间线的持续时长。单位：秒，精确到小数点后4位。如果Duration不填，则默认为视频时长。说明 Duration和TimelineOut仅有一个生效。
X	Float	否	该字段仅支持SubType为mosaic_rect/blur的情况。特效区域左上角距离输出视频左上角的横向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频宽的占比。当取值为≥2的整数时，表示绝对像素。
Y	Float	否	该字段仅支持SubType为mosaic_rect/blur的情况。特效区域距离输出视频左上角的纵向距离。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频高的占比。当取值为≥2的整数时，表示绝对像素。
Width	Float	否	该字段仅支持SubType为mosaic_rect/blur的情况。特效区域在输出视频中的宽度。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频宽的占比。当取值为≥2的整数时，表示绝对像素。
Height	Float	否	该字段仅支持SubType为mosaic_rect/blur的情况。特效区域在输出视频中的高度。注：支持百分比和像素两种形式。当取值为[0～0.9999]时，表示相对输出视频高的占比。当取值为≥2的整数时，表示绝对像素。

FontFace：字体样式

名称	类型	是否必填	描述
Bold	Boolean	否	加粗。
Italic	Boolean	否	斜体。
Underline	Boolean	否	下划线。

Effect：特效信息

不同的效果类型，有不同的属性可以设置，同时有一些共通的属性。

各类Effect的独立属性描述，详情请参见Effect配置说明。

Effect通用属性如下：

名称

类型

是否必填

描述

Type

String

是

效果类型。取值：

Text：横幅文字，视频轨素材。
DeWatermark：遮标，视频轨素材。
Crop：裁剪，视频轨素材。
Scale：缩放，视频轨素材。
Pad：贴边，视频轨素材
Background：背景设置，视频轨素材。
Transition：转场，视频轨素材。
VFX：特效，视频轨素材。
Filter：滤镜，视频轨素材。
Volume：音量调整，音频轨素材。
AFade：音频淡入淡出，音频轨素材。
Rotate：素材旋转，视频轨素材。
Clip：随机截取。
Flip：翻转。
KenBurns：镜头推拉。
Zoom：变焦。

SubType

String

否

效果子类型。

当Type为Transition时，会进一步描述转场子类型。取值请参见转场效果示例。
当Type为VFX时，会进一步描述特效子类型。取值请参见特效效果示例。
当Type为Filter时，会进一步描述滤镜子类型。取值请参见滤镜效果示例。

视频截图/视频动图

SnapshotJob：截图作业信息

名称	类型	描述
JobId	String	作业ID。

VodTemplateInfo：截图模板信息

名称	类型	描述
Name	String	模板名称。
VodTemplateId	String	模板ID。
TemplateType	String	模板类型，取值： Snapshot：截图。 DynamicImage：动图。
IsDefault	String	是否默认，取值： Default：默认水印。 NotDefault：非默认水印。
TemplateConfig	JSON	模板详细配置，Json字符串，取值： Snapshot配置请参见SnapshotTemplateConfig。 DynamicImage配置请参见DynamicImageTemplateConfig。
CreationTime	String	创建时间，UTC格式。
ModifyTime	String	修改时间，UTC格式。

MediaSnapshot：媒体截图数据

名称	类型	描述
JobId	String	截图作业ID。
CreationTime	String	截图作业创建时间，为UTC时间。
Total	Long	截图总数。
Regular	String	截图地址生成规则。
Snapshots	Snapshot[]	截图数据。

Snapshot：截图信息

名称	类型	描述
Index	String	截图索引值。
Url	String	截图地址。

DynamicImage：动图信息

名称	类型	描述
VideoId	String	视频ID。
DynamicImageId	String	动图ID。
FileURL	String	动图文件地址。
Width	String	动图宽。
Height	String	动图高。
Duration	String	动图时长。
Format	String	动图格式，取值：gif或webp。
FileSize	String	动图文件大小。
Fps	String	动图帧率。

视频水印

WatermarkInfo：水印信息

名称	类型	是否必填	描述
CreationTime	String	是	水印创建时间。
Name	String	是	水印名称。
IsDefault	String	是	是否是默认水印，取值： Default：默认水印。 NotDefault：非默认水印。
Type	String	是	水印类型，取值： Image：图片。 Text：文字。
WatermarkId	String	是	水印ID。
FileUrl	String	否	水印文件URL（OSS地址或CDN地址），文字水印没有文件地址信息。
WatermarkConfig	WatermarkConfig	是	水印显示位置、效果等配置信息（JSON字符串）：文字水印、图片水印。

音视频转码

TranscodeJob：转码作业信息

名称	类型	描述
JobId	String	作业ID。

TranscodeTemplateGroup：转码模板组

名称	类型	是否必填	描述
Name	String	是	模板组的名称。
TranscodeTemplateGroupId	String	是	转码模板组ID。
IsDefault	String	是	是否是默认模板组，取值： Default：默认模板组。 NotDefault：非默认模板组。
CreationTime	String	是	模板组的创建时间。
ModifyTime	String	是	模板组的修改时间。
TranscodeTemplateList	TranscodeTemplate[]	是	转码模板配置信息列表。

TranscodeTemplate：转码模板配置

名称	类型	是否必填	描述
Type	String	否	模板类型，取值： Normal：正常转码模板。该类型模板不能设置PackageSetting参数。 VideoPackage：视频流打包模板。该类型模板会先转码,后构建自适应码流，且必须要配置PackageSetting参数。 SubtitlePackage：字幕打包模板。该类型模板不会转码，仅将对应字幕信息构建到自适应码率输出文件中，且必须要设置PackageSetting参数。但该类型模板不能在模板组中单独存在，需要与VideoPackage类型模板一同配置&一个模板组仅能配置一个该类型模板。默认值为Normal。
Video	Video	是	视频流转码配置参数（JSON字符串）。
Audio	Audio	是	音频流转码配置参数（JSON字符串）。
Definition	String	是	普通转码模板清晰度标记，取值： LD：流畅。 SD：标清。 HD：高清。 FHD：超清。 OD：原画，即转封装。 2K 4K SQ：普通音质。 HQ：高音质。说明此处清晰度仅为转码模板数据标记，不代表视频实际输出规格（分辨率范围），视频实际输出规格关系，更多信息请参见输出规格：Specification。此处清晰度标记与实际转码计费没有任何关系，转码计费规格（分辨率范围）。更多信息，请参见视频点播转码时长包。窄带高清1.0内置转码模板清晰度标记，取值： LD-NBV1：流畅。 SD-NBV1：标清。 HD-NBV1：高清。 FHD-NBV1：超清。 2K-NBV1 4K-NBV 说明所有转码模板不支持清晰度标记修改。窄带高清1.0转码模板音视频分辨率、码率等参数为系统内置，不支持修改，更多参数信息，请参见窄带高清TM1.0。窄带高清1.0转码模板创建只支持FLV、M3U8（HLS）、MP4格式。
Container	Container	是	封装音视频码流的容器格式（JSON字符串）。
MuxConfig	MuxConfig	否	转码的分片设置参数，HLS必传（JSON字符串）。
TransConfig	TransConfig	否	条件转码参数，如需要根据源片码率、分辨率进行基本逻辑判断再输出转码视频，则可设置该参数（JSON字符串）。
TranscodeFileRegular	String	否	自定义转码输出路径。说明支持通配符：{MediaId}（视频ID）、{JobId}（转码任务ID）、{PlayDefinition}（ GetPlayInfo返回的清晰度标记）。只支持数字、英文字符、{、}、/、-、_，最大允许128个字符。自定义输出路径必须以{MediaId}开头。配置示例 {MediaId}/watermark-{PlayDefinition}，则转码时会将对应的视频ID（例如：8ff5cc93f6da4079a47a77bf71d）替换掉{MediaId}，将清晰度标记（例如：fd）替换掉{PlayDefinition}。输出示例 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4（文件后缀名自动补齐，诸如：.mp4、.m3u8、.flv）。
Clip	Clip	否	视频裁剪配置（JSON字符串）。例如：需要截取视频中的5s内容，用于生成一个新的视频，则可设置该参数。
Rotate	String	否	视频旋转标参数，控制画面的旋转角度。取值范围：[0,360]。例如：设置180，则视频画面将上下颠倒。
EncryptSetting	EncryptSetting	否	转码加密配置信息。
PackageSetting	PackageSetting	否	打包配置，只支持HLS自适应码流打包、DASH打包（JSON字符串）。
SubtitleList	SubtitleConfig	否	字幕配置（JSON字符串）。
WatermarkIds	String[]	否	关联的水印ID，最大支持4个水印ID关联。USER_DEFAULT_WATERMARK关键字代表设置的默认水印对应的ID。
TranscodeTemplateId	String	否	转码模板ID，修改操作时必传。
TemplateName	String	否	转码模板名称，添加操作时必传。

TranscodeTemplate参数示例

{
        "Type":"VideoPackage",
        "Video":{
                "Codec":"H.264",
                "Bitrate":"900",
                "Width":"960",
                "Remove":"false",
                "Fps":"30"
        },
        "Audio":{
                "Codec":"AAC",
                "Bitrate":"128",
                "Samplerate":"44100"
        },
        "Container":{
                "Format":"m3u8"
        },
        "MuxConfig":{
                "Segment":{
                        "Duration":"6"
                }
        },
        "EncryptSetting":{
                "EncryptType":"AliyunVoDEncryption"
        },
        "PackageSetting":{
                "PackageType":"HLSPackage"
                "PackageConfig":{
                        "BandWidth":"900000"
                }
        },
       "SubtitleUrl": "http://outin-40564284ef058b2163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****-cn.ass",
        "CharEncode": "UTF-8",
        "WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
        "Definition":"SD",
        "TemplateName":"test"
}

Video：转码视频流配置

说明

无特殊需求，只需要设置Codec、Bitrate、Height、Width、Remove=false即可。
转码输出视频的Width（宽）、Height（高）建议只设置其中之一，这样可保持转码输出视频画面宽高比例与源片一致。

名称	类型	是否必填	描述
Codec	String	是	视频编码格式：H.264、H.265。
Remove	String	是	是否删除视频流，取值： true：表示转码输出文件会删除视频流 false：表示转码输出文件保留视频流默认值为false。
Bitrate	String	否	视频输出目标码率，不传递则根据Crf生成码率，单位：Kbps。取值范围：[10，50000]。
Height	String	否	视频输出的画面高（取值需为2的倍数），不传则为源文件高。单位：Px。取值范围：[128，4096]。
Width	String	否	视频输出的画面宽（取值需为2的倍数），不传则为源片宽。单位：Px。取值范围[128，4096]。
Fps	String	否	不传则为源文件帧率。单位：FPS。取值范围：(0,60]。
Gop	String	否	相邻关键帧的帧间距，单位：帧。取值范围：[1-100000]。
LongShortMode	String	否	开启横竖屏自适应（即：长短边模式），转码输出的宽对应输入片源的长边（竖屏为片源的高），高对应输入视频的短边（竖屏为片源的宽）。取值： true：开启。 false：关闭。默认值为true，适用于竖屏视频（推荐开启）。
Crf	String	否	码率质量控制因子，设置该参数则Bitrate参数无效，取值越大，转码视频画面质量越差，文件Size越小，反之画面质量越好，文件Size越大，但转码时间越长。取值范围：[0,51]。默认值为26（不推荐修改该参数）。
Profile	String	否	编码级别。取值： baseline：适合移动设备 main：适合标准分辨率设备 high：适合高分辨率设备默认值为high，目前仅H.264支持该参数。最佳实践如果您有多个清晰度，建议最低清晰度配成baseline，以保证最低端设备可播放。其他清晰度配置为main或high。
Preset	String	否	视频算法器预置。取值：veryfast、fast、medium、slow、slower。默认值为medium。目前仅H.264支持该参数，不推荐修改该参数。
ScanMode	String	否	扫描模式。取值： interlaced：隔行扫描。 progressive：逐行扫描。
Bufsize	String	否	缓冲区大小。单位：kb，取值范围：[1000,128000]。默认值为6000。
Maxrate	String	否	视频码率峰值，单位：kbps。取值范围：[1000,50000]。
PixFmt	String	否	视频颜色格式。取值：yuv420p，yuvj420p等标准颜色格式。默认值：yuv420p或原始颜色格式。

Video参数示例

{
        "Codec":"H.264",
        "Bitrate":"128",
        "Remove":"false",
        "Width":"640",
        "Fps":"30"
}

Audio：转码音频流配置

说明

无特殊需求时，只需要设置Codec、Bitrate、Remove=false即可。

名称	类型	是否必填	描述
Codec	String	是	音频编码格式：AAC、MP3。
Bitrate	String	是	音频输出目标码率，单位：Kbps。取值范围：[8，1000]。
Remove	String	是	是否删除音频流，取值： true：表示会删除转码输出文件的音频流。 false：表示会保留转码输出文件的音频流。默认值为false。
Samplerate	String	是	采样率单位为：Hz。取值：22050、32000、44100、48000、96000。默认值为44100。若视频容器格式为flv，音频编解码格式选择为mp3时，采样率不支持32000、48000、96000。音频编解码格式为mp3时，采样率不支持96000。
Channels	String	否	声道数。默认值为2。当Codec设置为mp3时，声道数只支持1、2。当Codec设置为aac时，声道数只支持1、2、4、5、6、8。
Profile	String	否	音频编码预置。当Codec为AAC时，取值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。
Volume	Volume	否	音量参数。

Audio参数示例

{
        "Codec":"AAC",
        "Bitrate":"128",
        "Remove":"false",
        "Samplerate":"44100"
}

Container：封装格式

名称

类型

是否必填

描述

Format

String

是

容器格式。

视频转码支持：FLV、MP4、HLS（M3U8+TS）。
音频转码支持：MP3、MP4。
容器格式为FLV时支持：Video Codec不能设置为H.265。

Container参数示例

{
        "Format":"mp4"
}

MuxConfig：HLS分片配置

说明

Container格式设置为m3u8，则必传该参数。

名称	类型	是否必填	描述
Segment	Segment	是	JSON对象，切片配置字段。

Segment：分片详细配置

名称

类型

是否必填

描述

Duration

String

是

TS分片时长，整数值，取值范围：[1，60]，单位：秒。

示例：{"Duration":"10"}。

MuxConfig参数示例

{
        "Segment":{
                "Duration":"10"
        }
}

TransConfig：条件转码配置

名称	类型	是否必填	描述
TransMode	String	否	转码模式。取值： onepass：通常用于ABR（Average Bitrate），比twopass的编码速度更快。是阿里云默认的编码方式。 twopass：通常用于VBR（Variable Bitrate），编码器执行两次来精准分配码率，以获取体积更小质量更高的编码结果。twopass模式相比onepass模式需要花费更多时间，所以无法使用在直播、实时通信等对转码时效性要求高的场景。以及若输入视频的压缩率已经很高，也不适合使用twopass，会出现块效应。 CBR：固定码率模式，指文件从头到尾都是一种码率。相对于VBR和ABR来讲，它压缩出来的文件体积较大，而且视频质量相对于VBR和ABR不会有明显的提高。默认值为onepass。
IsCheckReso	String	否	检查源片分辨率，判断是否按原片分辨率转码。取值： true：表示检查，如果输出分辨率大于输入分辨率（判断条件是宽或高），则输出分辨率等于输入分辨率。 false：表示不检查。默认值为false。
IsCheckResoFail	String	否	检查源片分辨率，判断是否为转码失败。取值： true：表示检查，如果输出分辨率大于输入分辨率（判断条件是宽或高），则返回转码失败。 false：表示不检查。默认值为false。
IsCheckVideoBitrate	String	否	检查源片视频流码率，判断是否按照源片视频流码率转码。取值： true：表示检查，如果视频输出码率大于视频输入码率，则视频输出码率等于视频输入码率。 false：表示不检查。默认值为false。
IsCheckVideoBitrateFail	String	否	检查源片视频流码率，判断是否为转码失败。取值： true：表示检查，当输出视频码率大于媒体源视频码率时，不进行转码。 false：表示不检查。默认值为false，此值优先级大于IsCheckVideoBitrate。
IsCheckAudioBitrate	String	否	检查源片音频流码率，判断是否为按照源片音频流码率转码。取值： true：表示检查，如果音频输出码率大于音频输入码率，则音频输出码率等于音频输入码率。 false：表示不检查。默认值为false。
IsCheckAudioBitrateFail	String	否	检查源片音频流码率，判断是否为转码失败。取值： true：表示检查，当输出音频码率大于媒体源音频码率时，不进行转码。 false：表示不检查。默认值为false，此值优先级大于IsCheckAudioBitrate。

TransConfig参数示例

{
        "IsCheckReso":"true",
        "IsCheckResoFail":"false",
        "IsCheckVideoBitrate":"false",
        "IsCheckVideoBitrateFail":"false",
        "IsCheckAudioBitrate":"false",
        "IsCheckAudioBitrateFail":"false"
}

Clip：视频裁剪设置

名称	类型	是否必填	描述
TimeSpan	TimeSpan	是	视频裁剪范围相关时间参数配置。

TimeSpan：视频裁剪设置

名称	类型	是否必填	描述
Seek	String	是	视频裁剪的开始时间。格式1：sssss[.SSS]，取值范围：[0.000，86399.999]。示例：12000.55。格式2：hh:mm:ss[.SSS]，取值范围：[00:00:00.000,23:59:59.999]。示例：00:00:05.003。推荐使用格式1。
Duration	String	否	视频裁剪的持续时长。格式1：sssss[.SSS]，取值范围：[0.000，86399.999]。示例：12000.55。格式2：hh:mm:ss[.SSS]，取值范围：[00:00:00.000,23:59:59.999]。示例：00:00:05.003。推荐使用格式1。说明 Duration与End参数必须设置一个，二者同时设置时，按设置的End参数处理。
End	String	否	视频裁剪需要丢弃的尾部时长。格式1：sssss[.SSS]，取值范围：[0.000，86399.999]。示例：12000.55。格式2：hh:mm:ss[.SSS]，取值范围：[00:00:00.000,23:59:59.999]。示例：00:00:05.003。推荐使用格式1。说明 Duration与End参数必须设置一个，二者同时设置时，按设置的End参数处理。开始时间和结束时间之间的时长，不能大于视频的总时长。

EncryptSetting：转码加密设置

说明

HLS标准加密需要先设置转码模板的EncryptType为AliyunVoDEncryption后，然后通过SubmitTranscodeJobs - 提交媒体转码作业接口发起标准加密转码时配置EncryptConfig。

名称

类型

是否必填

描述

EncryptType

String

是

加密类型，取值：

AliyunVoDEncryption：适用于HLS协议（M3U8格式）的私有加密类型、HLS标准加密类型。
AliyunVoDLicenseEncryption：适用于MP4格式的私有加密类型。

EncryptSetting参数示例

{
        "EncryptType":"AliyunVoDEncryption"
}

PackageSetting：转码打包设置

说明

暂不支持音视频流抽取后打包。
目前仅支持HLS自适应码率打包。

名称	类型	是否必填	描述
PackageType	String	是	打包类型，取值：HLSPackage（HLS自适应码率打包）。
PackageConfig	PackageConfig	否	打包配置信息（VideoPackage类型模板必传该参数）。
SubtitleExtractConfigList	SubtitleExtractConfig[]	否	字幕打包配置信息（SubtitlePackage类型模板必传该参数，其他类型模板不传）。

PackageConfig：视频打包配置

说明

仅HLS自适应码流打包需要设置该参数。

名称

类型

是否必填

描述

BandWidth

String

是

带宽上限，HLS打包必传该参数，单位：bps。

仅VideoPackage需要配置该参数。

PackageSetting参数示例

VideoPackage 类型模板配置：
{
        "PackageType":"HLSPackage",
        "PackageConfig":{
                "BandWidth":"400000"
        }
}

SubtitleExtractConfig：字幕打包配置

名称	类型	是否必填	描述
SubtitleUrlList	String[]	是	字幕地址，仅支持HTTP的OSS地址，不支持Http CDN地址和HTTPS地址。说明目前仅支持一个HTTP地址。字幕文件仅支持存储在点播分配的系统Bucket中。
Language	String	是	语言类型，请参考RFC5646，例如：en-US。
Format	String	是	字幕文件格式，仅支持vtt格式，例如：subtitle.vtt。
Name	String	是	字幕轨在播放终端显示的名称，例如：中文、英文等。

SubtitlePackage参数示例

SubtitlePackage 类型模板配置：
 {
      "PackageType": "HLSPackage",
      "SubtitleExtractConfigList": [
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d****-eng.vtt"
          ],
          "Language": "en-US",
          "Format": "vtt",
          "Name": "英文"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5****-jpn.vtt"
          ],
          "Language": "ja",
          "Format": "vtt",
          "Name": "日文"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8****-cn.vtt"
          ],
          "Language": "cn",
          "Format": "vtt",
          "Name": "中文"
        }
      ]
    }

SubtitleConfig：字幕配置

名称

类型

是否必填

描述

SubtitleUrl

String

是

字幕文件OSS地址（不支持HTTPS地址、不支持纯CDN域名加速地址）。字幕格式支持：srt、ass。

说明

字幕文件必须和视频源文件在同一个区域（例如：cn-shanghai），并且在同一个bucket当中。

CharEncode

String

是

编码格式。取值：

auto：自动检测。
UTF-8
GBK
BIG5

默认值为UTF-8。

说明

字幕文件上传详细参见获取辅助媒资上传地址和凭证、OSS文件上传。

SubtitleConfig参数示例

{
        "SubtitleUrl": "http://outin-40564284ef058b2d300163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****.ass",
        "CharEncode": "UTF-8"
}

Volume：音量配置

名称	类型	是否必填	描述
Method	String	否	音量调整方式。取值：auto、dynamic、linear。
IntegratedLoudnessTarget	String	否	目标音量，数字。取值范围：[-70,-5]。需指定Method为dynamic。默认值为-6。
TruePeak	String	否	最大峰值，数字。取值范围：[-9,0]。需指定Method为dynamic。默认值为-1。
LoudnessRangeTarget	String	否	音量范围，数字。取值范围：[1,20]。需指定Method为dynamic。默认值为8。

Volume参数示例

{
        "Method":"dynamic",
        "IntegratedLoudnessTarget":"-6",
        "TruePeak":"-1",
        "LoudnessRangeTarget":"8"
}

Container与Audio Codecs组合支持情况

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

Container与Audio Codecs、Video Codecs组合支持情况

Container	Video Codecs	Audio Codecs
flv	H.264	AAC、MP3
mp4	H.264、H.265	AAC、MP3
ts	H.264、H.265	AAC、MP3
m3u8	H.264、H.265	AAC、MP3
gif	GIF	不支持

Video Codecs与不同视频流配置参数的组合支持情况

Video Codecs	H.264	H.265	GIF
Profile	√	×	×
Bitrate	√	√	×
Crf	√	√	×
Width	√	√	√
Height	√	√	√
Fps	√	√	√
Gop	√	√	×
Preset	√	×	×
ScanMode	√	√	√
Bufsize	√	√	×
Maxrate	√	√	×
PixFmt	√	√	bgr8

TranscodeSummary：转码摘要信息

名称	类型	描述
VideoId	String	视频ID。
TranscodeTemplateGroupId	String	转码使用的模板组ID。
TranscodeStatus	String	转码处理状态，取值： Processing：处理中。 Partial：部分转码完成。 CompleteAllSucc：全部处理完成，且全部转码成功。 CompleteAllFail：全部处理完成，且全部转码失败,如果源片有问题，则不会发起任何转码作业，整个转码任务失败。 CompletePartialSucc：全部转码完成，但仅部分转码成功。
TranscodeJobInfoSummaryList	TranscodeJobInfoSummary[]	转码作业摘要信息列表。
CreationTime	String	转码任务创建时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ。
CompleteTime	String	转码任务完成时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ。

TranscodeJobInfoSummary：转码作业信息摘要

名称	类型	描述
TranscodeTemplateId	String	使用的转码模板ID。
Width	String	转码输出视频的画面宽，单位：Px。
Height	String	转码输出视频的画面高，单位：Px。
Duration	String	转码输出视频时长，单位：秒。
Filesize	String	转码输出视频的文件大小，单位：Byte。
Bitrate	String	转码输出视频的平均码率，单位：kbps。
Fps	String	转码输出视频的帧率，单位：N帧/秒。
Format	String	转码输出视频的封装格式。
WatermarkIdList	String[]	转码使用的水印列表。
TranscodeProgress	Long	转码进度，取值范围：[0,100]。
TranscodeJobStatus	String	转码作业状态，取值： Transcoding：转码中。 TranscodeSuccess：转码成功。 TranscodeFail：转码失败。
CreationTime	String	转码作业创建时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ
CompleteTime	String	转码作业完成时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ。
ErrorCode	String	转码失败的错误码。
ErrorMessage	String	转码失败的错误信息。

TranscodeTask：转码任务信息

名称	类型	描述
TranscodeTaskId	String	转码任务ID。
TranscodeTemplateGroupId	String	转码使用的模板组ID。
VideoId	String	视频ID。
TaskStatus	String	转码任务状态，取值： Processing：处理中。 Partial：部分转码完成。 CompleteAllSucc：全部处理完成，且全部转码成功。 CompleteAllFail：全部处理完成，且全部转码失败,如果源片有问题，则不会发起任何转码作业，整个转码任务失败。 CompletePartialSucc：全部转码完成，但仅部分转码成功。
CreationTime	String	转码任务创建时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ。
CompleteTime	String	转码任务完成时间，UTC时间：yyyy-MM-ddTHH:mm:ssZ。
Trigger	String	触发类型，取值： Auto：上传视频，自动触发。 Manual：调用SubmitTranscodeJobs接口触发。
TranscodeJobInfoList	TranscodeJobInfo	转码作业信息。

TranscodeJobInfo：转码作业信息

名称	类型	描述
TranscodeTaskId	String	转码任务ID。
TranscodeJobId	String	转码作业ID
VideoId	String	视频ID。
TranscodeProgress	Long	转码作业处理进度。取值范围：[0,100]。
TranscodeJobStatus	String	转码作业状态，取值： Transcoding：转码中。 TranscodeSuccess：转码成功。 TranscodeFail：转码失败。
Priority	String	转码任务优先级。
Definition	String	清晰度。说明该值为转码模板配置的清晰度标记，不表示转码输出文件实际的分辨率范围。
TranscodeTemplateId	String	转码使用的转码模板ID。
CreationTime	String	转码作业创建时间。
CompleteTime	String	转码作业完成时间。
InputFileUrl	String	转码源文件的OSS地址。
OutputFile	OutputFile	转码输出文件的信息。
ErrorCode	String	转码失败错误码。
ErrorMessage	String	转码失败错误信息。

OutputFile：转码输出文件

名称	类型	描述
OutputFileUrl	String	转码输出文件的OSS地址。
Format	String	转码输出文件的封装格式。
Width	String	转码输出文件视频画面宽，单位：Px。
Height	String	转码输出文件视频画面高，单位：Px。
Duration	String	转码输出文件时长，单位：秒。
Bitrate	String	转码输出文件平均码率，单位：kbps。
Fps	String	转码输出文件的帧率，单位：N帧/秒。
Filesize	Long	转码输出文件大小，单位：Byte。
EncryptType	String	转码输出文件使用的加密类型（JSON串）。
WatermarkIdList	String	转码输出文件使用的水印ID列表。
VideoStreamList	String	视频流列表。更多信息，请参见VideoStream：视频流信息。
AudioStreamList	String	音频流列表。更多信息，请参见AudioStream：音频流信息。

数据统计

TopPlayVideoStatis：视频播放每日TOP统计数据

名称	类型	描述
VideoId	String	视频ID。
PlayDuration	String	播放时长，单位：毫秒。
Title	String	视频名称。
VV	String	播放次数。
UV	String	播放用户数。

VideoPlayStatisDetail：指定视频每日统计数据

名称	类型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
PlayDuration	String	播放时长，单位：毫秒。
Title	String	视频名称。
VV	String	播放次数。
UV	String	播放用户数。
PlayRange	String	播放时长分布。

UserPlayStatisTotals：用户播放总量每日统计数据

名称	类型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
PlayDuration	String	播放总时长，单位：毫秒。
PlayRange	String	播放时长分布。
VV	VV	播放次数总量统计。
UV	UV	播放用户数总量统计。

UserPlayStatisAvgs：用户每日平均播放均值统计数据

名称	类型	描述
Date	String	日期，yyyyMMdd格式。例如"20170120"。
AvgPlayDuration	String	平均播放时长，单位：毫秒。
AvgPlayCount	String	平均播放次数。

播放数VV分布

仅支持阿里云点播播放器SDk的播放数据统计。

名称	类型	描述
Android	String	Android播放器播放总次数。
iOS	String	IOS播放器播放总次数。
Flash	String	Flash播放器播放总次数。
HTML5	String	Html5播放器播放总次数。

播放数UV分布

仅支持阿里云点播播放器SDk的播放数据统计。

名称	类型	描述
Android	String	Android播放器播放总用户数。
iOS	String	iOS播放器播放总用户数。
Flash	String	Flash播放器播放总用户数。
HTML5	String	HTML5播放器播放总用户数。

事件通知

MessageCallback：事件通知配置

名称	类型	描述
CallbackType	String	回调方式，取值：HTTP、MNS。
CallbackURL	String	回调方式选择HTTP时，回调地址。
MnsEndpoint	String	回调方式选择MNS时，消息队列公网Endpoint。
MnsQueueName	String	回调方式选择MNS时，消息队列名称。
EventTypeList	String	回调事件类型。
AuthSwitch	String	回调方式选择HTTP时，回调鉴权开关，取值： on：启用。 off：不启用。
AuthKey	String	回调方式选择HTTP时，鉴权Key。

多应用体系

AppInfo：应用信息

名称	类型	描述
AppId	String	应用ID。
AppName	String	应用名称。
Description	String	应用描述。
Type	String	应用类型，取值： System：系统默认。 Custom：用户创建。
Status	String	应用状态，取值： Normal：正常。 Disable：停用。
CreationTime	String	UTC创建时间。
ModificationTime	String	UTC更新时间。

AppPolicy：应用授权策略信息

名称	类型	描述
AppId	String	应用ID。
PolicyType	String	策略类型，取值： System：系统策略。 Custom：用户自定义。
PolicyName	String	策略名称。
CreationTime	String	UTC创建时间。
Description	String	策略描述。