订阅事件的json消息字段如表A-1所示。
表A-1 json 消息体字段说明
参数 类型 说明
event_type String 事件类型。
当前支持的取值如下：
● TranscodeComplete：转码完成
● TranscodeStart：转码启动，排完队，正式开 始转码时触发此事件
● ThumbnailComplete：截图完成
● RemuxComplete：转封装完成
● AnimatedGraphicsComplete：生成动图完成
● ParseComplete：属性解析完成 transcode_inf
o TranscodeInf
o 转码信息，仅当是转码完成事件或转码启动事件 才有该字段。
thumbnail_inf
o ThumbnailInf
o 截图信息，仅当是截图事件才有该字段。
animated_gra
phics_info AnimatedGra
phicsInfo 动图信息，仅当是生成动图事件才有该字段。
remux_info RemuxInfo 转封装信息，仅当是转封装事件才有该字段。
表A-2 TranscodeInfo 参数说明
参数 类型 说明
task_id string 任务ID。
用户指南 A 附录
参数 类型 说明 status tring 事件状态。
● TRANSCODING：转码启动
● SUCCEED：转码成功
● FAILED：转码失败 create_time string 任务创建时间。
start_time string 启动时间，指任务排完对正式开始执行的时间。
end_time string 任务结束时间。
intput FileAddress 转码文件输入地址。
output FileAddress 转码文件输出地址。
description string 任务描述。
media_detail MediaDetail 转码详细信息，失败时没有该字段。
表A-3 MediaDetail 参数说明
参数 类型 说明
features String[] 任务名称。
origin_para OriginPara 原始片源信息。
output_video_
paras OutputVideo
Para[] 多路输出片源信息。
output_water
mark_para OutputWater
markPara 输出水印信息。
表A-4 OriginPara 参数说明
参数 类型 说明
duration Integer 片源时长。
file_format String 文件格式。
video Video 原始片源视频信息。
audio Audio 原始片源音频信息。
用户指南 A 附录
表A-5 Video 参数说明
参数 类型 说明
width Integer 视频宽度。
height Integer 视频高度。
bitrate Integer 视频码率。
frame_rate Integer 视频帧率。
codec string 视频编码格式。
表A-6 Audio 参数说明
参数 类型 说明
codec string 音频编码格式。
sample Integer 音频采样率。
channels Integer 音频信道。
bitrate Integer 音频码率。
表A-7 OutputVideoPara 参数说明
参数 类型 说明
template_id Integer 输出视频对应的模板ID。
size Integer 视频大小。
pack string 视频封装格式。
video Video 输出片源视频信息。
audio Audio 输出片源音频信息。
file_name string 输出片源文件名。
conver_durati
on double 折算时长。
error Error 错误信息。
表A-8 OutputWatermarkPara 参数说明
参数 类型 说明
time_duration Int32 水印时长。
用户指南 A 附录
表A-9 AnimatedGraphicsInfo 参数说明
参数 类型 说明
task_id String 任务ID status String 事件状态。
● SUCCEED：生成动图成功
● FAILED：生成动图失败 create_time String 任务创建时间。
start_time String 任务启动时间，指任务排完对正式开始执行的时 间。
end_time String 任务结束时间。
description String 任务描述，如当任务异常时，此字段为异常的具 体信息。
input FileAddress 源文件信息。
output FileAddress 输出文件信息。
output_param AnimatedGra phicsOutputP aram
动图输出参数。
表A-10 FileAddress 参数说明
参数名 类型 说明
location String OBS桶所在区域。
bucket String OBS桶名。
object String 文件的存储路径。
● 当用于“input”时，需要指定到具体对象。
● 当用于“output”时，只需指定到转码结果期 望存放的路径。
file_name String 文件名，仅用于“output”输出。
● 当指定了此参数时，输出的对象名为“object/
file_name”；
● 当不指定此参数时，输出的对象名为“object/
xxx”，其中xxx由系统指定。
用户指南 A 附录
表A-11 AnimatedGraphicsOutputParam 参数说明
名称 类型 说明
format String 动图格式。目前仅支持输出GIF文件。
width Integer 输出动图的宽。
height Integer 输出动图的高。
start Integer 起始时间。
单位：毫秒。
end Integer 结束时间。
frame_rate Integer 动图帧率。
表A-12 ThumbnailInfo 参数说明
参数 类型 说明
task_id string 任务Id。
status tring 事件状态。
● SUCCEED：截图成功。
● FAILED：截图失败。
create_time string 开始时间。
start_time String 启动时间，指任务排完后正式开始执行的时间。
end_time string 结束时间。
intput FileAddress 源文件地址。
output FileAddress 截图文件输出地址。
description string 任务描述。
output_file_na
me String 输出文件名。
thumbnail_inf
o PicInfo[] 截图详细信息，失败时没有该字段。
表A-13 PicInfo 参数说明
参数 类型 说明
pic_name String 截图文件名。
用户指南 A 附录
表A-14 RemuxInfo 参数说明
参数 类型 说明
task_id String 任务ID。
status String 事件状态。
● SUCCEED：转封装成功。
● FAILED：转封装失败。
create_time String 任务创建时间。
start_time String 任务启动时间，指任务排完对正式开始执行的时 间。
end_time String 任务结束时间。
description String 任务描述，如当任务异常时，此字段为异常的具 体信息。
input FileAddress 源文件信息。
output FileAddress 输出文件信息。
output_param RemuxOutpu
tParam 转封装输出参数。
表A-15 RemuxOutputParam 参数说明
参数名 类型 说明
format String 输出格式。
取值如下：
● HLS
● MP4 segment_dura
tion Integer 分片时长，仅当format为“HLS”时有效。
取值范围：[2，10]。
默认值： 5。
单位：秒。
用户指南 A 附录