媒资上传完成事件--视频点播-火山引擎

文档中心

立即注册

导航

媒资上传完成事件

最近更新时间：2024.09.25 15:10:05首次发布时间：2021.02.23 10:42:37

本文为您介绍媒资上传完成事件。

事件类型

FileUploadComplete

事件说明

配置了媒资上传完成事件通知后，媒资上传完成时您将收到通知。配置方法详见事件通知概览。关联接口：获取上传地址和凭证。

注意

媒资上传完成时不一定能返回完整的元信息。因此如果您的业务对完整元信息有强依赖，请使用媒资上传提取元信息完成事件。

事件内容

参数	类型	示例值	说明
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
OptionInfo	OptionInfo	媒资信息
SpaceName	String	点播空间名称
SourceInfo	SourceInfo	片源信息
CallbackArgs	String	回调透传信息。如果您在上传时设置了 `CallbackArgs` 参数，在事件完成回调时会将用户自定义数据透传返回。
PosterUri	String	视频封面图 URI。仅当您在上传视频时设置视频封面后，才会返回该参数。
PlayUrl	String	音视频播放地址。仅当您在视频点播控制台系统设置 > 上传存储设置页面开启上传完成回调返回媒资播放地址后，才会返回该参数。
WorkflowInfo	WorkflowInfo	工作流任务信息。仅当您在视频点播控制台系统设置 > 上传存储设置页面开启上传完成回调返回工作流任务 ID，并在上传音视频时触发工作流任务后，才会返回该参数。说明您可以在上传时指定工作流 ID 或设置自动触发空间的默认工作流来触发工作流任务。

OptionInfo

媒资信息

参数	类型	描述
TemplateId	String	工作流 ID。注意 `TemplateId` 已废弃，推荐使用 `Templates` 参数。
Templates	Array of Template	工作流配置。

Template

工作流配置

参数	类型	示例	描述
TemplateIds	[]string	`["abcd***123"]`	工作流 ID。
TemplateType	String	`transcode`	工作流类型。取值如下： `transcode`: 在视频点播服务中创建的工作流。 `imp`: 在智能处理服务中创建的工作流。

参数

类型

示例

描述

TemplateIds

[]string

["abcd***123"]

工作流 ID。

TemplateType

String

transcode

工作流类型。取值如下：

transcode: 在视频点播服务中创建的工作流。
imp: 在智能处理服务中创建的工作流。

SourceInfo

片源信息

参数	类型	描述
AudioStreamMeta	AudioStreamMeta	音频流元信息
VideoStreamMeta	VideoStreamMeta	视频流元信息
StoreUri	String	文件存储位置
Height	Integer	视频高度，单位为 px
Width	Integer	视频宽度，单位为 px
Duration	Float	视频时长，单位为秒
Bitrate	Integer	视频码率，单位为 bps
Md5	String	文件 MD5 值
Format	String	文件格式
Size	Integer	文件大小，单位为字节
FileName	String	文件路径

AudioStreamMeta

音频流元信息

参数	类型	描述
Bitrate	Integer	音频码率，单位为 bps
Duration	Float	音频时长，单位为秒
SampleRate	Integer	音频采样率

VideoStreamMeta

视频流元信息

参数	类型	描述
Bitrate	Integer	音频码率，单位为 bps
Codec	String	视频编码格式
Definition	String	视频分辨率
Duration	Float	视频时长，单位为秒
Fps	Float	视频帧率，单位为 fps
Height	Integer	视频高度，单位为 px
Width	Integer	视频宽度，单位为 px

WorkflowInfo

工作流任务信息。

参数	类型	说明
IsReturnRunId	Boolean	是否在视频点播控制台空间内上传存储设置页面开启上传完成回调返回工作流任务 ID。
WorkflowItem	WorkflowItem	工作流任务具体信息。仅当 `IsReturnRunId` 字段为 `true` 且在上传音视频时指定工作流 ID 触发工作流任务时，才会返回该参数。

WorkflowItem

工作流任务具体信息。

参数	类型	说明
RunId	String	工作流任务 ID。
TemplateId	String	工作流 ID。
Code	String	错误码： `Success`：成功 `Failed`：失败。存在以下失败结果： `Failed.InvalidParameter`：工作流 ID 错误。 `Failed.RequestForbidden`：请求被禁止。 `Failed.ResourceNotFound`：无法找到 Vid。 `Failed.ResourceInUse`：Vid 正在被使用（删除时）。 `Failed.RequestLimitExceeded`：请求超过上限。 `Failed.InternalError`：服务器出错。 `Failed.ServiceUnavailable`：服务不可用。
message	String	错误具体信息。如果 `Code` 为 `Success`，`message` 为空。

回调示例

{
  "Data": {
    "Code": "Success",
    "Message": "Upload Video Success",
    "OptionInfo": {
      "TemplateId": "no"
    },
    "OptionInfo":{
        "TemplateId":""
        "Templates": [{
            "TemplateIds": ["templateId1"],
            "TemplateType": "transcode"
        }]
    },
    "PlayUrl": "https://example.vod.com/测试.mp4?auth_key=1706606324-f0bb2c2c***b7b08327752386",
    "SourceInfo": {
      "AudioStreamMeta": {
        "Bitrate": 72039,
        "Duration": 60.13823,
        "SampleRate": 44100
      },
      "Bitrate": 688607,
      "Duration": 60.139,
      "FileName": "测试.mp4",
      "FileType": "video",
      "Format": "MP4",
      "Height": 360,
      "Md5": "2cef3b65916b9***eca4a53dfaef6b",
      "Size": 5176518,
      "StoreUri": "tos-vod-v-3640747e9e4afe41/测试.mp4",
      "VideoStreamMeta": {
        "Bitrate": 688607,
        "Codec": "h264",
        "Definition": "unknown",
        "Duration": 60.139,
        "Fps": 24,
        "Height": 360,
        "Width": 640
      },
      "Width": 640
    },
    "SpaceName": "test",
    "Vid": "v0ccb5g70***og65robfoamj0"
  },
  "EventTime": "2024-01-30T08:18:43Z",
  "EventType": "FileUploadComplete",
  "RequestId": "20240130161***8031470CB09B0",
  "Version": "1.0"
}