You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/开发指南/事件通知/事件列表/工作流执行完成事件
工作流执行完成事件
最近更新时间：2024.11.04 17:48:04首次发布时间：2021.02.23 10:42:39
我的收藏

本文为您介绍工作流执行完成事件。

事件类型

WorkflowComplete

事件说明

配置了工作流执行完成事件通知后，工作流执行完成时您将收到通知。配置方法详见事件通知概览。关联接口：触发工作流。

事件内容

参数

类型

示例值

说明

RequestId

String

202405060***0CF1866

请求的唯一 ID

Version

String

1.0

回调版本

EventType

String

FileUploadComplete

事件名称

EventTime

String

2024-05-06T09:49:33Z

事件产生时间，UTC 时间，精度为秒。

Data

Data

-

回调内容，JSON 格式。

Data

参数

类型

说明

Code

String

状态码

Message

String

信息

Vid

String

视频 ID

RunId

String

工作流任务 ID

SpaceName

String

点播空间名

TemplateId

String

工作流 ID

CallbackArgs

String

回调透传信息。如果您在触发工作流时设置了 CallbackArgs 参数，在事件完成回调时会将用户自定义数据透传返回。

SourceInfo

SourceInfo

片源信息

PosterUri

String

封面图存储地址

TranscodeInfos

Array of TranscodeInfo

转码产物信息

AdaptBitrateTranscodeInfos

Array of AdaptBitrateTranscodeInfos

自适应码流信息

说明

如需使用自适应码流 ABR 功能，请提交工单联系技术支持开通。

Snapshots

Array of Snapshot

截图结果

SmartSubtitles

Array of SubtitleInfo

智能字幕结果

SourceInfo

片源信息

参数

类型

描述

FileId

String

文件 ID

Md5

String

文件 MD5 值

FileType

String

文件类型。类型为视频、纯音频。

Codec

String

编码类型

Height

Integer

视频高度，单位为 px

Width

Integer

视频宽度，单位为 px

Format

String

封装格式

Duration

Float

视频时长，单位为秒

Size

Integer

文件大小，单位为字节

FileName

String

文件路径

StoreUri

String

文件存储地址

Definition

String

视频分辨率

Bitrate

Integer

视频码率，单位为 bps

Fps

Float

视频帧率，单位为 fps

CreateTime

String

创建时间

Inspection

Inspection

片源检测结果。仅无则为空。

SourceAdjustResult

SourceAdjustResult

片源调整结果，仅检测时为空。

RepairResult

RepairResult

片源修复结果，无则为空。

Inspection

片源检测结果

参数

类型

描述

BlackFrames

Array of BlackFrameInfo

黑帧检测结果

interlace

Boolean

水波纹检测结果

Quality

Quality

视频质量检测结果

DeLogo

Array of DeLogoInfo

去水印检测结果

Suffix

Suffix

后贴片检测结果

BlackFrameInfo

黑帧检测结果

参数

类型

描述

Start

Float

黑帧开始时间，单位为秒

End

Float

黑帧结束时间，单位为秒

Duration

Float

黑帧持续时间，单位为秒

Quality

视频质量检测结果

参数

类型

描述

Visual

VisualQuality

图像质量参数

VolumeInfo

VolumeInfo

音量信息

VisualQuality

图像质量参数

参数

类型

描述

VQScore

Float

画质检测-VQScore 视频质量评分

Contrast

Float

对比度

Colorfulness

Float

色彩

Brightness

Float

亮度

Texture

Float

纹理

Noise

Float

噪声

VolumeInfo

音量信息

参数

类型

描述

Loudness

Float

响度， 单位为 LUFS

Peak

Float

峰值， 取值范围为 (0, 1.0]，峰值归一化

MeanVolume

Float

均值， 单位为 dB

MaxVolume

Float

最大值， 单位为 dB

DeLogoInfo

去水印检测结果

参数

类型

描述

AnchorWidth

Integer

Anchor 宽度

AnchorHeight

Integer

Anchor 高度

PosX

Integer

水印左上角 X 坐标

PosY

Integer

水印左上角 Y 坐标

SizeX

Integer

水印宽度

SizeY

Integer

水印高度

Suffix

后贴片检测结果

参数

类型

描述

StartTime

Float

后贴片开始时间，单位为秒

EndTime

Float

后贴片结束时间，单位为秒

SourceAdjustResult

片源调整结果

参数

类型

描述

AdjustType

String

片源调整类型：

  • origin_video：替换片源
  • new_vid：生成新 vid

Vid

String

片源新的视频 ID。仅 AdjustType 为 new_vid 时会返回该字段。

RepairResult

