文档

GetTranscodeJob - 查询转码任务

更新时间:

查询单个转码任务详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ParentJobIdstring

任务 ID

ab4802364a2e49208c99efab82dfa8e8

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

9EDC30DC-0050-5459-B788-F761B2BE359B
TranscodeParentJobobject

TranscodeParentJobWithSubJobDTO

TranscodeJobListobject []

子任务列表。

CreateTimestring

任务创建时间。

2022-01-12T08:49:41Z
Namestring

任务名。

transcode-job
ParentJobIdstring

主任务 ID。

8b2198504dd340b7b3c9842a74fc9baa
JobIdstring

子任务 ID。

7d6a7e0d4db2457a8d45ff5d43e1bf0a
JobIndexinteger

子任务在整个任务中的索引号。

0
InputGroupobject []

任务输入组。单个输入为转码任务。多个输入为音视频合流任务。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
InputUrlstring

媒资流地址,只有当对媒资流进行转码时填写此参数。

oss://bucket/path/to/video.mp4
ProcessConfigobject

转码处理配置。

Transcodeobject

转码配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Videoobject

video 设置。

Codecstring

编码格式。

H.264
Profilestring

编码级别。 支持 baseline、main、high。

  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。

默认值:high。

Main
Bitratestring

视频平均码率。

  • 取值范围:[10,50000]。
  • 单位:Kbps。
3000
Crfstring

码率-质量控制因子。

  • 取值范围:[0,51]。
  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26。

如果设置了 Crf,则 Bitrate 的设置失效。

23
Widthstring

宽。

  • 取值范围:[128,4096]。
  • 单位:px。

默认值:视频原始宽度。

1920
Heightstring

高。

  • 取值范围:[128,4096]。
  • 单位:px。

默认值:视频原始高度。

1080
Fpsstring

帧率。

  • 取值范围:(0,60]。 当输入文件帧率超过 60 时取 60。

  • 默认值:取输入文件帧率。

25
Gopstring

关键帧间最大帧数。

  • 取值范围:[1,1080000]。
  • 默认值:250。
250
Presetstring

视频算法器预置。只有 H264 支持该参数。 支持 veryfast、fast、medium、slow、slower。 默认值:medium。

medium
ScanModestring

扫描模式。 支持 interlaced、progressive。

progressive
PixFmtstring

视频颜色格式。 范围:yuv420p,yuvj420p 等标准颜色格式。

yuv420p
Removestring

是否去掉视频。

false
Cropstring

视频画面裁切,支持 2 种方式:

  • 自动检测黑边并裁切,设置为“border”;
  • 自定义裁切,参数格式:width:height:left:top。
1280:800:0:140
Padstring

视频贴黑边,参数格式:width:height:left:top。

1280:800:0:140
LongShortModestring

是否开启横竖屏自适应(即:长短边模式)。

false
Bufsizestring

缓冲区大小:

  • 值范围:[1000,128000];
  • 默认值:6000;
  • 单位:Kb。
6000
Maxratestring

视频码率峰值:

  • 值范围[10,50000];
  • 单位 Kbps。
9000
AbrMaxstring

abr 最大码率(只有窄高 1 有效):

  • 值范围[10,50000];
  • 单位 Kbps。
6000
Audioobject

audio 设置。

Codecstring

音频编解码格式,AAC、MP3、VORBIS、FLAC。 默认值:AAC

AAC
Profilestring

音频编码预置。 当 Codec 为 AAC 时,范围 aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。

aac_low
Sampleratestring

采样率。

  • 默认值:44100 支持 22050、32000、44100、48000、96000,
  • 单位:Hz
44100
Bitratestring

输出文件的音频码率。

  • 值范围:[8,1000]
  • 单位:Kbps
  • 默认值:128
128
Channelsstring

声道数。 默认值:2

2
Removestring

是否删除音频流。

false
Volumeobject

音量控制。

Methodstring

音量调整方式。

auto
IntegratedLoudnessTargetstring

目标音量。

-6
TruePeakstring

最大峰值。

-1
LoudnessRangeTargetstring

