You need to enable JavaScript to run this app.
导航
智能处理
  • 文档首页
    • /智能处理/API 参考/公共数据结构
公共数据结构
最近更新时间：2025.02.07 13:18:54首次发布时间：2021.10.21 21:32:31
复制全文
我的收藏
有用
有用
无用
无用

本文为您介绍智能处理 OpenAPI 的公共数据结构。

ResponseMetadata

媒资信息的公共数据结构。

参数类型描述
RequestIdString请求 ID
ActionString接口名
VersionString接口版本
RegionString服务地区

InputPath

任务输入文件的公共数据结构。

参数类型是否必传描述

Type

String

是

输入类型。取值如下：

  • VOD：点播视频库。
  • VODMaterial：点播素材库。
  • TOS：对象存储。

注意

当 Type 取值为 VODMaterial 时，只能作为素材使用，不能作为处理的输入。需要注意的是在工作流模板配置输入选择类型为图片时除外。

TosBucket

String

否

对象存储桶。

说明

当 Type 取值为 TOS 时，该 TosBucket 参数才能生效。

VodSpaceName

String

否

支持选择指定的点播空间。

说明

当参数 Type 取值为 VOD 或者 VODMaterial 时，该 VodSpaceName 参数才能生效。

FileId

String

是

文件 ID。

说明

  • 如果 Type 取值为 VOD，该参数的文件 ID 即为 Vid，例如，v0d0c9g0***bml90。
  • 如果 Type 取值为 VODMaterial，该参数的文件 ID 即为 Mid，例如，i0022jwg43****f42v8kg。
  • 如果 Type 取值为 TOS，该参数的文件 ID 即为文件路径，例如，exampl/01.png。

OutputPath

任务输出文件的公共数据结构。

参数类型是否必传描述

Type

String

是

输出类型。取值如下：

  • VOD：点播视频库。
  • TOS：对象存储。

VodSpaceName

String

否

指定的点播空间。

说明

当参数 Type 取值为 VOD 时，该 VodSpaceName 参数才能生效。

TosBucket

String

否

对象存储桶。

说明

当 Type 取值为 TOS 时，该 TosBucket 参数才能生效。

FileName

String

否

文件路径，支持 {{fileName}}、{{fileTitle}}、{{filePrefix}}、{{vid}}、{{random}}。限制条件包括：

JobOutput

任务输出的公共数据结构。

参数类型是否必传描述
TemplateIdString是模板 ID。
TemplateNameString是模板参数。
PropertiesObject否输出信息。详情请见任务节点输出定义。

Status

String

是

状态。取值如下：

  • Completed：成功。
  • Failed：失败。
  • Timeout：超时。
ActivityIdString是工作流节点 ID。
StartTimeString是开始时间。
EndTimeString是结束时间。

JobExecution

任务执行的公共数据结构。

参数类型是否必传描述
JobIdString是任务 ID。
InputPathInputPath是任务输入地址配置。
OutputPathOutputPath是任务输出地址配置。
OutputArray of JobOutput是任务输出详情。

Status

String

是

任务状态。状态类型如下：

  • Completed：执行成功。
  • Running：执行中。
  • Failed：执行失败。
  • TimedOut：超时。
  • Canceled：取消。
CallbackUriString是回调地址。

CallbackContentType

String

否

任务回调数据类型，取值如下：

  • application/octet-stream：二进制流数据，默认值
  • application/json：JSON 数据类型
CallbackArgsString是回调参数。
CreatedAtString是创建时间。
FinishedAtString是完成时间。

EnableLowPriority

String

是

闲时任务。取值如下：

  • true：开启。
  • false：（默认）关闭。

JobSource

String

是

任务来源。取值如下：

  • Console：（默认）控制台。
  • API：调用 API。
  • AutoTrigger：自动触发。
JobJob是单任务触发参数。

Job

参数类型是否必传描述
TranscodeVideoTranscodeVideoJob否基础转码参数。
ByteHDByteHDJob否极致高清转码参数。

TranscodeVideoJob

参数类型是否必传描述

Container

String

是

封装格式
支持MP4、Dash、HLS、MP3、M4A、OGG、MPEGTS。

Video

Video

否

视频参数
非转封装且非禁用视频，则为必传

Audio

