You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

上传功能函数说明

最近更新时间：2024.03.28 20:49:48

首次发布时间：2023.12.27 15:28:59

我的收藏

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

Functions 列表

Functions 为可扩展的 JSON 数组，示例代码如下：

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

详细的参数说明如下：

NameInput响应对应的信息描述
SnapshotSnapshotInputPosterUri截图功能。
AddOptionInfoOptionInfo无添加媒资信息功能。
StartWorkflowWorkflowInput无触发工作流功能。

GetMeta

无

VideoMeta

获取属性功能。

  • 若不传，上传成功与否不依赖抽取 Meta，可能取到 Meta 也可能没有 Meta。

  • 若传，则获取 Meta 与上传成功强绑定，当获取 Meta 失败的时候，上传失败。

SnapshotInput

参数类型示例描述
SnapshotTimeFloat2截图时间。点播服务端会截取该时间的视频帧作为视频封面。单位为秒，默认值为 0。

OptionInfo

参数类型示例描述
TitleString上传媒资标题。大小不超过 512 个字符。
TagsString01媒资标签。多个标签可用逗号隔开。
DescriptionString视频上传测试媒资描述。

RecordType

Integer

1

媒资类型。取值如下：

  • 1：音视频。

  • 2：素材。

说明

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

Category

String

video

素材类型。可选的取值如下：

  • video:视频。

  • audio:音频。

  • image:图片。

  • dynamic_img:动图。

  • subtitle:字幕。

  • font:字体。

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

ClassificationId

int64

1702994957

分类 ID。您可通过以下方式获取分类 ID：

  • 在视频点播控制台系统设置 > 分类管理页面查看。

  • 通过媒资分类接口查询。

说明

素材不支持分类。

IsHlsIndexOnly

Boolean

true

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

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

  • false: 删除 Vid 文件时，会删除关联的 TS 文件。

WorkflowInput

参数类型示例描述
TemplateIdString732db535401***8c234dc3aef工作流模板 ID。

FileType 和 Category 的对应关系

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

FileType 取值对应 Category 取值

media

  • video：视频。

  • audio：音频。

image

  • image：图片。

  • dynamic_img：动图。

object

  • subtitle：字幕。

  • font：字体。

注意事项

上传素材时，需注意 Function 的顺序。当有 GetMeta 函数时，必须放在最前面。代码示例如下所示。

{
  "Functions": [
    {
      "Name": "GetMeta"
    },
    {
      "Name": "Snapshot",
      "Input": {
        "SnapshotTime": 0
      }
    },
    {
      "Name": "AddOptionInfo",
      "Input": {
        "Title": "测试素材",
        "Tags": "test",
        "Description": "测试素材：字幕文件",
        "Category": "subtitle",
        "RecordType": 2,
        "Format": "vtt"
      }
    }
  ]
}