You need to enable JavaScript to run this app.
导航
上传功能函数说明
最近更新时间:2024.08.01 16:35:46首次发布时间:2023.12.27 15:28:59

本文为您介绍确认上传接口请求参数中 Functions 参数的说明。

Functions

Functions 为可扩展的 JSON 数组,示例代码如下:

{
  "Functions": [
    {
      "Name": "Snapshot",
      "Input": {
        "SnapshotTime": 2.0
      }
    },
    {
      "Name": "xxx",
      "Input": {}
    }
  ]
}

JSON 数组支持的参数说明如下:

参数

类型

说明

Name

String

上传功能函数名称。支持以下函数:

  • Snapshot:截图。配置此功能后,您可通过响应中的 PosterUri 字段获取图片地址。
  • AddOptionInfo:设置媒资信息。
  • StartWorkflow:触发工作流。
  • CaptionUpload:上传字幕文件。

Input

Object

上传功能具体配置。对于不同的上传功能函数,您可传入不同的配置,具体如下:

SnapshotInput

截图配置。

参数

类型

示例

描述

SnapshotTime

Float

2

截图时间。点播服务端会截取该时间的视频帧作为视频封面。单位为秒,默认值为 0。

OptionInfo

媒资信息配置。

参数

类型

示例

描述

Title

String

上传

媒资标题。大小不超过 512 个字符。

Tags

String

01

媒资标签。多个标签可用逗号隔开。

Description

String

视频上传测试

媒资描述。

RecordType

Integer

1

媒资类型。取值如下:

  • 1:音视频。
  • 2:素材。

说明

音视频和素材的定义详见媒资上传概述

Category

String

video

素材类型。取值如下:

  • video: 视频。
  • audio: 音频。
  • image: 图片。
  • dynamic_img: 动图。
  • subtitle: 字幕。
  • font: 字体。

Format

String

mp4

媒资格式。上传素材时,如传入 Format,控制台展示以您传入的参数为准,否则以系统识别出的 Format 为准。若遇到特殊文件无法识别,Format 可能为空。

ClassificationId

int64

1702994957

音视频的分类 ID。音视频的分类是由您自行创建并管理的,方式如下:

IsHlsIndexOnly

Boolean

true

是否仅为 HLS 索引文件。取值如下:

  • true: 仅为 HLS 索引文件,删除 Vid 文件时,不会删除关联的 TS 文件。
  • false: 删除 Vid 文件时,会删除关联的 TS 文件。

WorkflowInput

触发工作流配置。

参数

类型

示例

描述

Templates

Object of Template

-

工作流信息。上传完成后如果希望自动触发媒体处理工作流,可传入此参数。

TemplateId

String

732db535401***8c234dc3aef

工作流 ID。上传完成后如果希望自动触发媒体处理工作流,可传入此参数。可在视频点播控制台媒体处理 > 工作流页面获取工作流 ID。

注意

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

Template

工作流信息

参数

类型

示例

描述

TemplateIds

[]string

["abcd***123"]

工作流 ID。可在视频点播控制台媒体处理 > 工作流页面获取工作流 ID。当前仅支持单个工作流 ID。

TemplateType

String

transcode

工作流类型。取值如下:

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

CaptionUpload

字幕上传配置。

参数

类型

示例

描述

Vid

String

v03c***eg0

视频 ID。

Fid

String

v03c2***8eg0

文件 ID。

Language

String

eng-US

字幕语言。具体取值请参见字幕语言

Format

String

webvtt

字幕格式。取值如下:

  • webvtt
  • ass

说明

当字幕格式为 webvtt 时,带序号行的字幕文件不支持上传。

StoreUri

String

tos-vod-cn-v-03e4d54ef31***66a7d8c39f

字幕文件存储 URI。

Title

String

test

字幕标题。最长 128 字符。不传为不修改,传空为置空。

Source

String

MU

字幕上传来源。取值如下:

  • MT:机器翻译
  • ASR:语音转写
  • MU:(默认)人工上传

Tag

String

01

字幕标签。最长 128 字符。不传为不修改,传空为置空。

AutoPublish

Boolean

true

是否自动发布。取值如下:

  • true:自动发布
  • false:(默认)不自动发布

ActionType

String

upload

操作类型。取值如下:

  • upload:(默认)上传
  • replace:替换

FileTypeCategory 的对应关系

获取上传地址和凭证接口中 FileType 参数取值和确认上传接口中 Category 参数取值的对应关系如下表所示:

FileType 取值

对应 Category 取值

media

  • video:视频。
  • audio:音频。

image

  • image:图片。
  • dynamic_img:动图。

object

  • subtitle:字幕。
  • font:字体。