您可以查看以下数据类型。

AliyunProperties

属性类型

名称类型描述
FormatAliyunFormatInfo格式信息。
StreamsAliyunStreamsInfo流信息。

AliyunFormatInfo

格式信息类型

名称类型描述
NumStreamsString媒体流总数。
NumProgramsString节目流总数。
FormatNameString容器、封装格式简述名。
FormatLongNameString容器、封装格式长述名。
StartTimeString起始时间。
DurationString总时长。
SizeString文件大小。
BitrateString总码率。

AliyunStreamsInfo

流信息类型

名称类型描述
VideoStreamListAliyunVideoStream[]视频流列表。
AudioStreamListAliyunAudioStream[]音频流列表。
SubtitleStreamListAliyunSubtitleStream[]字幕流列表。

AliyunVideoStream

视频流信息类型

名称类型描述
IndexString视频流序号,标识视频流在整个媒体流中的位置。
CodecNameString编码格式简述名。
CodecLongNameString编码格式长述名。
ProfileString编码预置。
CodecTimeBaseString编码时基。
CodecTagStringString编码格式标记文本。
CodecTagString编码格式标记。
WidthString视频分辨率宽,数字。
HeightString视频分辨率长。
HasBFramesString是否有B帧。
SarString编码信号分辨率比。
DarString编码显示分辨率比。
PixFmtString像素格式。
LevelString编码等级。
FpsString帧率,数字。
AvgFPSString平均帧率。
TimebaseString时基。
StartTimeString起始时间。
DurationString时长。
BitrateString码率。
NumFramesString总帧数。
LangString语言。

参考FFmpeg语言定义ISO-639

RotateString视频旋转角度。

AliyunAudioStream

音频流信息类型

名称类型描述
IndexString音频流序号,标识音频流在整个媒体流中的位置。
CodecNameString编码格式简述名。
CodecLongNameString编码格式长述名。
CodecTimeBaseString编码时基。
CodecTagStringString编码格式标记文本。
CodecTagString编码格式标记。
SampleFmtString采样格式。
SamplerateString采样率。
ChannelsString声道数。
ChannelLayoutString声道输出样式。
TimebaseString时基。
StartTimeString起始时间。
DurationString时长。
BitrateString码率。
NumFramesString总帧数。
LangString语言。

参考FFmpeg语言定义ISO-639

AliyunSubtitleStream

字幕流信息类型

名称类型描述
IndexString字幕流序号,标识字幕流在整个媒体流中的位置。
LangString语言。

参考FFmpeg语言定义ISO-639

AliyunTemplate

转码模板类型

名称类型描述
IdString转码模板ID。
NameString模板名称。
ContainerAliyunContainer容器。
AudioAliyunAudioCodec音频编解码配置。
VideoAliyunVideoCodec视频编解码配置。
TransConfigAliyunTransConfig转码通用配置。
MuxConfigAliyunMuxConfig转码封包配置。
StateString模板的状态,分为Normal、Deleted。

AliyunContainer

容器类型

名称类型描述
FormatString容器格式。可选范围flv、mp4、ts、m3u8、gif、mp3、ogg、flac。

AliyunAudioCodec

音频编解码配置类型

名称类型描述
CodecString音频编解码格式。
  • 支持aac、mp3、vorbis、flac。
  • 默认值:aac。
ProfileString音频编码预置。

当Codec为aac时可以设置如下范围中的值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。

SamplerateString采样率。
  • 支持22050、32000、44100、48000、96000。
  • 单位:Hz。
  • 默认值:44100。
BitrateString输出文件的音频码率。
  • 取值范围:[8,1000]。
  • 单位:Kbps。
  • 默认值:128。
ChannelsString声道数。
  • 支持1、2、3、4、5、6、7、8。
  • 默认值:2。

AliyunVideoCodec

视频编解码配置类型

名称类型描述
CodecString编解码格式。
  • 支持H.264、H.265。
  • 默认值:H.264。
ProfileString编码级别。
支持baseline、main、high。
  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。
  • 默认值:high。
BitrateString视频平均码率。
  • 取值范围:[10,50000]。
  • 单位:Kbps。