片源修复结果

参数

类型

描述

BlackFrames

Integer

黑帧去除结果：

  • 0：未执行
  • 1：已执行

Interlace

Integer

水波纹去除结果：

  • 0：未执行
  • 1：已执行

DeLogo

Integer

去水印去除结果：

  • 0：未执行
  • 1：粗粒度
  • 2 ：精细化

Suffix

Integer

后贴片去除结果：

  • 0：未执行
  • 1：已执行

TranscodeInfo

转码产物信息

参数

类型

描述

FileId

String

文件 ID

Md5

String

文件哈希

FileType

String

文件类型

LogoType

String

水印贴片标签。即您在视频点播控制台创建水印贴片模板时设置的自定义水印贴片标签，详见水印贴片模板。

Encrypt

Boolean

是否加密

Format

String

封装格式

Duration

Float

转码流时长，单位为秒

Size

Integer

文件大小，单位为字节

FileName

String

文件路径

StoreUri

String

文件存储地址

VideoStreamMeta

VideoStreamMeta

视频流元信息

AudioStreamMeta

AudioStreamMeta

音频流元信息

Quality

EncodedQuality

转码流质量参数，无则为空

RepairResult

RepairResult

转码流修复结果，无则为空

CreateTime

String

创建时间

Height

Integer

视频高度，单位为 px

Width

Integer

视频宽度，单位为 px

Fps

Float

视频帧率，单位为 fps

Bitrate

Integer

视频码率，单位为 bps

VideoStreamMeta

视频流元信息

参数

类型

描述

Duration

Float

视频流时长，单位为秒

Definition

Float

清晰度

Codec

String

编码类型

Bitrate

Integer

视频码率，单位为 bps

AudioStreamMeta

音频流元信息

参数

类型

描述

Codec

String

编码类型，仅在纯音频时返回

Duration

Float

音频流时长，单位为秒

SampleRate

Float

音频采样率，仅在纯音频时返回

Bitrate

Integer

音频码率，仅在纯音频时返回

EncodedQuality

转码流质量参数

参数

类型

描述

Visual

VisualQuality

转码流图像质量参数。

VolumeInfo

VolumeInfo

音量信息。

PSNR

PSNR

峰值信噪比结果（PSNR，Peak Signal-to-Noise Ratio）

SSIM

SSIM

结构相似性结果（SSIM，Structural SIMilarity）。仅转码后视频可计算，有则返回

VMAF

Float

视频多方法评估融合结果（Video Multi-method Assessment Fusion，VMAF)

PSNR

峰值信噪比结果

参数

类型

描述

PSNR_Y

Float

y 分量 psnr

PSNR_U

Float

u 分量 psnr

PSNR_V

Float

v 分量 psnr

PSNR_G

Float

Global psnr 默认推荐用 psnr_g

SSIM

结构相似性结果

参数

类型

描述

SSIM_Y

Float

y 分量 ssim

SSIM_U

Float

u 分量 ssim

SSIM_V

Float

v 分量 ssim

SSIM_G

Float

Global ssim 默认推荐用 ssim_g

AdaptBitrateTranscodeInfos

自适应码流信息

参数

类型

描述

FileId

String

文件 ID

Encrypt

Boolean

是否加密

LogoType

String

水印贴片标签。即您在视频点播控制台创建水印贴片模板时设置的自定义水印贴片标签，详见水印贴片模板。

Format

String

Format

Size

Integer

文件大小，单位为字节

StoreUri

String

文件存储地址

SubAdaptBitrateStreamMetas

Array of SubAdaptBitrateStreamMeta

子流元信息

CreateTime

String

创建时间

SubAdaptBitrateStreamMeta

子流元信息

参数

类型

描述

FileType

String

文件类型。取值如下：

  • video：普通视频流。
  • audio：普通音频流。

Codec

String

编码格式。

说明

FileType 取值为 video 时，仅返回视频 Codec。

Height

Integer

视频高度，单位为 px

说明

该参数仅当 FileType 取值为 video 时返回。

Width

Integer

视频宽度，单位为 px

说明

该参数仅当 FileType 取值为 video 时返回。

Duration

Float

文件时长，单位为秒

Definition

String

视频清晰度

说明

该参数仅当 FileType 取值为 video 时返回。

Bitrate

Integer

码率，单位为 bps

Fps

Float

视频帧率，单位为 fps

说明

该参数仅当 FileType 取值为 video 时返回。

Size

Integer

文件大小，单位为字节

Snapshot

截图结果

参数

类型

说明

Type

String

