基本数据类型
本文为您介绍点播API的基本数据类型。
Video:视频信息
名称 | 类型 | 描述 |
VideoId | String | 视频ID。 |
Title | String | 视频标题。 |
Description | String | 视频描述。 |
Duration | Float | 视频时长,单位:秒。 |
CoverURL | String | 视频封面URL。 |
String | 视频状态。 | |
CreationTime | String | 视频创建时间。使用UTC时间。 |
Size | Long | 视频源文件大小,单位:字节。 |
Snapshots | String[] | 视频截图URL数组。 |
CateId | Long | 视频分类ID。 |
CateName | String | 视频分类名称。 |
Tags | String | 视频标签,多个使用英文逗号(,)分隔。 |
TemplateGroupId | String | 视频转码时使用的转码组ID。 |
StorageLocation | String | 视频文件的存储地址。 |
String | 应用ID。 |
VideoBase:视频基本信息
名称 | 类型 | 描述 |
VideoId | String | 视频ID。 |
Title | String | 视频标题。 |
Duration | String | 视频时长,单位:秒。 |
CoverURL | String | 视频封面。 |
String | 视频状态。 | |
CreationTime | String | 视频创建时间。使用UTC时间。 |
MediaType | MediaType | 媒体文件类型。取值:
|
播放接口默认返回CDN加速地址。未配置域名时,播放接口返回OSS源站地址,此时只有MP4格式地址可用于播放。
Media:媒体信息
名称 | 类型 | 描述 |
MediaId | String | 媒体ID。 |
CreationTime | String | 媒体创建时间。使用UTC时间。 |
MediaType | String | 媒体文件类型。取值:
|
Video | 视频信息。 | |
Audio | 音频信息。 | |
Image | 图片信息。 | |
AttachedMedia | 辅助媒资信息。 |
PlayInfo:视频播放信息
名称 | 类型 | 描述 |
Bitrate | String | 视频流码率,单位:Kbps。 |
Definition | String | 视频流清晰度定义。取值:
|
Specification | String | 音视频转码输出规格,更多取值信息,请参见输出规格说明。 |
Duration | String | 视频流长度,单位:秒。 |
Encrypt | Long | 视频流是否加密流。取值:
|
EncryptType | String | 视频流加密类型。取值:
|
PlayURL | String | 视频流的播放地址。 |
Format | String | 视频流格式。 若媒体文件为视频,取值:
若是纯音频,取值:mp3。 |
Fps | String | 视频流帧率,每秒多少帧。 |
Size | Long | 视频流大小,单位:字节。 |
Width | Long | 视频流宽度,单位:Px。 |
Height | Long | 视频流高度,单位:Px。 |
StreamType | String | 媒体流类型。
|
JobId | String | 媒体流转码的作业ID,作为媒体流的唯一标识。 |
WatermarkId | String | 当前媒体流关联的水印ID。 |
Status | String | 视频流状态,取值:
|
NarrowBandType | String | 窄带高清类型。取值:
仅当配置了窄带高清1.0内置转码模板的清晰度时才会生效,更多信息,请见转码模板配置。 |
CreationTime | String | 创建时间。使用UTC时间。 |
ModificationTime | String | 更新时间。使用UTC时间。 |
VideoMeta:视频Meta信息
名称 | 类型 | 描述 |
VideoId | String | 视频ID。 |
Title | String | 视频标题。 |
Duration | Float | 视频时长,单位:秒。 |
CoverURL | String | 视频封面。 |
String | 视频状态。 |
Status:视频状态
取值 | 描述 | 备注 |
Uploading | 上传中 | 视频的初始状态,表示正在上传。 |
UploadFail | 上传失败 | 由于是断点续传,无法确定上传是否失败,故暂不会出现此值。 |
UploadSucc | 上传完成 | 无。 |
Transcoding | 转码中 | 无。 |
TranscodeFail | 转码失败 | 转码失败,一般是由于原片存在问题。可在事件通知的转码完成消息获取ErrorMessage失败信息。事件通知的详细信息,请参见视频转码完成。 转码失败的原因排查,请参见转码常见问题。 |
Checking | 审核中 | 在视频点播控制台 > 审核管理 > 审核设置 开启了先审后发,转码成功后视频状态会变成审核中,此时视频只能在控制台播放。 |
Blocked | 屏蔽 | 在审核时屏蔽视频。 |
Normal | 正常 | 视频可正常播放。 |
ProduceFail | 合成失败 | 无。 |
Status:图片状态
取值 | 描述 | 备注 |
Uploading | 上传中 | 初始状态,表示图片正在上传。 |
Normal | 正常 | 图片上传成功。 |
UploadFail | 失败 | 图片上传失败。 |
Category:媒资分类
名称 | 类型 | 描述 |
CateId | Long | 视频分类ID。 |
CateName | String | 分类名称,最大64字节,UTF8编码。 |
ParentId | Long | 父分类ID,一级分类父ID为-1。 |
Level | Long | 分类层级,一级分类层级为0。 |
Mezzanine:源文件信息
名称 | 类型 | 描述 |
VideoId | String | 视频ID。 |
FileName | String | 文件名称。 |
Duration | String | 文件时长,单位:秒。 |
Status | String | 源文件状态。 |
CreationTime | String | 文件创建时间。使用UTC时间。 |
Height | Long | 文件高度,单位:Px。 |
Width | Long | 文件宽度,单位:Px。 |
Fps | String | 文件帧率,每秒多少帧。 |
FileURL | String | 文件地址。 |
Bitrate | String | 文件码率,单位:Kbps。 |
Size | Long | 文件大小,单位:字节。 |
OutputType | String | 输出文件类型。取值:
|
VideoStreamList | 视频流信息列表。 | |
AudioStreamList | 音频流信息列表。 |
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 | 删除 | 文件被删除。 |
LiveRecordVideo:直转点录制视频信息
名称 | 类型 | 描述 |
StreamName | String | 直播流名称。 |
DomainName | String | 域名。 |
AppName | String | App名称。 |
PlaylistId | String | 播单ID。 |
RecordStartTime | String | 录制开始时间。 |
RecordEndTime | String | 录制结束时间。 |
Video | Video | 视频信息。 |
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播放器播放总用户数。 |
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。 |
Timeline:时间线信息
名称 | 类型 | 描述 |
Id | String | 云剪辑工程ID。 |
Title | String | 云剪辑工程标题。 |
CreationTime | String | 时间线创建时间。 |
ModifiedTime | String | 时间线最近修改时间。 |
Duration | Float | 时间线总时长。单位:秒,精确到小数点后4位。 |
CurrentRuler | Float | 时间线当前的比例尺大小。 当timeline不用于编辑过程中保存数据。仅用于合成时,该字段可不填。 |
CurrentPosition | Float | 云剪辑工程时码竖线所处的位置。单位:秒,精确到小数点后4位。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
VideoTracks | 视频轨列表。 |
VideoTrack:视频轨信息
名称 | 类型 | 描述 |
Count | Int | 视频轨素材片段总数。 |
Duration | String | 视频轨总时长。 |
VideoTrackClips | 视频轨素材片段列表。 |
VideoTrackClip:视频轨素材信息
名称 | 类型 | 描述 |
Id | String | 素材片段Id。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 当timeline用于编辑时,该字段在此timeline内部不可重复。 |
VideoId | String | 素材片段所对应的素材ID。 |
Type | String | 素材片段类型。取值:
默认值为Video。 |
Title | String | 素材片段标题,默认与其所对应的素材标题相同。 |
Index | Int | 素材片段在时间线中的顺序,从0开始。 |
CutFlag | Boolean | 剪切标识,记录素材片段是否被剪切过。取值:true或false。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
TextFlag | Boolean | 横幅文字标识,记录素材片段是否被添加过横幅文字。取值:true或false。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
DeWatermarkFlag | Boolean | 遮标标识,记录素材片段是否进行过遮标处理。取值:true或false。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
URL | String | 素材片段剪辑所使用的流URL。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
CoverURL | String | 素材片段封面URL,默认与其所对应的素材封面URL相同。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
SpriteURLs | String | 素材片段雪碧图URL,多张雪碧图使用英文逗号(,)分隔。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
Width | Int | 素材片段剪辑所使用的流的宽度。单位:Px。 当timeline不用于编辑过程中保存数据,仅用于合成,且合成时未加特效(横幅文字或遮标)时,该字段可不填。 |
Height | Int | 素材片段剪辑所使用的流的高度。单位:Px。 当timeline不用于编辑过程中保存数据,仅用于合成,且合成时未加特效(横幅文字或遮标)时,该字段可不填。 |
Fps | Float | 素材片段的帧率。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
Bitrate | Float | 素材片段用于剪辑流的码率。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
In | Float | 素材片段相对于素材的入点。单位:秒,精确到小数点后4位。 |
Out | Float | 素材片段相对于素材的出点。单位:秒,精确到小数点后4位。 |
Duration | Float | 素材片段的时长。单位:秒,精确到小数点后4位。 |
VirginDuration | Float | 素材片段所对应的素材完整时长。单位:秒,精确到小数点后4位。 当timeline不用于编辑过程中保存数据,仅用于合成时,该字段可不填。 |
TimelineIn | Float | 素材片段相对于时间线的入点。单位:秒,精确到小数点后4位。 |
TimelineOut | Float | 素材片段相对于时间线的出点。单位:秒,精确到小数点后4位。 |
Effects | Effect[] | 素材片段的特效列表。 |
Effect:特效信息
名称 | 类型 | 描述 |
Type | String | 特效类型。取值:
|
Name | String | 特效名称。 |
SubType | String | 特效子类型。 当Type取值为DeWatermark时,SubType取值为Delogo_Blur。 |
In | Float | 特效相对于素材片段的入点。单位:秒,精确到小数点后4位。 |
Out | Float | 特效相对于素材片段的出点。单位:秒,精确到小数点后4位。 |
TimelineIn | Float | 特效相对于时间线的入点。单位:秒,精确到小数点后4位。 |
TimelineOut | Float | 特效相对于时间线的出点。单位:秒,精确到小数点后4位。 |
X | String | 相对画面TopLeft的偏移位置x坐标。值有两种形式:
|
Y | String | 相对画面TopLeft的偏移位置y坐标。值有两种形式:
|
Width | Int | 特效区域的宽。值有两种形式:
|
Height | Int | 特效区域的高。值有两种形式:
|
FEWidth | Float | 剪辑时,视频画面的实际显示宽。单位:Px。 |
FEHeight | Float | 剪辑时,视频画面的实际显示高。单位:Px。 |
Font | String | 字体。取值:SimSun(宋体)。 |
FontFace | 字体外观。 | |
FontColor | String | 字体颜色,格式为#后跟16进制值。例如:#ffffff。 |
FontSize | Int | 字体大小。 |
FontColorOpacity | Float | 字体透明度。取值范围:0~1。1为不透明,0为完全透明。 |
Content | String | 横幅文字内容。 |
FontFace:字体样式
名称 | 类型 | 描述 |
Bold | Boolean | 加粗。 |
Italic | Boolean | 斜体。 |
Underline | Boolean | 下划线。 |
MediaMetadata:媒体资源元数据
名称 | 类型 | 描述 |
Title | String | 合成视频标题,长度不超过128个字节,UTF8编码。 |
Description | String | 合成视频描述,长度不超过1024个字节,UTF8编码。 |
CoverURL | String | 合成视频自定义封面URL地址。 |
CateId | String | 合成视频分类ID,请在视频点播控制台 > 配置管理 > 媒资管理配置 > 分类管理 里编辑或查看分类的ID。 |
Tags | String | 合成视频标签,单个标签不超过32字节,最多不超过16个标签。多个标签使用英文逗号(,)分隔,UTF8编码。 |
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 | 文件的存储地址(除上海区域外的其他区域必填)。 |
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数组。 |
ProjectStatus:云剪辑工程状态
取值 | 描述 | 备注 |
Normal | 草稿 | 云剪辑工程创建的初始状态。 |
Producing | 合成中 | 无 |
Produced | 合成成功 | 无 |
ProduceFaile | 合成失败 | 无 |
TranscodeJob:转码作业信息
名称 | 类型 | 描述 |
JobId | String | 作业ID。 |
SnapshotJob:截图作业信息
名称 | 类型 | 描述 |
JobId | String | 作业ID。 |
MediaSnapshot:媒体截图数据
名称 | 类型 | 描述 |
JobId | String | 截图作业ID。 |
CreationTime | String | 截图作业创建时间,为UTC时间。 |
Total | Long | 截图总数。 |
Regular | String | 截图地址生成规则。 |
Snapshots | Snapshot[] | 截图数据。 |
Snapshot:截图信息
名称 | 类型 | 描述 |
Index | String | 截图索引值。 |
Url | String | 截图地址。 |
WatermarkInfo:水印信息
参数名称 | 参数类型 | 必填项 | 描述 |
CreationTime | String | 是 | 水印创建时间。 |
Name | String | 是 | 水印名称。 |
IsDefault | String | 是 | 是否是默认水印,取值:
|
Type | String | 是 | 水印类型,取值:
|
WatermarkId | String | 是 | 水印ID。 |
FileUrl | String | 否 | 水印文件URL(OSS地址或CDN地址),文字水印没有文件地址信息。 |
WatermarkConfig | 是 | 水印显示位置、效果等配置信息(JSON字符串):文字水印、图片水印。 |
VodTemplateInfo:模板信息
字段名称 | 类型 | 描述 |
Name | String | 模板名称。 |
VodTemplateId | String | 模板ID。 |
TemplateType | String | 模板类型,取值:
|
IsDefault | String | 是否默认,取值:
|
TemplateConfig | JSON | 模板详细配置,Json字符串,取值:
|
CreationTime | String | 创建时间,UTC格式。 |
ModifyTime | String | 修改时间,UTC格式。 |
DynamicImageTemplateConfig:动图模板配置信息
字段名称 | 类型 | 描述 |
Name | String | 模板名称。 |
Video | 动图画面参数配置。 | |
Container | 动图输出格式配置。 | |
Clip | 动图裁剪参数配置。 | |
SetDefaultCover | String | 是否设置成默认封面,取值:
|
Video:动图画面配置
取值 | 类型 | 必填项 | 描述 |
Width | String | 是 | 动图宽,取值范围:[128,4096]。 |
Height | String | 是 | 动图高,取值范围:[128,4096]。 |
Fps | String | 是 | 帧率,取值范围:(0,60]。 |
Container:动图输出格式配置
取值 | 类型 | 必填项 | 描述 |
Format | String | 是 | 格式,取值:webp、gif。 |
Clip:动图裁剪配置
取值 | 类型 | 必填项 | 描述 |
TimeSpan | 是 | 动图裁剪范围相关时间参数配置。 |
TimeSpan:动图裁剪时间线配置
取值 | 类型 | 必填项 | 描述 |
Seek | String | 是 | 视频裁剪的开始时间。
|
Duration | String | 是 | 视频裁剪的持续时长。
|
End | String | 是 | 视频裁剪需要丢弃的尾部时长。
|
TranscodeTemplateGroup:转码模板组
字段名称 | 类型 | 必填项 | 描述 |
Name | String | 是 | 模板组的名称。 |
TranscodeTemplateGroupId | String | 是 | 转码模板组ID。 |
IsDefault | String | 是 | 是否是默认模板组,取值:
|
CreationTime | String | 是 | 模板组的创建时间。 |
ModifyTime | String | 是 | 模板组的修改时间。 |
TranscodeTemplateList | 是 | 转码模板配置信息列表。 |
TranscodeTemplate:转码模板配置
名称 | 类型 | 必填项 | 描述 |
Type | String | 否 | 模板类型,取值:
默认值为Normal。 |
Video | 是 | 视频流转码配置参数(JSON字符串)。 | |
Audio | 是 | 音频流转码配置参数(JSON字符串)。 | |
Definition | String | 是 | 普通转码模板清晰度标记,取值:
窄带高清1.0内置转码模板清晰度标记,取值:
说明
|
Container | 是 | 封装音视频码流的容器格式(JSON字符串)。 | |
MuxConfig | 否 | 转码的分片设置参数,HLS必传(JSON字符串)。 | |
TransConfig | 否 | 条件转码参数,如需要根据源片码率、分辨率进行基本逻辑判断再输出转码视频,则可设置该参数(JSON字符串)。 | |
TranscodeFileRegular | String | 否 | 自定义转码输出路径。 说明
配置示例 {MediaId}/watermark-{PlayDefinition},则转码时会将对应的视频ID(例如:8ff5cc93f6da4079a47a77bf71d)替换掉{MediaId},将清晰度标记(例如:fd)替换掉{PlayDefinition}。 输出示例8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4(文件后缀名自动补齐,诸如:.mp4、.m3u8、.flv)。 |
Clip | 否 | 视频裁剪配置(JSON字符串)。 例如:需要截取视频中的5s内容,用于生成一个新的视频,则可设置该参数。 | |
Rotate | String | 否 | 视频旋转标参数,控制画面的旋转角度。取值范围:[0,360]。 例如:设置180,则视频画面将上下颠倒。 |
EncryptSetting | 否 | 转码加密配置信息。 | |
PackageSetting | 否 | 打包配置,只支持HLS自适应码流打包、DASH打包(JSON字符串)。 | |
SubtitleList | 否 | 字幕配置(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-40564284ef058b2163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e-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 | 是 | 是否删除视频流,取值:
默认值为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,适用于竖屏视频 (推荐开启)。 |
Crf | String | 否 | 码率质量控制因子,设置该参数则Bitrate参数无效,取值越大,转码视频画面质量越差,文件Size越小,反之画面质量越好,文件Size越大,但转码时间越长。取值范围:[0,51]。 默认值为26(不推荐修改该参数)。 |
Profile | String | 否 | 编码级别。取值:
默认值为high,目前仅H.264支持该参数。 最佳实践 如果您有多个清晰度,建议最低清晰度配成baseline,以保证最低端设备可播放。其他清晰度配置为main或high。 |
Preset | String | 否 | 视频算法器预置。取值:veryfast、fast、medium、slow、slower。 默认值为medium。目前仅H.264支持该参数,不推荐修改该参数。 |
ScanMode | String | 否 | 扫描模式。取值:
|
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 | 是 | 是否删除音频流,取值:
默认值为false。 |
Samplerate | String | 是 | 采样率单位为:Hz。取值:22050、32000、44100、48000、96000。 默认值为44100。 若视频容器格式为flv,音频编解码格式选择为mp3时,采样率不支持32000、48000、96000。 音频编解码格式为mp3时,采样率不支持96000。 |
Channels | String | 否 | 声道数。默认值为2。
|
Profile | String | 否 | 音频编码预置。当Codec为AAC时,取值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。 |
Volume | 否 | 音量参数。 |
Audio参数示例
{
"Codec":"AAC",
"Bitrate":"128",
"Remove":"false",
"Samplerate":"44100"
}
Container:封装格式
参数名称 | 参数类型 | 是否必传 | 描述 |
Format | String | 是 | 容器格式。
|
Container参数示例
{
"Format":"mp4"
}
MuxConfig:HLS分片配置
Container格式设置为m3u8,则必传该参数。
参数名称 | 参数类型 | 是否必传 | 描述 |
Segment | 是 | JSON对象,切片配置字段。 |
Segment:分片详细配置
参数名称 | 参数类型 | 是否必传 | 描述 |
Duration | String | 是 | TS分片时长,整数值,取值范围:[1,60],单位:秒。 示例:{"Duration":"10"}。 |
MuxConfig参数示例
{
"Segment":{
"Duration":"10"
}
}
TransConfig:条件转码配置
参数名称 | 参数类型 | 是否必传 | 描述 |
TransMode | String | 否 | 转码模式。取值:onepass、twopass、CBR。默认值为onepass。 |
IsCheckReso | String | 否 | 检查源片分辨率,判断是否按原片分辨率转码。取值:
默认值为false。 |
IsCheckResoFail | String | 否 | 检查源片分辨率,判断是否为转码失败。取值:
默认值为false。 |
IsCheckVideoBitrate | String | 否 | 检查源片视频流码率,判断是否按照源片视频流码率转码。取值:
默认值为false。 |
IsCheckVideoBitrateFail | String | 否 | 检查源片视频流码率,判断是否为转码失败。取值:
默认值为false,此值优先级大于IsCheckVideoBitrate。 |
IsCheckAudioBitrate | String | 否 | 检查源片音频流码率,判断是否为按照源片音频流码率转码。取值:
默认值为false。 |
IsCheckAudioBitrateFail | String | 否 | 检查源片音频流码率,判断是否为转码失败。取值:
默认值为false,此值优先级大于IsCheckVideoBitrate。 |
TransConfig参数示例
{
"IsCheckReso":"true",
"IsCheckResoFail":"false",
"IsCheckVideoBitrate":"false",
"IsCheckVideoBitrateFail":"false",
"IsCheckAudioBitrate":"false",
"IsCheckAudioBitrateFail":"false"
}
Clip:视频裁剪设置
名称 | 类型 | 必填项 | 描述 |
TimeSpan | 是 | 视频裁剪范围相关时间参数配置。 |
TimeSpan:视频裁剪设置
名称 | 类型 | 必填项 | 描述 |
Seek | String | 是 | 视频裁剪的开始时间。
推荐使用格式1。 |
Duration | String | 否 | 视频裁剪的持续时长。
推荐使用格式1。 |
End | String | 否 | 视频裁剪需要丢弃的尾部时长。
推荐使用格式1。 说明
|
说明:Duration与End参数二选一设置。
EncryptSetting:转码加密设置
标准加密需要先设置转码模板为私有加密(Private),然后通过SubmitTranscodeJobs接口发起标准加密转码。
名称 | 类型 | 必填项 | 描述 |
EncryptType | String | 是 | 加密类型,取值: AliyunVoDEncryption(私有加密),仅对HLS(M3U8)生效。 |
EncryptSetting参数示例
{
"EncryptType":"AliyunVoDEncryption"
}
PackageSetting:转码打包设置
暂不支持音视频流抽取后打包
目前仅支持HLS自适应码率打包
名称 | 类型 | 必填项 | 描述 |
PackageType | String | 是 | 打包类型,取值:HLSPackage(HLS自适应码率打包)。 |
PackageConfig | 否 | 打包配置信息(VideoPackage类型模板必传该参数)。 | |
SubtitleExtractConfigList | 否 | 字幕打包配置信息(SubtitlePackage类型模板必传该参数,其他类型模板不传)。 |
PackageConfig:视频打包配置
暂时只有HLS自适应码流打包需要设置该参数。
名称 | 类型 | 必填项 | 描述 |
BandWidth | String | 是 | 带宽上限,HLS打包必传该参数,单位:bps。 仅VideoPackage需要配置该参数。 |
PackageSetting参数示例
VideoPackage 类型模板配置:
{
"PackageType":"HLSPackage",
"PackageConfig":{
"BandWidth":"400000"
}
}
SubtitleExtractConfig:字幕打包配置
名称 | 类型 | 必填项 | 描述 |
SubtitleUrlList | String[] | 是 | 字幕地址,仅支持HTTP的OSS地址,不支持Http CDN地址和HTTPS地址。 说明
|
Language | String | 是 | 语言类型,请参考RFC5646,例如:en-US。 |
Format | String | 是 | 字幕文件格式,仅支持vtt格式,例如:subtitle.vtt。 |
Name | String | 是 | 字幕轨在播放终端显示的名称,例如:中文、英文等。 |
SubtitlePackage参数示例
SubtitlePackage 类型模板配置:
{
"PackageType": "HLSPackage",
"SubtitleExtractConfigList": [
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d69ca-eng.vtt"
],
"Language": "en-US",
"Format": "vtt",
"Name": "英文"
},
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5e87e-jpn.vtt"
],
"Language": "ja",
"Format": "vtt",
"Name": "日文"
},
{
"SubtitleUrlList": [
"http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8bff3-cn.vtt"
],
"Language": "cn",
"Format": "vtt",
"Name": "中文"
}
]
}
SubtitleConfig:字幕配置
名称 | 类型 | 必填项 | 描述 |
SubtitleUrl | String | 是 | 字幕文件OSS地址(不支持HTTPS地址、不支持纯CDN域名加速地址)。字幕格式支持:srt、ass。 说明 字幕文件必须和视频源文件在同一个区域(例如:cn-shanghai),并且在同一个bucket当中。 |
CharEnc | String | 是 | 编码格式。取值:
默认值为UTF-8。 |
字幕文件上传详细参见获取辅助媒资上传地址和凭证、OSS文件上传。
SubtitleConfig参数示例
{
"SubtitleUrl": "http://outin-40564284ef058b2d300163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e.ass",
"CharEncode": "UTF-8"
}
Volume:音量配置
参数名称 | 参数类型 | 是否必传 | 描述 |
Method | String | 否 | 音量调整方式。取值:auto、dynamic、linear。 |
IntegratedLoudnessTarget | String | 否 | 目标音量,数字。取值范围:[-70,-5]。需指定Method为dynamic。 默认值为-6。 |
TruePeak | String | 否 | 最大峰值,数字。取值范围:[-9,0]。需指定Method为dynameic。 默认值为-1。 |
LoudnessRangeTarget | String | 否 | 音量范围,数字。取值范围:[1,20]。需指定Method为dynamic。 默认值为8。 |
Volume参数示例
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"auto",
"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 | 转码处理状态,取值:
|
TranscodeJobInfoSummaryList | 转码作业摘要信息列表。 | |
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 | 转码作业状态,取值:
|
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 | 转码任务状态,取值:
|
CreationTime | String | 转码任务创建时间,UTC时间:yyyy-MM-ddTHH:mm:ssZ。 |
CompleteTime | String | 转码任务完成时间,UTC时间:yyyy-MM-ddTHH:mm:ssZ。 |
Trigger | String | 触发类型,取值:
|
TranscodeJobInfoList | 转码作业信息。 |
TranscodeJobInfo:转码作业信息
名称 | 类型 | 描述 |
TranscodeTaskId | String | 转码任务ID。 |
TranscodeJobId | String | 转码作业ID |
VideoId | String | 视频ID。 |
TranscodeProgress | Long | 转码作业处理进度。取值范围:[0,100]。 |
TranscodeJobStatus | String | 转码作业状态,取值:
|
Priority | String | 转码任务优先级。 |
Definition | String | 清晰度。 说明 该值为转码模板配置的清晰度标记,不表示转码输出文件实际的分辨率范围。 |
TranscodeTemplateId | String | 转码使用的转码模板ID。 |
CreationTime | String | 转码作业创建时间。 |
CompleteTime | String | 转码作业完成时间。 |
InputFileUrl | String | 转码源文件的OSS地址。 |
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 | 视频流列表。更多信息,请参见视频流信息。 |
AudioStreamList | String | 音频流列表。更多信息,请参见音频流信息。 |
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 | 图片源信息 | |
CreationTime | String | 图片创建时间。使用UTC时间。 |
String | 图片状态。 | |
String | 应用ID。 |
Mezzanine:图片源信息
名称 | 类型 | 描述 |
FileURL | String | 图片OSS URL。 |
OriginalFileName | String | 上传文件名称。 |
FileSize | Long | 文件大小,单位:字节。 |
Width | Integer | 图片宽度,单位:Px。 |
Height | Integer | 图片高度,单位:Px。 |
DynamicImage:动图信息
名称 | 类型 | 描述 |
VideoId | String | 视频ID。 |
DynamicImageId | String | 动图ID。 |
FileURL | String | 动图文件地址。 |
Width | String | 动图宽。 |
Height | String | 动图高。 |
Duration | String | 动图时长。 |
Format | String | 动图格式,取值:gif或webp。 |
FileSize | String | 动图文件大小。 |
Fps | String | 动图帧率。 |
URLUploadInfo:URL上传信息
名称 | 类型 | 描述 |
JobId | String | Job ID。 |
UploadURL | String | 上传URL地址。 |
MediaId | String | 上传视频ID。 |
String | 视频状态。 | |
String | 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 | 任务成功,且回调完成。 |
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时间。 |
String | 辅助媒资状态。 | |
AppId | String | 应用ID。 |
Status:辅助媒资状态
取值 | 描述 | 备注 |
Uploading | 上传中 | 初始状态,表示辅助媒资正在上传。 |
Normal | 正常 | 辅助媒资上传成功。 |
UploadFail | 失败 | 辅助媒资上传失败。 |
MessageCallback:事件通知配置
名称 | 类型 | 描述 |
CallbackType | String | 回调方式,取值:HTTP、MNS。 |
CallbackURL | String | 回调方式选择HTTP时,回调地址。 |
MnsEndpoint | String | 回调方式选择MNS时,消息队列公网Endpoint。 |
MnsQueueName | String | 回调方式选择MNS时,消息队列名称。 |
EventTypeList | String | 回调事件类型。 |
AuthSwitch | String | 回调方式选择HTTP时,回调鉴权开关,取值:
|
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 | 策略描述。 |