音量范围。

8
Containerobject

封装格式设置。

Formatstring

容器格式。

mp4
MuxConfigobject

封装设置。

Segmentobject

切片设置。

Durationstring

切片时长。

10
ForceSegTimestring

强制切片时间点。

2,3
TransConfigobject

条件转码参数。

TransModestring

视频转码模式。取值如下:

  • onepass:一般用于 ABR。编码速度较 twopass 更快。

  • twopass:一般用于 VBR。编码速度较 onepass 更慢。

  • CBR:固定码率模式。

默认值:onepass。

onepass
IsCheckResostring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,IsCheckResoFail 优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,按输入视频分辨率转码。

  • false:不检查。

默认值:false。

true
IsCheckResoFailstring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitratestring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,IsCheckVideoBitrateFail 优先级更高。

  • true:检查。当输入视频码率小于输出设置时,按输入视频码率转码。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitrateFailstring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckAudioBitratestring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,IsCheckAudioBitrateFail 优先级更高。

  • true:检查。当输入音频码率小于输出设置时,按输入音频码率转码。

  • false:不检查。

默认值:

  • 参数为空,并且 codec 和输入源不一样:false。

  • 参数为空,并且 codec 和输入源一样:true。

true
IsCheckAudioBitrateFailstring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入音频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
AdjDarMethodstring

分辨率改写方式。当 Width 或 Height 都填写时才生效,可以和 LongShortMode 搭配使用。

可选值:rescale、crop、pad、none。

默认值:none。

示例:请参见如何设置分辨率。

none
ImageWatermarksobject []

图片水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Widthstring

宽。

32
Heightstring

高。

32
Dxstring

水印位置,x。

10
Dystring

水印位置,y。

10
ReferPosstring

参考位置:TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft。

TopLeft
Timelineobject

显示时间设置。

Startstring

开始时间。

00:00:05
Durationstring

显示时长,秒数或者 "ToEND"。

ToEND
Fileobject

水印图片文件。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
TextWatermarksobject []

文字水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Contentstring

水印文本,不需要 base64 encode,字符串需要 utf-8 编码。

测试水印
FontNamestring

字体。

SimSun
FontColorstring

颜色。

#006400
FontAlphastring

透明度。

1.0
Topstring

水印位置,距离上边距离。

10
Leftstring

水印位置,距离左边距离。

10
FontSizeinteger

字体大小。

16
BorderWidthinteger

边框宽度。

0
BorderColorstring

边框颜色。

#006400
Adaptivestring

根据输出视频大小调整字体 size。 true / false, default: false。

false
Subtitlesobject []

字幕压制配置。

TemplateIdstring

模板 ID

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Formatstring

字幕文件格式。

vtt
CharEncstring

文件 encoding 格式。

UTF-8
Fileobject

字幕文件。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
Encryptionobject

加密配置。

EncryptTypestring

加密类型。

PrivateEncryption
CipherTextstring

标准加密的密钥密文。

MTYi00NDU0LTg5O****
DecryptKeyUristring

标准加密的解密服务地址。

https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
KeyServiceTypestring

密钥服务类型。目前仅支持 KMS 和 Base64

KMS
CombineConfigsobject []

多输入合流配置

AudioIndexstring

音频流 Index

0 或 exclude
VideoIndexstring

视频流 Index

0 或 exclude
Startdouble

输入流的开始时间。 默认为 0

0.0
Durationdouble

输入流的持续时间。 默认为视频时长。

20.0
IsInheritTagsboolean

是否继承输入流的 tag。 当输入不是媒资是该参数不生效。 默认值:false

true
Outputobject

输出媒体配置。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
OutputUrlstring

转码输出流地址,仅当输出到媒资流时需要填此参数

oss://bucket/path/to/{MediaId}/{JobId}.mp4
UserDatastring

用户数据。

user-data
ScheduleConfigobject

任务调度信息。

PipelineIdstring

管道 ID。

e37ebee5d98b4781897f6086e89f9c56
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10。

5
Statusstring