CrfString码率-质量控制因子。
  • 取值范围:[0,51]。
  • 默认值:编码格式为H264,默认值为23。编码格式为H265,默认值为26。
  • 如果设置了Crf,则Bitrate的设置失效。
WidthString宽。
  • 取值范围:[128,4096]。
  • 单位:px。
  • 默认值:视频原始宽度。
HeightString高。
  • 取值范围:[128,4096]。
  • 单位:px。
  • 默认值:视频原始高度。
FpsString帧率。
  • 取值范围:(0,60]。
  • 当输入文件帧率超过60时取60。
  • 默认值:取输入文件帧率。
GopString关键帧间最大帧数。
  • 取值范围:[1,1080000]。
  • 默认值:250。
PresetString视频算法器预置。
  • 支持veryfast、fast、medium、slow、slower。
  • 默认值:medium。
ScanModeString扫描模式。

支持interlaced、progressive。

BufsizeString缓冲区大小。
  • 取值范围:[1000,128000]。
  • 单位:Kb。
  • 默认值:6000。
MaxrateString视频码率峰值。
  • 取值范围:[10,50000]。
  • 单位:Kbps。
BitrateBndAliyunBitrateBnd视频平均码率范围。
PixFmtString视频颜色格式。范围:yuv420p,yuvj420p等标准颜色格式。

AliyunTransConfig

转码通用配置类型

名称类型描述
TransModeString转码模式。
  • 可选范围onepass、twopass、CBR。
  • 默认值:onepass。

AliyunBitrateBnd

平均码率范围

名称类型描述
MaxString总码率上限。
  • 取值范围:[10,50000]。
  • 单位:Kbps。
MinString总码率下限。
  • 取值范围:[10,50000]。
  • 单位:Kbps。

AliyunOSSFile

OSS文件类型
名称类型描述
BucketStringOSS的Bucket。3~63字节。
LocationStringOSS的服务区域。最大64字节。
ObjectStringOSS的Object。最大1024字节。

AliyunJob

作业
名称类型描述
JobIdString任务ID。
InputAliyunJobInput作业输入。
OutputAliyunOutput作业输出。
StateString作业状态:
  • Submitted表示作业已提交。
  • Transcoding表示转码中。
  • TranscodeSuccess表示转码成功。
  • TranscodeFail表示转码失败。
  • TranscodeCancelled表示转码取消。
CodeString转码失败时的错误码。
MessageString转码失败时的消息。
PercentString转码进度。取值范围:[0,100]。
UserDataString用户自定义数据。
PipelineIdString管道ID。
CreationTimeString作业添加时间。
MNSMessageResultAliyunMNSMessageResultMNS通知用户作业完成的消息结果。

AliyunJobInput

转码作业输入类型
名称类型描述
BucketString作业输入OSS的Bucket。3~63字节。
LocationString作业输入OSS的服务区域。最大64字节。
ObjectString作业输入OSS的Object。最大1024字节。
AudioAliyunInputAudio转码源媒体音频配置。
ContainerAliyunInputContainer转码源媒体容器配置。

AliyunInputContainer

源媒体容器配置类型。
说明 当输入文件为ADPCM、PCM格式时此参数为必填项。
名称类型描述
FormatString源媒体音频格式。 取值:alaw、 f32be、f32le、f64be、f64le、mulaw、s16be、s16le、s24be、s24le、s32be、s32le、s8、u16be、u16le、u24be、u24le、u32be、u32le、u8。

AliyunInputAudio

源媒体音频配置类型。
说明 当输入文件为ADPCM、PCM格式时此参数为必填项。
名称类型描述
ChannelsString源媒体音频声道数。

取值范围:[1,8]。

SamplerateString源媒体音频采样率。
  • 取值范围:[0,320000]。
  • 单位:Hz。

AliyunOutput

作业输出类型
名称类型描述
OutputFileAliyunOSSFile输出文件。
TemplateIdString模板ID。
WaterMarkListAliyunWaterMark[ ]水印列表。
ClipAliyunClip剪辑片段。
RotateString视频旋转角度。

取值范围:[0,360)

PropertiesAliyunProperties媒体属性。
PriorityString任务在其对应管道内的优先级。
  • 取值范围:[1,10]。
  • 最高优先级:10。
  • 默认值:6。