截图类型。取值如下：

  • Poster：静态图
  • Dynpost：动态图
  • AnimatedPoster：反复循环动图
  • Sprite：雪碧图
  • Sample：采样截图
  • AIDynpost：智能封面（AI 动图）

Params

Object

不同类型的截图返回不同的结果，详见以下：

Poster

静态图

参数

类型

说明

Format

String

图片格式

StoreUri

String

图片存储地址

Width

Integer

图片宽度，单位为 px

Height

Integer

图片高度，单位为 px

Dynpost

动图

参数

类型

说明

Format

String

图片格式

StoreUri

String

图片存储地址

Width

Integer

图片宽度，单位为 px

Height

Integer

图片高度，单位为 px

AnimatedPoster

反复循环动图

参数

类型

说明

Format

String

图片格式

StoreUri

String

图片存储地址

Width

Integer

图片宽度，单位为 px

Height

Integer

图片高度，单位为 px

Sprite

雪碧图

参数

类型

说明

Format

String

图片格式

StoreUris

Array of String

多张雪碧图的存储地址

CellWidth

Integer

图片宽度，单位为 px

CellHeight

Integer

图片高度，单位为 px

ImgXLen

Integer

水平方向缩略小图个数

ImgYLen

Integer

垂直方向缩略小图个数

Interval

Integer

截图间隔，单位为秒

CaptureNum

Integer

截取的缩略小图总数量

Sample

采样截图

参数

类型

说明

Format

String

图片格式

StoreUris

Array of String

多张采样截图的存储地址。在视频点播控制台的截图模板中配置采样截图的输出方式选择截图 Uri 时，结果在该参数 StoreUris 中获取。具体参数配置请参见配置采样截图参数。

说明

该 StoreUris 参数，会按照 Offsets 参数指定时间点依次返回截图。

IndexUri

String

截图 Index 文件 Uri 地址。在视频点播控制台的截图模板中配置采样截图的输出方式选择截图地址文件时，结果在该参数 IndexUri 中获取。具体参数配置请参见配置采样截图参数。

说明

  • 每行一个截图结果。
  • 该 IndexUri 参数会按照 Offsets 参数指定时间点依次返回截图。示例：{"StoreUri": "xxx/uri1", "Offset": [2.5]}

Width

Integer

图片宽度，单位为 px

Height

Integer

图片高度，单位为 px

Interval

Float

截图间隔，单位为秒

CaptureNum

int32

截图数量

Duration

Float

片源时长，单位为秒

Offsets

Array of Float

各个截图的时间点。默认会升序排序输出。

AIDynpost

智能封面（AI 动图）

参数

类型

说明

Format

String

图片格式

StoreUri

String

图片存储地址

Width

Integer

图片宽度，单位为 px

Height

Integer

图片高度，单位为 px

SubtitleInfo

智能字幕信息

参数

类型

说明

Language

String

字幕语言

Source

String

字幕来源：

  • SE：提取字幕流
  • ASR：语音转写
  • MT：机器翻译

Format

String

字幕格式

FileName

String

字幕产物文件路径

Size

Int64

字幕文件大小，单位为字节

回调错误码

错误码

说明

Success

成功

InvalidParameter.InvalidMediaStream

解析音视频流失败

InvalidParameter.MissingMediaStream

缺少音视频流

InvalidParameter.InvalidUriError

用户地址非法

InvalidParameter.InvalidVidOrUri

输入源不存在

InternalError

内部错误

InternalError.DownloadError

系统下载错误

InternalError.UploadError

系统上传错误

InternalError.ExecutionTimeout

任务执行超时

回调示例

Vid 模式下，工作流执行完成事件的回调示例如下所示。