转码任务状态 - Init: 已提交, Processing: 转码中, Success: 转码成功, Fail: 转码失败, Deleted: 已删除。

Init
OutFileMetaobject

任务生成视频 Media 信息。

FileBasicInfoobject

基础文件信息。

MediaIdstring

媒资 ID。

486c2890096871edba6f81848c016303
FileNamestring

文件名。

file.m3u8
FileStatusstring

文件状态。

Normal
FileTypestring

文件类型。取值:source_file, transcode_file

source_file
FileSizestring

文件大小。单位:Byte。

31737
FileUrlstring

文件 URL。

http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8
Regionstring

文件所在区域。

cn-shanghai
FormatNamestring

视频格式名称。

hls,applehttp
Durationstring

视频时长(单位:秒)。

403.039999
Bitratestring

视频码率。

888.563
Widthstring

宽。

848
Heightstring

高。

478
AudioStreamInfoListobject []

音频流信息。

Indexstring

流序号。

1
CodecNamestring

编码格式。

aac
CodecLongNamestring

编码格式名。

AAC (Advanced Audio Coding)
CodecTimeBasestring

编码器时间基。

1/44100
CodecTagStringstring

编码器标签名。

[15][0][0][0]
CodecTagstring

编码器标签。

0x000f
SampleFmtstring

采样格式。

fltp
SampleRatestring

采样率(单位:Hz)。

44100
Channelsstring

声道数。

2
ChannelLayoutstring

声道布局。

stereo
Timebasestring

时间基。

1/90000
StartTimestring

开始时间。

1.473556
Durationstring

时长(单位:秒)。

403.039989
Bitratestring

码率。

0.f
Langstring

语言。

cn
VideoStreamInfoListobject []

视频流信息。

Indexstring

流序号。

0
Codec_namestring

编码格式。

h264
Codec_long_namestring

编码格式名。

H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Profilestring

编码器预设。

High
Codec_time_basestring

编码时基。

1/50
Codec_tag_stringstring

编码格式标记文本。

[27][0][0][0]
Codec_tagstring

编码格式标记。

0x001b
Widthstring

宽。

848
Heightstring

高。

478
Has_b_framesstring

是否有 B 帧。 取值:

  • 0:没有 B 帧,
  • 1:有一个 B 帧,
  • 2:有多个连续 B 帧。
2
Sarstring

采集点数宽高比。

478:477
Darstring

图像显示宽高比。

16:9
PixFmtstring

颜色存储格式。

yuv420p
Levelstring

编码等级。

31
Fpsstring

帧率。

25.0
Avg_fpsstring

平均帧率。

25.0
Time_basestring

时基。

1/90000
Start_timestring

起始时间。

1.473556
Durationstring

时长(单位:秒)。

403.039989
Bit_ratestring

码率。

888.563
NumFramesstring

总帧数。

10040
Langstring

语言。

cn
Rotatestring

视频画面旋转角度。 取值 0, 90, 180, 270。 默认值 0

0
SubmitResultJsonobject

任务提交结果。

{}
SubmitTimestring

任务提交时间。

2022-01-12T08:49:41Z
FinishTimestring

任务结束时间。

2022-01-12T08:49:41Z
RequestIdstring

提交任务时请求 ID。

31E30781-9495-5E2D-A84D-759B0A01E262
CreateTimestring

任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-01-12T08:49:41Z
Namestring

任务名。

transcode-job
RequestIdstring

提交任务时请求 ID。

31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobIdstring

主任务 ID。

8b2198504dd340b7b3c9842a74fc9baa
JobCountinteger

子任务数量。

1
Statusstring

任务状态。

  • Success: 所有子任务完成后,有一个子任务则为成功,。
  • Fail: 所有子任务失败。
Success
TriggerSourcestring

任务来源。

  • API: API
  • WorkFlow: 工作流
  • Console: 控制台
API
Percentinteger

任务完成百分比。

0
SubmitTimestring

任务提交时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-01-12T08:49:41Z
FinishTimestring

任务结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-01-12T08:49:41Z
InputGroupobject []