ContainerAliyunContainer容器。指定则替换TemplateId所指定模版的AliyunContainer设置。
VideoAliyunVideoCodec视频配置。指定则替换TemplateId所指定模版的AliyunVideoCodec设置。
AudioAliyunAudioCodec音频配置。指定则替换TemplateId所指定模版的AliyunAudioCodec设置。
TransConfigAliyunTransConfig转码通用配置。指定则替换TemplateId所指定模版的AliyunTransConfig设置。
MuxConfigAliyunMuxConfig转码封包配置。指定则替换TemplateId所指定模版的AliyunMuxConfig设置。
UserDataString用户自定义数据。

AliyunClip

剪辑类型
名称类型描述
TimeSpanAliyunTimeSpan剪辑时间段。

AliyunTimeSpan

剪辑时间段类型
名称类型描述
SeekString开始时间。
DurationString延续时间。
EndString截尾时间。
  • 如5.23,表示尾部的5.23秒会被截掉。
  • 设置此参数会导致Duration参数失效。

AliyunMuxConfig

封包配置类型
名称类型描述
SegmentAliyunSegment切片配置。

AliyunSegment

切片配置类型
名称类型描述
DurationString分片时长。
  • 取值范围:[1,60]。
  • 单位:秒。

AliyunJobResult

提交作业结果类型
名称类型描述
SuccessString是否成功。取值为true或者false。
CodeString创建作业失败时错误码。
MessageString创建作业失败时错误消息。
JobAliyunJob作业。如果提交失败则不会生成作业ID。

AliyunWaterMark

作业输出类型
名称类型描述
InputFileAliyunOSSFile水印输入文件。
WaterMarkTemplateIdString水印模板ID。

AliyunWaterMarkTemplate

水印模板类型
名称类型描述
IdString水印模板ID。
NameString水印模板名称。
WidthNumber宽。
  • 取值范围:[8,4096]。
  • 单位:px。
HeightNumber高。
  • 取值范围:[8,4096]。
  • 单位:px。
DxNumber水平偏移量。
  • 取值范围:[-4096,4096]。
  • 单位:px。
DyNumber垂直偏移量。
  • 取值范围:[-4096,4096]。
  • 单位:px。
ReferPosString水印的位置。 可取值:TopRight、TopLeft、BottomRight、BottomLeft。
TypeString水印类型。可取值:Image、Text 。
说明 目前仅支持 Image。
StateString水印模板的状态。可取值:Normal、Deleted。

AliyunPipeline

管道类型
名称类型描述
IdString管道ID。
NameString管道名称。
SpeedString管道类型。
  • 取值:Boost、Standard、NarrowBandHDV2、AIVideoCover、AIVideoRecogni、AIVideoSummary、AIVideoPorn、AIAudioKWS、AIAudioASR。
  • 默认值:Standard。
StateString管道状态。可取值:Active、Paused 。
  • Active:表示管道内的作业会被调度给转码系统转码,
  • Paused:表示管道暂停,作业不再会被调度到转码系统,管道内的所有作业状态维持在已提交状态,正在执行的作业不受影响,继续进行。
NotifyConfigStringMNS通知配置。

AliyunMediaInfoJob

媒体信息分析作业类型
名称类型描述
IdString元信息分析作业ID。
InputAliyunOSSFile作业输入。
StateString作业状态。分为Analyzing、Success、Fail。
CodeString元信息分析失败时错误码。
MessageString元信息分析失败时错误信息。
PropertiesAliyunProperties属性。
UserDataString用户自定义数据。
CreationTimeString作业添加时间。

AliyunAnalysisJob

模板分析作业类型
名称类型描述
IdString模板分析作业ID。
InputAliyunOSSFile作业输入。
AnalysisConfigAliyunAnalysisConfig作业配置。
TemplateListAliyunTemplate[ ]作业输出的预置模板列表。
StateString作业状态。分为Submitted、Analyzing、Success、Fail。
CodeString分析失败时错误码。
MessageString分析失败时错误信息。
PercentString转码进度。

取值范围:[0,100]。

PriorityString任务在其对应管道内的优先级。
  • 取值范围:[1,10]。
  • 最高优先级:10。
  • 默认值:10。