{
  "Version": "1.0",
  "Data": {
    "Code": "Success",
    "Snapshots": [
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos***/cbe797357ecf439291dbec4a26b69dd5",
          "Width": 360,
          "Height": 640,
          "Format": "jpeg"
        },
        "Type": "Poster"
      },
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos***/c5d95e55fdbb46709b62c8c5f7e4a6aa",
          "Width": 360,
          "Height": 640,
          "Format": "gif"
        },
        "Type": "Dynpost"
      },
      {
        "Params": {
          "Width": 540,
          "Height": 960,
          "Format": "webp",
          "Uri": "tos***/89523e5554a74***9c6898761055a83"
        },
        "Type": "AIDynpost"
      },
      {
        "Params": {
          "StoreUri": "tos***/250f70a8010945f5b1ca005d315bc889",
          "Width": 360,
          "Height": 640,
          "Format": "webp"
        },
        "Type": "AnimatedPoster"
      },
      {
        "Params": {
          "StoreUris": [
            "tos***/14437a144eb149f7a8a38b8b731f8a96"
          ],
          "CellHeight": 240,
          "ImgXLen": 5,
          "CaptureNum": 1,
          "Interval": 10,
          "ImgYLen": 5,
          "Format": "jpeg",
          "CellWidth": 136
        },
        "Type": "Sprite"
      },
      {
        "Params": {
          "StoreUris": [
            "tos***/fd5856116d7c454daa44b906f37fabee"
          ],
          "CaptureNum": 1,
          "Width": 540,
          "Height": 960,
          "Format": "jpeg",
          "Duration": 14.933333,
          "Interval": 10,
          "Offsets": [1]
        },
        "Type": "Sample"
      }
    ],
    "TemplateId": "995745b286fc4be***3cf6f65877df72",
    "SpaceName": "test",
    "SourceInfo": {
      "Bitrate": 2240042,
      "Definition": "unknown",
      "FileName": "111",
      "RepairResult": {},
      "StoreUri": "tos**/111",
      "Width": 720,
      "FileType": "video",
      "SourceAdjustResult": {},
      "Format": "MP4",
      "Codec": "h264",
      "Inspection": {
        "Quality": {}
      },
      "Md5": "4ee56e0d8a687***173a65dc73b7",
      "FileId": "v0ccfeg7007a***3c77ucpfe19890",
      "Duration": 15.093,
      "Size": 4226121,
      "Height": 1280,
      "Fps": 30,
      "CreateTime": "2023-04-10T11:05:31Z"
    },
    "Vid": "v0ccfeg7007acg***c77ucpfe19890",
    "TranscodeInfos": [
      {
        "Quality": {
          "Visual": {
            "Noise": 0,
            "Contrast": 0,
            "Colorfulness": 0,
            "Texture": 0,
            "Brightness": 0
          }
        },
        "AudioStreamMeta": {
          "Bitrate": 64701,
          "SampleRate": 44100,
          "Duration": 15.046,
          "Codec": "aac"
        },
        "FileName": "owzbee1ls6pzUnZQok2Q0lkgZiDfZIfgecJnQ7",
        "CreateTime": "2023-04-10T11:06:59Z",
        "VideoStreamMeta": {
          "Bitrate": 430977,
          "Definition": "360p",
          "Duration": 14.933,
          "Codec": "h264"
        },
        "StoreUri": "tos***/owzbee1ls6pzUnZQok2Q0lkgZiDfZIfgecJnQ7",
        "Width": 360,
        "FileType": "video",
        "Format": "MP4",
        "Duration": 15.047,
        "Bitrate": 501844,
        "LogoType": "",
        "Encrypt": false,
        "FileId": "e5f487ef36cb47a***1212f8086070",
        "Size": 943907,
        "Height": 640,
        "Fps": 30
      },
      {
        "Quality": {
          "Visual": {
            "Noise": 0,
            "Contrast": 0,
            "Colorfulness": 0,
            "Texture": 0,
            "Brightness": 0
          }
        },
        "AudioStreamMeta": {
          "Bitrate": 64000,
          "Duration": 15.073,
          "Codec": "mp3",
          "SampleRate": 44100
        },
        "FileName": "oIIAzkUPzBf2jH59MwUrIfhCa7z2oMBkyNS6hM",
        "CreateTime": "2023-04-10T11:08:09Z",
        "VideoStreamMeta": {
          "Definition": "",
          "Bitrate": 0,
          "Duration": 0
        },
        "StoreUri": "tos***/oIIAzkUPzBf2jH59MwUrIfhCa7z2oMBkyNS6hM",
        "Width": 0,
        "FileType": "audio",
        "Format": "MP3",
        "Duration": 15.073,
        "Bitrate": 64134,
        "LogoType": "",
        "Encrypt": false,
        "FileId": "24a57db262ec41***3d33577db4e1362",
        "Size": 120834,
        "Height": 0,
        "Fps": 0
      }
    ],
    "SubAdaptBitrateStreamMetas": [
          {
            "Height": 480,
            "Size": 1307500,
            "Fps": 25,
            "Duration": 40.16,
            "Codec": "h264",
            "Definition": "480p",
            "FileType": "Video",
            "Width": 854,
            "Bitrate": 355019
          }

        ],
        "FileId": "cb8873e4cbe5***023b6fb80a8ba",
        "CreateTime": "2023-10-25T08:37:34Z",
        "Format": "DASH",
        "LogoType": "watermark",
        "Encrypt": true
      }
    ],
    "PosterUri": "tos***/0f2cd3c43e8346d096a42ce8f58b466d",
    "CallbackArgs": "",
    "Message": "Success",
    "RunId": "bb:d5d9c4581b238***2a08ccb73457e24"
  },
  "EventType": "WorkflowComplete",
  "RequestId": "20230410190649D***4BE92C2507504B",
  "EventTime": "2023-04-10T11:08:38Z"
}