任务输入组。单个输入为转码任务。多个输入为音视频合流任务。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
OutputGroupobject []

任务输出组。

Outputobject

输出媒体配置。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
OutputUrlstring

输出流地址。

oss://bucket/path/to/video.mp4
ProcessConfigobject

任务处理配置。

Transcodeobject

转码配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Videoobject

video 设置。

Codecstring

编码格式。

H.264
Profilestring

编码级别。 支持 baseline、main、high。

  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。

默认值:high。

Main
Bitratestring

视频平均码率。

  • 取值范围:[10,50000]。
  • 单位:Kbps。
3000
Crfstring

码率-质量控制因子。

  • 取值范围:[0,51]。
  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26。
  • 如果设置了 Crf,则 Bitrate 的设置失效。
23
Widthstring

宽。

  • 取值范围:[128,4096]。
  • 单位:px。
  • 默认值:视频原始宽度。
1920
Heightstring

高。

  • 取值范围:[128,4096]。
  • 单位:px。
  • 默认值:视频原始高度。
1080
Fpsstring

帧率。

  • 取值范围:(0,60]。
  • 当输入文件帧率超过 60 时取 60。
  • 默认值:取输入文件帧率。
25
Gopstring

关键帧间最大帧数。

  • 取值范围:[1,1080000]。
  • 默认值:250。
250
Presetstring

视频算法器预置。只有 H264 支持该参数。 支持 veryfast、fast、medium、slow、slower。 默认值:medium。

medium
ScanModestring

扫描模式。 支持 interlaced、progressive。

progressive
PixFmtstring

视频颜色格式。 范围:yuv420p,yuvj420p 等标准颜色格式。

yuv420p
Removestring

是否去掉视频。

false
Cropstring

视频画面裁切 支持 2 种方式。 自动检测黑边并裁切,设置为“border” 自定义裁切,参数格式:width:height:left:top。 示例:1280:800:0:140

1280:800:0:140
Padstring

视频贴黑边参数

  • 格式:width:height:left:top。
  • 示例:1280:800:0:140
1280:800:0:140
LongShortModestring

是否开启横竖屏自适应(即:长短边模式)。

false
Bufsizestring

缓冲区大小值

  • 取值范围:[1000,128000]
  • 默认值:6000
  • 单位:Kb
6000
Maxratestring

视频码率峰值

  • 取值范围:[10,50000]
  • 单位:Kbps。
9000
AbrMaxstring

abr 最大码率(只有窄高 1 有效)值

  • 取值范围:[10,50000],
  • 单位:Kbps。
6000
Audioobject

audio 设置。

Codecstring

音频编解码格式,AAC、MP3、VORBIS、FLAC。 默认值:AAC

AAC
Profilestring

音频编码预置。 当 Codec 为 AAC 时,范围 aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。

aac_low
Sampleratestring

采样率。

  • 默认值:44100
  • 支持 22050、32000、44100、48000、96000,
  • 单位:Hz
44100
Bitratestring

输出文件的音频码率。

  • 值范围:[8,1000]
  • 单位:Kbps
  • 默认值:128
128
Channelsstring

声道数。 默认值:2

2
Removestring

是否删除音频流。

false
Volumeobject

音量控制。

Methodstring

音量调整方式。

auto
IntegratedLoudnessTargetstring

目标音量。

-6
TruePeakstring

最大峰值。

-1
LoudnessRangeTargetstring

音量范围。

8
Containerobject

封装格式设置。

Formatstring

容器格式。

mp4
MuxConfigobject

封装设置。

Segmentobject

切片设置。

Durationstring

切片时长。

10
ForceSegTimestring

强制切片时间点。

2,3
TransConfigobject

条件转码参数。

TransModestring

视频转码模式。取值如下:

  • onepass:一般用于 ABR。编码速度较 twopass 更快。

  • twopass:一般用于 VBR。编码速度较 onepass 更慢。

  • CBR:固定码率模式。

默认值:onepass。

onepass
IsCheckResostring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,IsCheckResoFail 优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,按输入视频分辨率转码。

  • false:不检查。

