数据类型
Activity
描述
媒体工作流活动
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 媒体工作流活动名称,在同一个工作流中活动的名字是唯一的 |
| Type | String | 媒体工作流活动类型,范围:Start、Snapshot、Transcode、Analysis、Report |
| JobId | String | 活动执行时生成的作业ID(例如分析作业ID,转码作业ID,截图作业ID) |
| State | String | 状态,范围:Running、Success、Fail、Skipped。Skipped表示活动被跳过。例如分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。 |
| StartTime | String | 活动开始执行时间 |
| EndTime | String | 活动结束执行时间 |
| Code | String | 错误码。如果活动状态是Fail时,会给出具体的错误码。 |
| Message | String | 错误信息。如果活动状态是Fail时,会给出详细的错误描述信息。 |
MediaWorkflow
描述
媒体工作流
| 名称 | 类型 | 描述 |
|---|---|---|
| MediaWorkflowId | String | 媒体工作流Id |
| Name | String | 媒体工作流名称 |
| Topology | String | 媒体工作流拓扑结构 |
| State | String | 状态,范围Inactive、Active、Deleted |
| CreationTime | String | 创建时间 |
InputFile
描述
输入文件
| 名称 | 类型 | 描述 |
|---|---|---|
| Bucket | String | OSS Bucket |
| Location | String | OSS Location |
| Object | String | OSS Object |
MediaWorkflowExecutionInput
描述
媒体工作流执行实例输入
| 名称 | 类型 | 描述 |
|---|---|---|
| InputFile | InputFile | 媒体工作流的输入文件 |
| UserData | String | 用户自定义数据 |
MediaWorkflowExecution
描述
媒体工作流执行实例
| 名称 | 类型 | 描述 |
|---|---|---|
| RunId | String | 执行实例Id |
| Input | MediaWorkflowExecutionInput | 媒体工作流的输入 |
| MediaWorkflowId | String | 媒体工作流ID |
| Name | String | 媒体工作流名称 |
| MediaId | String | 媒体ID,媒体工作流生成的所有信息都属于这个媒体ID |
| ActivityList | Activity | 媒体工作流活动列表 |
| State | String | 状态,范围:Running、Completed、Fail。Completed仅表示工作流执行完成,每个活动的(转码、截图等)是否成功要看每个活动具体的状态值。 |
| CreationTime | String | 创建时间 |
MediaInfo
描述
属性类型
| 名称 | 类型 | 描述 |
|---|---|---|
| Format | FormatInfo | 格式信息 |
| Streams | StreamsInfo | 流信息 |
FormatInfo
描述
容器及通用信息类型
| 名称 | 类型 | 描述 |
|---|---|---|
| NumStreams | String | 媒体流总数 |
| NumPrograms | String | 节目流总数 |
| FormatName | String | 容器/封装格式简述名 |
| FormatLongName | String | 容器/封装格式长述名 |
| StartTime | String | 起始时间 |
| Duration | String | 总时长 |
| Size | String | 文件大小 |
| Bitrate | String | 总码率 |
StreamsInfo
描述
流信息类型
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoStreamList | VideoStream[] | 视频流列表,列表元素至多4个 |
| AudioStreamList | AudioStream[] | 音频流列表,列表元素至多4个 |
| SubtitleStreamList | SubtitleStream[] | 字幕流列表,列表元素至多4个 |
VideoStream
描述
视频流信息类型
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | String | 视频流序号,标识视频流在整个媒体流中的位置 |
| CodecName | String | 编码格式简述名 |
| CodecLongName | String | 编码格式长述名 |
| Profile | String | 编码预置 |
| CodecTimeBase | String | 编码时基 |
| CodecTagString | String | 编码格式标记文本 |
| CodecTag | String | 编码格式标记 |
| Width | String | 视频分辨率宽 数字 |
| Height | String | 视频分辨率长 |
| 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 | 语言 |
| NetworkCost | NetworkCost | 网络带宽消耗 |
NetworkCost
描述
视频网络带宽消耗类型
| 名称 | 类型 | 描述 |
|---|---|---|
| PreloadTime | String | 预加载时间 |
| CostBandwidth | String | 最大消耗带宽 |
| AvgBitrate | String | 平均码率 |
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 | 语言 |
SubtitleStream
描述
字幕流信息类型
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | String | 字幕流序号,标识字幕流在整个媒体流中的位置 |
| Lang | String | 语言 |
Media
描述
媒体
| 名称 | 类型 | 描述 |
|---|---|---|
| MediaId | String | 媒体ID |
| File | File | 原文件 |
| Title | String | 标题 |
| Description | String | 描述 |
| CateId | String | 类目Id |
| CateName | String | 类目名称 |
| Tags | String[] | 标签列表 |
| RiskFactor | String | 风险因子,范围:[0,1],风险因子越高,涉黄,涉暴等可能性越高,识别准确率80% |
| CoverURL | String | 封面URL |
| PublishState | String | 媒体发布状态,表示是否对外发布媒体,范围:Initiated(初始)、UnPublish(未发布,OSS播放文件权限为Private)、Published(已发布,OSS播放文件权限为Default)、Deleted(已删除) |
| RunIdList | String[] | 媒体工作流列表 |
| CreationTime | String | 创建时间 |
| Duration | String | 时长 |
| Format | String | 格式 |
| Size | String | 大小 |
| Bitrate | String | 码率 |
| Fps | String | 帧率 |
| Width | String | 宽 |
| Height | String | 高 |
| PlayList | Play[] | 播放列表 |
| SnapshotList | Snapshot[] | 截图列表 |
| MediaInfo | MediaInfo | 媒体信息 |
Category
描述
类目
| 名称 | 类型 | 描述 |
|---|---|---|
| CateId | String | 类目ID |
| ParentId | String | 父节点ID,最顶层节点值为-1 |
| CateName | String | 类目名称 |
| Level | String | 所处层级,最顶层节点值为0 |
File
描述
文件
| 名称 | 类型 | 描述 |
|---|---|---|
| URL | String | 文件URL |
| State | String | 文件状态,范围:Normal、Deleted |
Play
描述
播放信息
| 名称 | 类型 | 描述 |
|---|---|---|
| MediaWorkflowId | String | 产生播放文件的工作流ID |
| MediaWorkflowName | String | 产生播放文件的工作流 |
| ActivityName | String | 媒体工作流活动名称 |
| Duration | String | 时长 |
| Format | String | 格式 |
| Size | String | 大小 |
| Bitrate | String | 码率 |
| Fps | String | 帧率 |
| Width | String | 宽 |
| Height | String | 高 |
| File | File | 播放文件 |
Snapshot
描述
截图信息
| 名称 | 类型 | 描述 |
|---|---|---|
| MediaWorkflowId | String | 产生截图文件的工作流ID |
| MediaWorkflowName | String | 产生截图文件的工作流 |
| ActivityName | String | 产生截图文件的工作流活动名称 |
| File | File | 截图文件 |
| Type | String | 截图类型,范围:Single、Sequence |
| Count | Number | 截图张数,此值只在Type为Sequence时有意义 |
MediaBucket
描述
媒体Bucket
| 名称 | 类型 | 描述 |
|---|---|---|
| Bucket | String | 媒体Bucket名称 |
| Type | String | 媒体Bucket类型,范围:Input、Output |