全部产品

注册内容库资源

本文为您介绍注册内容库资源API的请求参数与示例。

描述

发起一个注册媒资的任务,赋予新媒资一个ICE的mediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口, 获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。

请求参数

字段名称

类型

必填项

示例值

描述

Action

String

RegisterMediaInfo

系统规定参数。取值:RegisterMediaInfo。

InputURL

String

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

vod://****20b48fb04483915d4f2cd8ac****

待注册的媒资在相应系统中的地址,一经注册不可更改,并与ICE的mediaId绑定

- OSS地址,支持两种格式

  1. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

  2. oss://example-bucket/example.mp4 此格式默认oss region与服务接入区域一致

- VOD 媒资

vod://<vod媒资ID>

MediaType

String

video

媒资媒体类型。取值范围:

- "image" 图片

- "video" 视频

- "audio" 音频

- "text" 文字

BusinessType

String

opening

媒资业务类型。取值范围:

- "subtitles" 字幕

- "watermark" 水印

- "opening" 片头/开场

- "ending" 片尾

- "general" 通用

Title

String

defaultTitle

标题,若不提供,根据日期自动生成默认title。

- 长度不超过128字节。

- UTF8编码。

Description

String

defaultDescription

内容描述

- 长度不超过1024字节

- UTF8编码。

Category

String

defaultCategory

分类

- 长度不超过64字节。

- UTF8编码。

MediaTags

String

tag1,tag2

标签。

- 最多不超过16个标签。

- 多个用逗号分隔。

- 单个标签不超过32字节。

- UTF8编码。

CoverURL

String

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png

封面地址。

- 长度不超过128字节。

- UTF8编码。

UserData

String

userData

用户数据

- 长度不超过1024字节。

- UTF8编码。

DynamicMetaDataList

String

[{"data":"{\"事件\":\"射门\",\"人物\":\"C罗\"}","in":10.0,"out":20.3,"type":"user-defined"},{"data":"{\"事件\":\"射门\",\"人物\":\"C罗\"}","in":20.0,"out":29.9,"type":"user-defined"}]

用户自定义元数据。

- 长度不超过2048字节。

- UTF8编码。

- DynamicMetaData[] -> Json String

Overwrite

Boolean

true

是否覆盖已注册媒资,默认false

  • true,如果inputUrl已注册,删除原有媒资并注册新媒资;

  • false, 如果inputUrl已注册则不予注册新媒资,暂不支持重复的inputUrl。

ClientToken

String

****0311a423d11a5f7dee713535****

32位UUID,保证请求幂等性。

RegisterConfig

String

{"NeedSprite": "false"}

注册配置,默认为媒资生成雪碧图,如不需要可以手动设置NeedSprite字段为false。

返回参数

字段名称

类型

描述

RequestId

String

请求ID

MediaId

String

ICE媒资ID

请求示例

https://ice.cn-shanghai.aliyuncs.com/?Action=RegisterMediaInfo
&InputURL=http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
&MediaType=video
&<公共参数>

返回示例

{
  "MediaId": "****20b48fb04483915d4f2cd8ac****",
  "RequestId": "87ED025A-CAAC-4850-A3AF-B746069E29AE"
}