默认值:false。

true
IsCheckResoFailstring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitratestring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,IsCheckVideoBitrateFail 优先级更高。

  • true:检查。当输入视频码率小于输出设置时,按输入视频码率转码。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitrateFailstring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckAudioBitratestring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,IsCheckAudioBitrateFail 优先级更高。

  • true:检查。当输入音频码率小于输出设置时,按输入音频码率转码。

  • false:不检查。

默认值:

  • 参数为空,并且 codec 和输入源不一样:false。

  • 参数为空,并且 codec 和输入源一样:true。

true
IsCheckAudioBitrateFailstring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入音频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
AdjDarMethodstring

分辨率改写方式。当 Width 或 Height 都填写时才生效,可以和 LongShortMode 搭配使用。

可选值:rescale、crop、pad、none。

默认值:none。

none
ImageWatermarksobject []

图片水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Widthstring

宽。

32
Heightstring

高。

32
Dxstring

水印位置,x。

10
Dystring

水印位置,y。

10
ReferPosstring

参考位置:TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft。

TopLeft
Timelineobject

显示时间设置。

Startstring

开始时间。

00:00:05
Durationstring

显示时长,秒数或者 "ToEND"。

ToEND
Fileobject

水印图片文件。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
TextWatermarksobject []

文字水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Contentstring

水印文本,不需要 base64 encode,字符串需要 utf-8 编码。

测试水印
FontNamestring

字体。

SimSun
FontColorstring

颜色。

#006400
FontAlphastring

透明度。

1.0
Topstring

水印位置,距离上边距离。

10
Leftstring

水印位置,距离左边距离。

10
FontSizeinteger

字体大小。

16
BorderWidthinteger

边框宽度。

0
BorderColorstring

边框颜色。

#006400
Adaptivestring

根据输出视频大小调整字体 size。 true / false, default: false。

false
Subtitlesobject []

字幕压制配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Formatstring

字幕文件格式。

vtt
CharEncstring

文件 encoding 格式。

UTF-8
Fileobject

字幕文件。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
Encryptionobject

加密配置。

EncryptTypestring

加密类型。

PrivateEncryption
CipherTextstring

标准加密的密钥密文。

MTYi00NDU0LTg5O****
DecryptKeyUristring

标准加密的解密服务地址。

https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
KeyServiceTypestring

密钥服务类型。目前仅支持 KMS 和 Base64

KMS
CombineConfigsobject []

多输入合流配置

AudioIndexstring

音频流 Index

0 或 exclude
VideoIndexstring

视频流 Index

0 或 exclude
Startdouble

输入流的开始时间。 默认为 0

0.0
Durationdouble

输入流的持续时间。 默认为视频时长。

20.0
UserDatastring

用户数据。

user-data
ScheduleConfigobject

任务调度配置。

PipelineIdstring

管道 ID。