Audio

否

音频参数
非转封装且非禁用音频，则为必传

EnableRemuxbool否是否转封装，默认false

DisableVideo

bool

否

是否禁用视频，默认false

  • 如果封装格式为MP3、M4A、OGG时，禁用视频默认设置为true

  • 禁用视频、音频不能都为true

DisableAudio

bool

否

是否禁用音频，默认false

  • 禁用视频、音频不能都为true

Segment

Segment

否

分片信息

  • 封装格式为Dash HLS，则必填
LogosLogoDefinition[]否水印信息，最多 20 个

ByteHDJob

参数类型是否必传描述

Container

String

是

封装格式，支持MP4 Dash HLS MPEGTS

VideoVideo是视频参数
AudioAudio是音频参数

Segment

Segment

否

分片信息

  • 封装格式为Dash HLS，则必填
LogosLogoDefinition[]否水印信息，最多 20 个

Video

名称类型是否必传描述

Codec

String

否

编码格式。支持h264、h265、h266，默认为h264
仅封装格式为MP4时，支持h266

ScaleType

Integer

否

视频尺寸限制类型。支持1、2，默认为1
长短边限制：1，宽高限制：2

ScaleWidth

Integer

否

最大宽度，宽高限制时生效，限制：[128,4096]
默认为0，代表与源视频一致

ScaleHeight

Integer

否

最大高度，宽高限制时生效，限制：[128,4096]
默认为0，代表与源视频一致

ScaleShort

Integer

否

最大短边，长短边限制时生效，限制：[128,4096]
默认为0，代表与源视频一致

ScaleLong

Integer

否

最大长边，长短边限制时生效，限制：[128,4096]
默认为0，代表与源视频一致

BitrateInteger否视频最大码率。 取值范围：[10，50000]，默认为：4000
MaxFpsInteger否最大帧率。 取值范围：[1,120]，默认为：60
CrfInteger否视频编码质量参数，视频平均码率。 取值范围：[1，51]，默认为26

Profile

String

否

编码级别，默认由编码器自动决策

  • 仅封装格式为h264支持此参数

  • 支持 baseline、main、high、high10、high422、high444

PixFmt

String

否

视频颜色格式，默认由编码器自动决策

  • 封装格式为h264支持：yuv420p、yuv422p、yuvj420p、yuvj422p

  • 封装格式为h265支持：yuv420p、yuv420p10le

  • 仅编码级别为high422 high444，支持yuv422p yuvj422p

Audio

名称类型是否必传描述

Codec

String

否

编解码格式，默认为aac

  • 封装格式为 MP4 ，支持 aac opus

  • 封装格式为 Dash HLS M4A MPEGTS，支持 aac

  • 封装格式为 MP3，支持 mp3

  • 封装格式为 OGG，支持 opus

SampleRate

Integer

否

采样率, 单位Hz。

  • 当编码格式为mp3，支持8000,11025,12000,16000,22050,24000,32000,44100,48000 , 默认值为44100,

  • 当 Codec 为aac，支持8000,11025,16000,22050,24000,32000,44100,48000,64000,88200,96000, 默认值为44100

  • 当 Codec 为opus，支持48000，默认值为48000

BitrateInteger否输出文件的音频码率。取值范围：[8，1000] 单位：Kbps，默认值为128
ChannelsInteger否声道数。 支持 1、2，默认为2
VolumeVolume否音量设置

Segment

字段类型必填描述

Format

String

否

分片格式

  • 封装格式为Dash，默认为fmp4

  • 封装格式为HLS，支持ts和fmp4，默认为ts

Type

String

否

分片类型

  • 封装格式为Dash，支持SegmentBase, SegmentTemplate，默认为SegmentBase

  • 封装格式为为HLS，支持SingleFile, MultiFile，默认为MultiFile

DurationInteger否分片时长，[1000, 600000]，单位ms，默认为：5000

Volume

字段类型必填描述

Method

String

否

音量调节模式，取值为：

  • 2Pass：音量均衡

  • MultVolume：音量调节

IntegratedLoudnessFloat否响度值设置，2Pass 时必填，[-70,-5]

TruePeak

Float

否

音量峰值，2Pass 时必填，[-9, 0]