UserDataString用户自定义数据。
PipelineIdString管道ID。
CreationTimeString作业添加时间。
MNSMessageResultAliyunMNSMessageResultMNS通知用户作业完成的结果。

AliyunSnapshotJob

截图作业类型
名称类型描述
IdString截图作业ID。
InputAliyunOSSFile作业输入。
SnapshotConfigAliyunSnapshotConfig截图配置。
CountString截取图片的数量。
StateString截图状态。分为Snapshoting、Success、Fail。
CodeString分析失败时错误码。
MessageString分析失败时错误信息。
UserDataString用户自定义数据。
MNSMessageResultAliyunMNSMessageResultMNS通知用户作业完成的结果。

AliyunSnapshotConfig

截图配置 AliyunSnapshotConfig
名称类型描述
OutputFileString截图输出OSS配置。
TileOutputFileString拼图任务大图的输出OSS配置。
TimeString截图开始时间。

单位:毫秒

IntervalString截图间隔时间。
  • 若指定则表示序列截图,且值必须大于0。
  • 单位:秒
  • 默认值:10
NumString截图数量。

若指定则表示序列截图。

WidthString截图输出图片宽度。

取值范围:[8,4096]

HeightString截图输出图片高度。

取值范围:[8,4096]

FrameTypeString截图类型。
  • 普通帧:normal。
  • I帧:intra。
  • 默认值:normal。
TileOutString拼图配置。

AliyunFailReason

失败原因类型
名称类型描述
CodeString失败时错误码。
MessageString失败时错误信息。

AliyunMNSMessageResult

MNS通知用户作业完成结果类型
名称类型描述
ErrorCodeString失败时错误码。
ErrorMessageString失败时错误信息。
MessageIdString成功时消息ID。

Activity

媒体工作流活动
名称类型描述
NameString媒体工作流活动名称。
说明 在同一个工作流中活动的名字是唯一的。
TypeString媒体工作流活动类型。

范围:Start、Snapshot、Transcode、Analysis、Report。

JobIdString活动执行时生成的作业ID(例如分析作业ID、转码作业ID、截图作业ID)。
StateString状态。
范围:Running、Success、Fail、Skipped。
  • Skipped表示活动被跳过。
  • 例如分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。
StartTimeString活动开始执行时间。
EndTimeString活动结束执行时间。
CodeString错误码。

如果活动状态是Fail时,会给出具体的错误码。

MessageString错误信息。

如果活动状态是Fail时,会给出详细的错误描述信息。

MediaWorkflow

媒体工作流
名称类型描述
MediaWorkflowIdString媒体工作流ID。
NameString媒体工作流名称。
TopologyString媒体工作流拓扑结构。
StateString状态。范围Inactive、Active、Deleted
CreationTimeString创建时间。

InputFile

输入文件
名称类型描述
BucketStringOSS Bucket。
LocationStringOSS Location。
ObjectStringOSS Object。

MediaWorkflowExecutionInput

媒体工作流执行实例输入
名称类型描述
InputFileInputFile媒体工作流的输入文件。
UserDataString用户自定义数据。

MediaWorkflowExecution

媒体工作流执行实例
名称类型描述
RunIdString执行实例ID。
InputMediaWorkflowExecutionInput媒体工作流的输入。
MediaWorkflowIdString媒体工作流ID。
NameString媒体工作流名称。
MediaIdString媒体ID。媒体工作流生成的所有信息都属于这个媒体ID。
ActivityListActivity媒体工作流活动列表。
StateString状态。
  • 范围:Running、Completed、Fail。
  • Completed仅表示工作流执行完成,每个活动的(转码、截图等)是否成功要看每个活动具体的状态值。
CreationTimeString创建时间。

MediaInfo

属性类型
名称类型描述
FormatFormatInfo格式信息。
StreamsStreamsInfo流信息。

FormatInfo

容器及通用信息类型
名称类型描述
NumStreamsString媒体流总数。
NumProgramsString节目流总数。
FormatNameString容器/封装格式简述名。
FormatLongNameString容器/封装格式长述名。
StartTimeString起始时间。
DurationString总时长。
SizeString文件大小。
BitrateString总码率

StreamsInfo