e37ebee5d98b4781897f6086e89f9c56
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "9EDC30DC-0050-5459-B788-F761B2BE359B",
  "TranscodeParentJob": {
    "TranscodeJobList": [
      {
        "CreateTime": "2022-01-12T08:49:41Z",
        "Name": "transcode-job",
        "ParentJobId": "8b2198504dd340b7b3c9842a74fc9baa",
        "JobId": "7d6a7e0d4db2457a8d45ff5d43e1bf0a",
        "JobIndex": 0,
        "InputGroup": [
          {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4",
            "InputUrl": "oss://bucket/path/to/video.mp4"
          }
        ],
        "ProcessConfig": {
          "Transcode": {
            "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
            "OverwriteParams": {
              "Video": {
                "Codec": "H.264",
                "Profile": "Main",
                "Bitrate": "3000",
                "Crf": "23",
                "Width": "1920",
                "Height": "1080",
                "Fps": "25",
                "Gop": "250",
                "Preset": "medium",
                "ScanMode": "progressive",
                "PixFmt": "yuv420p",
                "Remove": "false",
                "Crop": "1280:800:0:140",
                "Pad": "1280:800:0:140",
                "LongShortMode": "false",
                "Bufsize": "6000",
                "Maxrate": "9000",
                "AbrMax": "6000"
              },
              "Audio": {
                "Codec": "AAC",
                "Profile": "aac_low",
                "Samplerate": "44100",
                "Bitrate": "128",
                "Channels": "2",
                "Remove": "false",
                "Volume": {
                  "Method": "auto",
                  "IntegratedLoudnessTarget": "-6",
                  "TruePeak": "-1",
                  "LoudnessRangeTarget": "8"
                }
              },
              "Container": {
                "Format": "mp4"
              },
              "MuxConfig": {
                "Segment": {
                  "Duration": "10",
                  "ForceSegTime": "2,3"
                }
              },
              "TransConfig": {
                "TransMode": "onepass",
                "IsCheckReso": "true",
                "IsCheckResoFail": "true",
                "IsCheckVideoBitrate": "true",
                "IsCheckVideoBitrateFail": "true",
                "IsCheckAudioBitrate": "true",
                "IsCheckAudioBitrateFail": "true",
                "AdjDarMethod": "none"
              },
              "Tags": {
                "key": ""
              }
            }
          },
          "ImageWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Width": "32",
                "Height": "32",
                "Dx": "10",
                "Dy": "10",
                "ReferPos": "TopLeft",
                "Timeline": {
                  "Start": "00:00:05",
                  "Duration": "ToEND"
                },
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "TextWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Content": "测试水印",
                "FontName": "SimSun",
                "FontColor": "#006400",
                "FontAlpha": "1.0",
                "Top": "10",
                "Left": "10",
                "FontSize": 16,
                "BorderWidth": 0,
                "BorderColor": "#006400",
                "Adaptive": "false"
              }
            }
          ],
          "Subtitles": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Format": "vtt",
                "CharEnc": "UTF-8",
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "Encryption": {
            "EncryptType": "PrivateEncryption",
            "CipherText": "MTYi00NDU0LTg5O****",
            "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****",
            "KeyServiceType": "KMS"
          },
          "CombineConfigs": [
            {
              "AudioIndex": "0 或 exclude",
              "VideoIndex": "0 或 exclude",
              "Start": 0,
              "Duration": 20
            }
          ],
          "IsInheritTags": true
        },
        "Output": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "OutputUrl": "oss://bucket/path/to/{MediaId}/{JobId}.mp4\n"
        },
        "UserData": "user-data",
        "ScheduleConfig": {
          "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
          "Priority": 5
        },
        "Status": "Init",
        "OutFileMeta": {
          "FileBasicInfo": {
            "MediaId": "486c2890096871edba6f81848c016303",
            "FileName": "file.m3u8",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "31737",
            "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
            "Region": "cn-shanghai",
            "FormatName": "hls,applehttp",
            "Duration": "403.039999",
            "Bitrate": "888.563",
            "Width": "848",
            "Height": "478"
          },
          "AudioStreamInfoList": [
            {
              "Index": "1",
              "CodecName": "aac",
              "CodecLongName": "AAC (Advanced Audio Coding)",
              "CodecTimeBase": "1/44100",
              "CodecTagString": "[15][0][0][0]",
              "CodecTag": "0x000f",
              "SampleFmt": "fltp",
              "SampleRate": "44100",
              "Channels": "2",
              "ChannelLayout": "stereo",
              "Timebase": "1/90000",
              "StartTime": "1.473556",
              "Duration": "403.039989",
              "Bitrate": "0.f",
              "Lang": "cn"
            }
          ],
          "VideoStreamInfoList": [
            {
              "Index": "0",
              "Codec_name": "h264",
              "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
              "Profile": "High",
              "Codec_time_base": "1/50",
              "Codec_tag_string": "[27][0][0][0]",
              "Codec_tag": "0x001b",
              "Width": "848",
              "Height": "478",
              "Has_b_frames": "2",
              "Sar": "478:477",
              "Dar": "16:9",
              "PixFmt": "yuv420p",
              "Level": "31",
              "Fps": "25.0",
              "Avg_fps": "25.0",
              "Time_base": "1/90000",
              "Start_time": "1.473556",
              "Duration": "403.039989",
              "Bit_rate": "888.563",
              "NumFrames": "10040",
              "Lang": "cn",
              "Rotate": "0"
            }
          ]
        },
        "SubmitResultJson": {},
        "SubmitTime": "2022-01-12T08:49:41Z",
        "FinishTime": "2022-01-12T08:49:41Z",
        "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262"
      }
    ],
    "CreateTime": "2022-01-12T08:49:41Z",
    "Name": "transcode-job",
    "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
    "ParentJobId": "8b2198504dd340b7b3c9842a74fc9baa",
    "JobCount": 1,
    "Status": "Success",
    "TriggerSource": "API",
    "Percent": 0,
    "SubmitTime": "2022-01-12T08:49:41Z",
    "FinishTime": "2022-01-12T08:49:41Z",
    "InputGroup": [
      {
        "Type": "OSS",
        "Media": "oss://bucket/path/to/video.mp4"
      }
    ],
    "OutputGroup": [
      {
        "Output": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "OutputUrl": "oss://bucket/path/to/video.mp4\n"
        },
        "ProcessConfig": {
          "Transcode": {
            "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
            "OverwriteParams": {
              "Video": {
                "Codec": "H.264",
                "Profile": "Main",
                "Bitrate": "3000",
                "Crf": "23",
                "Width": "1920",
                "Height": "1080",
                "Fps": "25",
                "Gop": "250",
                "Preset": "medium",
                "ScanMode": "progressive",
                "PixFmt": "yuv420p",
                "Remove": "false",
                "Crop": "1280:800:0:140",
                "Pad": "1280:800:0:140",
                "LongShortMode": "false",
                "Bufsize": "6000",
                "Maxrate": "9000",
                "AbrMax": "6000"
              },
              "Audio": {
                "Codec": "AAC",
                "Profile": "aac_low",
                "Samplerate": "44100",
                "Bitrate": "128",
                "Channels": "2",
                "Remove": "false",
                "Volume": {
                  "Method": "auto",
                  "IntegratedLoudnessTarget": "-6",
                  "TruePeak": "-1",
                  "LoudnessRangeTarget": "8"
                }
              },
              "Container": {
                "Format": "mp4"
              },
              "MuxConfig": {
                "Segment": {
                  "Duration": "10",
                  "ForceSegTime": "2,3"
                }
              },
              "TransConfig": {
                "TransMode": "onepass",
                "IsCheckReso": "true",
                "IsCheckResoFail": "true",
                "IsCheckVideoBitrate": "true",
                "IsCheckVideoBitrateFail": "true",
                "IsCheckAudioBitrate": "true",
                "IsCheckAudioBitrateFail": "true",
                "AdjDarMethod": "none"
              }
            }
          },
          "ImageWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Width": "32",
                "Height": "32",
                "Dx": "10",
                "Dy": "10",
                "ReferPos": "TopLeft",
                "Timeline": {
                  "Start": "00:00:05",
                  "Duration": "ToEND"
                },
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "TextWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Content": "测试水印",
                "FontName": "SimSun",
                "FontColor": "#006400",
                "FontAlpha": "1.0",
                "Top": "10",
                "Left": "10",
                "FontSize": 16,
                "BorderWidth": 0,
                "BorderColor": "#006400",
                "Adaptive": "false"
              }
            }
          ],
          "Subtitles": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Format": "vtt",
                "CharEnc": "UTF-8",
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "Encryption": {
            "EncryptType": "PrivateEncryption",
            "CipherText": "MTYi00NDU0LTg5O****",
            "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****",
            "KeyServiceType": "KMS"
          },
          "CombineConfigs": [
            {
              "AudioIndex": "0 或 exclude",
              "VideoIndex": "0 或 exclude",
              "Start": 0,
              "Duration": 20
            }
          ]
        }
      }
    ],
    "UserData": "user-data",
    "ScheduleConfig": {
      "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
      "Priority": 5
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-20API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-06-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-07-11新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