DirectUrl 模式下，工作流执行完成事件的回调示例如下所示。

{
  "Version": "1.0",
  "Data": {
    "Code": "Success",
    "Snapshots": [
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos/f3159cf887***be5815eecd0f429",
          "Width": 360,
          "Height": 640,
          "Format": "jpeg"
        },
        "Type": "Poster"
      },
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos/b56db927142***a8ca67e33d9a93",
          "Width": 360,
          "Height": 640,
          "Format": "gif"
        },
        "Type": "Dynpost"
      },
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos/5e1296c71af***68e7296e82175e77f",
          "Width": 540,
          "Height": 960,
          "Format": "webp"
        },
        "Type": "AIDynpost"
      },
      {
        "Params": {
          "OffsetTime": 0,
          "StoreUri": "tos/439201bda9a***b44d905504c6d578",
          "Width": 360,
          "Height": 640,
          "Format": "webp"
        },
        "Type": "AnimatedPoster"
      },
      {
        "Params": {
          "StoreUris": [
            "tos/140b0807c2fe4***2e8d807f5bf3c22"
          ],
          "ImgXLen": 5,
          "Interval": 10,
          "CaptureNum": 1,
          "CellWidth": 136,
          "ImgYLen": 5,
          "Format": "jpeg",
          "CellHeight": 240
        },
        "Type": "Sprite"
      },
      {
        "Params": {
          "StoreUris": [
            "tos/e981ff2e41054a2b***63da3703d6ba4f"
          ],
          "CaptureNum": 1,
          "Width": 540,
          "Height": 960,
          "Format": "jpeg",
          "Duration": 14.933333,
          "Interval": 10,
          "Offsets": [1]
        },
        "Type": "Sample"
      }
    ],
    "TemplateId": "995745b286f***3993cf6f65877df72",
    "SpaceName": "test",
    "SourceInfo": {
      "Md5": "4ee56e0d8a6***0d5173a65dc73b7",
      "StoreUri": "tos/111***",
      "Width": 720,
      "Height": 1280,
      "Size": 4226121,
      "Bitrate": 2240042,
      "Duration": 15.093,
      "Fps": 30
    },
    "Vid": "",
    "TranscodeInfos": [
      {
        "AudioStreamMeta": {
          "Bitrate": 64701,
          "SampleRate": 44100,
          "Duration": 15.046,
          "Codec": "aac"
        },
        "Quality": {
          "Visual": {
            "Noise": 0,
            "Contrast": 0,
            "Colorfulness": 0,
            "Texture": 0,
            "Brightness": 0
          }
        },
        "VideoStreamMeta": {
          "Bitrate": 430977,
          "Definition": "360p",
          "Duration": 14.933,
          "Codec": "h264"
        },
        "StoreUri": "tos/d10f3838a86a4***8cdc9452305fb",
        "Width": 360,
        "FileType": "Video",
        "Format": "MP4",
        "Duration": 15.047,
        "Bitrate": 501827,
        "FileId": "15a01d88a6e64***b732f4f5006cf0b6",
        "Encrypt": false,
        "LogoType": "",
        "Size": 943875,
        "Height": 640,
        "Fps": 30
      },
      {
        "AudioStreamMeta": {
          "Bitrate": 64000,
          "Duration": 15.073,
          "Codec": "mp3",
          "SampleRate": 44100
        },
        "Quality": {
          "Visual": {
            "Noise": 0,
            "Contrast": 0,
            "Colorfulness": 0,
            "Texture": 0,
            "Brightness": 0
          }
        },
        "VideoStreamMeta": {
          "Definition": "",
          "Bitrate": 0,
          "Duration": 0
        },
        "StoreUri": "tos/62038dc1a***9718de3344a6d49502d",
        "Width": 0,
        "FileType": "Audio",
        "Format": "MP3",
        "Duration": 15.072653,
        "Bitrate": 64134,
        "FileId": "a3c1862cfe244***0fad9b692b91d",
        "Encrypt": false,
        "LogoType": "",
        "Size": 120834,
        "Height": 0,
        "Fps": 0
      }
    ],
    "CallbackArgs": "",
    "Message": "Success",
    "RunId": "bb:f417ffeac602***738e334bffbef2fd"
  },
  "EventType": "WorkflowComplete",
  "RequestId": "2023041019072***841FA060A92080760",
  "EventTime": "2023-04-10T11:08:46Z"
}