流信息类型
名称类型描述
VideoStreamListVideoStream[]视频流列表。列表元素至多4个。
AudioStreamListAudioStream[]音频流列表。列表元素至多4个。
SubtitleStreamListSubtitleStream[]字幕流列表。列表元素至多4个。

VideoStream

视频流信息类型
名称类型描述
IndexString视频流序号。标识视频流在整个媒体流中的位置。
CodecNameString编码格式简述名。
CodecLongNameString编码格式长述名。
ProfileString编码预置。
CodecTimeBaseString编码时基。
CodecTagStringString编码格式标记文本。
CodecTagString编码格式标记
WidthString视频分辨率宽数字。
HeightString视频分辨率长
HasBFramesString是否有B帧。
SarString编码信号分辨率比。
DarString编码显示分辨率比。
PixFmtString像素格式。
LevelString编码等级。
FpsString目标帧率。
AvgFPSString平均帧率。
TimebaseString时基。
StartTimeString起始时间。
DurationString时长。
NumFramesString总帧数
LangString语言。
NetworkCostNetworkCost网络带宽消耗。

NetworkCost

视频网络带宽消耗类型
名称类型描述
PreloadTimeString预加载时间。
CostBandwidthString最大消耗带宽。
AvgBitrateString平均码率。

AudioStream

音频流信息类型
名称类型描述
IndexString音频流序号。标识音频流在整个媒体流中的位置。
CodecNameString编码格式简述名。
CodecLongNameString编码格式长述名。
CodecTimeBaseString编码时基。
CodecTagStringString编码格式标记文本。
CodecTagString编码格式标记。
SampleFmtString采样格式。
SamplerateString采样率。
ChannelsString声道数。
ChannelLayoutString声道输出样式。
TimebaseString时基。
StartTimeString起始时间。
DurationString时长。
BitrateString码率。
NumFramesString总帧数。
LangString语言。

SubtitleStream

字幕流信息类型
名称类型描述
IndexString字幕流序号。标识字幕流在整个媒体流中的位置。
LangString语言。

Media

媒体
名称类型描述
MediaIdString媒体ID。
FileFile原文件。
TitleString标题。
DescriptionString描述。
CateIdString类目Id。
CateNameString类目名称。
TagsString[]标签列表。
RiskFactorString风险因子。
  • 取值范围:[0,1]
  • 风险因子越高,涉黄、涉暴等可能性越高。
  • 识别准确率80%。
CoverURLString封面URL。
PublishStateString媒体发布状态,表示是否对外发布媒体。
取值范围:
  • Initiated:初始,
  • UnPublish:未发布,OSS播放文件权限为Private,
  • Published:已发布,OSS播放文件权限为Default,
  • Deleted:已删除。
RunIdListString[]媒体工作流列表。
CreationTimeString创建时间。
DurationString时长。
FormatString格式。
SizeString大小。
BitrateString码率。
FpsString帧率。
WidthString宽。
HeightString高。
PlayListPlay[]播放列表。
SnapshotListSnapshot[]截图列表。
MediaInfoMediaInfo媒体信息。

Category

类目
名称类型描述
CateIdString类目ID。
ParentIdString父节点ID。最顶层节点值为-1。
CateNameString类目名称。
LevelString所处层级。最顶层节点值为0。

File

文件
名称类型描述
URLString文件URL。
StateString文件状态。范围:Normal、Deleted。

Play

播放信息
名称类型描述
MediaWorkflowIdString产生播放文件的工作流ID。
MediaWorkflowNameString产生播放文件的工作流。
ActivityNameString媒体工作流活动名称。
DurationString时长。
FormatString格式。
SizeString大小。
BitrateString码率。
FpsString帧率。
WidthString宽。
HeightString高。
FileFile播放文件。

Snapshot

截图信息
名称类型描述
MediaWorkflowIdString产生截图文件的工作流ID。
MediaWorkflowNameString产生截图文件的工作流。
ActivityNameString产生截图文件的工作流活动名称。
FileFile截图文件。
TypeString截图类型。范围:Single、Sequence
CountNumber截图张数。此值只在Type为Sequence时有意义

MediaBucket

媒体Bucket
名称类型描述
BucketString媒体Bucket名称。
TypeString媒体Bucket类型。范围:Input、Output。