文档首页 > > 用户指南> 附录> 消息通知json格式说明

消息通知json格式说明

分享
更新时间:2020/07/08 GMT+08:00

订阅事件的json消息字段如表1所示。

表1 json消息体字段说明

参数

类型

说明

event_type

String

事件类型。

当前支持的取值如下:
  • TranscodeComplete:转码完成
  • TranscodeStart:转码启动,排完队,正式开始转码时触发此事件
  • ThumbnailComplete:截图完成
  • RemuxComplete:转封装完成
  • AnimatedGraphicsComplete:生成动图完成
  • ParseComplete:属性解析完成

transcode_info

TranscodeInfo

转码信息,仅当是转码完成事件或转码启动事件才有该字段。

thumbnail_info

ThumbnailInfo

截图信息,仅当是截图事件才有该字段。

animated_graphics_info

AnimatedGraphicsInfo

动图信息,仅当是生成动图事件才有该字段。

remux_info

RemuxInfo

转封装信息,仅当是转封装事件才有该字段。

表2 TranscodeInfo参数说明

参数

类型

说明

task_id

string

任务ID。

status

tring

事件状态。
  • TRANSCODING:转码启动
  • SUCCEED:转码成功
  • FAILED:转码失败

create_time

string

任务创建时间。

start_time

string

启动时间,指任务排完对正式开始执行的时间。

end_time

string

任务结束时间。

intput

FileAddress

转码文件输入地址。

output

FileAddress

转码文件输出地址。

description

string

任务描述。

media_detail

MediaDetail

转码详细信息,失败时没有该字段。

表3 MediaDetail参数说明

参数

类型

说明

features

String[]

任务名称。

origin_para

OriginPara

原始片源信息。

output_video_paras

OutputVideoPara[]

多路输出片源信息。

output_watermark_para

OutputWatermarkPara

输出水印信息。

表4 OriginPara参数说明

参数

类型

说明

duration

Integer

片源时长。

file_format

String

文件格式。

video

Video

原始片源视频信息。

audio

Audio

原始片源音频信息。

表5 Video参数说明

参数

类型

说明

width

Integer

视频宽度。

height

Integer

视频高度。

bitrate

Integer

视频码率。

frame_rate

Integer

视频帧率。

codec

string

视频编码格式。

表6 Audio参数说明

参数

类型

说明

codec

string

音频编码格式。

sample

Integer

音频采样率。

channels

Integer

音频信道。

bitrate

Integer

音频码率。

表7 OutputVideoPara参数说明

参数

类型

说明

template_id

Integer

输出视频对应的模板ID。

size

Integer

视频大小。

pack

string

视频封装格式。

video

Video

输出片源视频信息。

audio

Audio

输出片源音频信息。

file_name

string

输出片源文件名。

conver_duration

double

折算时长。

error

Error

错误信息。

表8 OutputWatermarkPara参数说明

参数

类型

说明

time_duration

Int32

水印时长。

表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

AnimatedGraphicsOutputParam

动图输出参数。

表10 FileAddress参数说明

参数名

类型

说明

location

String

OBS桶所在区域。

bucket

String

OBS桶名。

object

String

文件的存储路径。

  • 当用于“input”时,需要指定到具体对象。
  • 当用于“output”时,只需指定到转码结果期望存放的路径。

file_name

String

文件名,仅用于“output”输出。

  • 当指定了此参数时,输出的对象名为“object/file_name”
  • 当不指定此参数时,输出的对象名为“object/xxx”,其中xxx由系统指定。
表11 AnimatedGraphicsOutputParam参数说明

名称

类型

说明

format

String

动图格式。目前仅支持输出GIF文件。

width

Integer

输出动图的宽。

height

Integer

输出动图的高。

start

Integer

起始时间。

单位:毫秒。

end

Integer

结束时间。

frame_rate

Integer

动图帧率。

表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_name

String

输出文件名。

thumbnail_info

PicInfo[]

截图详细信息,失败时没有该字段。

表13 PicInfo参数说明

参数

类型

说明

pic_name

String

截图文件名。

表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

RemuxOutputParam

转封装输出参数。

表15 RemuxOutputParam参数说明

参数名

类型

说明

format

String

输出格式。

取值如下:
  • HLS
  • MP4

segment_duration

Integer

分片时长,仅当format为“HLS”时有效。

取值范围:[2,10]。

默认值: 5。

单位:秒。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问