You need to enable JavaScript to run this app.
文档中心
视频点播

视频点播

复制全文
下载 pdf
事件列表
媒资上传完成事件
复制全文
下载 pdf
媒资上传完成事件

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

事件类型

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

是

错误码。成功时为 Success

Message

String

是

具体信息

Vid

String

是

视频 ID

Mid

String

是

素材 ID

SpaceName

String

是

空间名称

OptionInfo

OptionInfo

否

媒资信息

SourceInfo

SourceInfo

是

片源信息

VodUploadSource

String

是

音视频来源。取值如下:

  • upload:通过视频点播控制台、客户端上传 SDK、视频点播服务端 SDK 等方式上传至视频点播的视频。
  • live:通过火山引擎视频直播录制并存储至视频点播的视频。
  • rtc:通过火山引擎 RTC 录制并存储至视频点播的视频。
  • url_upload:通过 URL 批量拉取方式上传至视频点播的视频。
  • media_process:通过视频点播媒体处理服务生成的、会生成新 Vid 的视频。例如您通过多媒体 AI 模板生成的精彩剪辑,系统会单独生成 Vid。
  • media_edit:通过视频点播剪辑服务生产的视频。

CallbackArgs

String

否

回调透传信息。仅当您在上传时设置了 CallbackArgs 参数传递自定义数据后,才会返回该参数。

PosterUri

String

否

视频封面图 URI。仅当您在上传视频时设置视频封面后,才会返回该参数。

PlayUrl

String

否

音视频播放地址。仅当您在视频点播控制台空间设置 > 上传存储设置页面开启上传完成回调返回媒资播放地址后,才会返回该参数。

WorkflowInfo

WorkflowInfo

否

工作流任务信息。仅当您在视频点播控制台空间设置 > 上传存储设置页面开启上传完成回调返回工作流任务 ID,并在上传音视频时触发工作流任务后,才会返回该参数。

说明

您可以在上传时指定工作流 ID 或设置自动触发空间的默认工作流来触发工作流任务。

OptionInfo

媒资信息

参数

类型

是否必传

描述

TemplateId

String

否

工作流 ID。

警告

TemplateId 已废弃,推荐使用 Templates 参数。

Templates

Array of Template

否

工作流配置。仅当您在上传音视频时指定了工作流 ID 触发媒体处理任务后,才会返回该参数。

Template

工作流配置

参数

类型

是否必传

描述

TemplateIds

[]string

否

工作流 ID。

TemplateType

String

否

工作流类型。取值如下:

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

SourceInfo

片源信息。

注意

媒资上传完成时系统不一定能返回完整的元信息。如果元信息抽取未完成或失败,除 StoreUri 和 FileName 外的其它参数都可能为空。

参数

类型

是否必传

描述

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

是

文件路径

OriginHeight

Integer

否

视频编码高度,单位为 px

OriginWidth

Integer

否

视频编码宽度,单位为 px

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。仅当您在视频点播控制台上传存储设置页面开启上传完成回调返回工作流任务 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

否

错误具体信息。如果 WorkflowItem.Code 为 Success,WorkflowItem.Message 为空。

回调示例

{
  "Data": {
    "Code": "Success",
    "Message": "Upload Video Success",
    "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"
}
最近更新时间:2026.10.27 16:18:32
这个页面对您有帮助吗?
有用
有用
无用
无用