VolumeTimeFloat否音量倍数，MultVolume 时必填，取值范围[0.01, 3]

LogoDefinition

字段类型必填描述

Type

String

是

水印类型，取值如下：

  • Image：图片

  • Text：文本

ImageLogoDefinition

ImageLogoDefinition

否

图片水印配置。

说明

  • 当参数 Type 取值为 Image 时，该参数必传。
  • 您必须设置 ImageLogoDefinition 或 TextLogoDefinition 参数之一，但不能同时设置这两个参数。

TextLogoDefinition

TextLogoDefinition

否

文本水印配置。

说明

  • 当参数 Type 取值为 Text 时，该参数必传。
  • 您必须设置 ImageLogoDefinition 或 TextLogoDefinition 参数之一，但不能同时设置这两个参数。
PositionLogoPosition是水印位置
TimeLineTimeLine否水印时间轴。默认为视频开始到结束

ImageLogoDefinition

字段类型必填描述

Content

InputPath

是

图片水印输入

说明

图片水印目前仅支持水印素材库和对象存储输入

LoopTimes

Integer

否

水印循环播放的次数，默认为 0。取值如下：

  • -1：循环多次，直至视频结尾

  • 0：不加循环，仅播放 1 次

  • N (N>=1)：加 N 次循环，播放 N+1 次

说明

当图片格式为 gif 时，该参数才生效

RepeatLast

Boolean

否

是否延续动图水印的最后一帧直至视频结束，默认为 false。

说明

当图片格式为 gif 时，该参数才生效

TransparencyInteger否水印透明度，取值范围为 [0,100]。默认为 0，表示完全不透明；100 表示完全透明。

TextLogoDefinition

字段类型必填描述
ContentString是文本水印内容，长度不超过 100 个字符

FontType

String

是

水印字体。取值如下

  • SimKai：宋体

  • NotoSansSC-Black：思源黑体-简体中文版

FontSizeInteger是水印文字大小。正值，单位 px
FontColorString是水印颜色。16进制色彩表示，格式为 RGBA。

LogoPosition

字段类型必填描述

PosX

String

是

水印原点距离视频图像坐标原点的水平偏移。有以下两种模式：

  • 像素：以 px 为后缀，去除 px 后，取值为整数。示例：“100px”

  • 百分比：以 % 为后缀，去除 % 后，取值为 Float。示例：“15.1%”

注意

PosX、PosY、SizeX、SizeY 必须使用相同的模式

PosY

String

是

水印原点距离视频图像坐标原点的水平偏移。有以下两种模式：

  • 像素：以 px 为后缀，去除 px 后，取值为整数。示例：“100px”

  • 百分比：以 % 为后缀，去除 % 后，取值为 Float。示例：“15.1%”

注意

PosX、PosY、SizeX、SizeY 必须使用相同的模式

SizeX

String

是

水印原点距离视频图像坐标原点的水平偏移。有以下两种模式：

  • 像素：以 px 为后缀，去除 px 后，取值为整数。示例：“100px”

  • 百分比：以 % 为后缀，去除 % 后，取值为 Float。示例：“15.1%”

注意

PosX、PosY、SizeX、SizeY 必须使用相同的模式

SizeY

String

是

水印原点距离视频图像坐标原点的水平偏移。有以下两种模式：

  • 像素：以 px 为后缀，去除 px 后，取值为整数。示例：“100px”

  • 百分比：以 % 为后缀，去除 % 后，取值为 Float。示例：“15.1%”

注意

PosX、PosY、SizeX、SizeY 必须使用相同的模式

Locate

String

是

水印位置。取值如下

  • TopLeft：表示坐标原点位于视频图像左上角，水印原点为水印的左上角。

  • TopRight：表示坐标原点位于视频图像的右上角，水印原点为水印的右上角。

  • Center：表示坐标原点位于视频图像的中心，水印原点为水印的中心。

  • BottomLeft：表示坐标原点位于视频图像的左下角，水印原点为水印的左下角。

  • BottomRight：表示坐标原点位于视频图像的右下角，水印原点为水印的右下角。

TimeLine

字段类型必填描述
StartTimeInteger否片段开始时间，单位为毫秒, 非负值，默认为0
EndTimeInteger否片段结束时间，单位为毫秒，非负值，默认为视频结束。