全部产品
云市场

注册媒资信息

更新时间:2019-02-15 13:46:17

描述

支持对已接入点播服务的OSS bucket中已存在的音视频媒体文件的注册,注册媒资成功后,可根据媒体ID发起转码截图和AI处理(如审核)等。

限制说明

  • 一次最多可注册10个OSS媒体文件,且一次提交的文件对应的存储地址需要一致。
  • 与视频上传不同的是,注册媒资后,如未指定转码模板组ID,则不会自动触发转码;如指定,则会按照指定的模板组进行转码。
  • 重复注册的媒体文件,只返回与其关联的惟一媒体ID,不做其他处理。

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值:RegisterMedia
RegisterMetadatas RegisterMetadata[]注册媒资元数据,为JSON字符串,一次最多支持设置10个媒资元数据。
TemplateGroupIdString转码模板组ID。
当不为空时,会使用指定的模板组进行转码。可在 点播控制台 > 转码设置 里查看模版组ID。
UserDataUserData自定义设置,为JSON字符串,支持消息回调等设置。

RegisterMetadata

注册媒资元数据。Title、Description、Tags字段值中不能包含表情符。

名称类型必填描述
FileURL String源文件地址。长度不超过1024个字节,文件名称需要保证全局唯一,添加相同文件名称时,将关联惟一MediaId。
Title String标题。长度不超过128个字节,UTF8编码。标题值为空时,默认截取文件地址中的文件名称作为标题。
Description String描述。长度不超过1024个字节,UTF8编码。
Tags String标签,多个用逗号分隔。单个标签不超过32字节,最多不超过16个标签。多个用逗号分隔,UTF8编码。
CoverURL String封面URL。长度不超过1024个字节。
CateId Long 分类ID。

示例:

  1. RegisterMetadata={"FileURL":"https://xxxxx.oss-cn-shanghai.aliyuncs.com/xxxx/vod_sample.mp4", "Title":"测试标题","TemplateGroupId":"30986d46d585e47e330567d9e907892f"}

返回参数

名称类型描述
RequestIdString请求ID。
RegisteredMediaList RegisteredMedia[]本次注册成功的Media列表,包括新增注册和已注册成功过的文件。
FailedFileURLs String[] 注册失败的文件地址列表。

RegisteredMedia

注册成功的Media信息

名称类型描述
MediaId String点播媒体ID。当注册的媒体文件为音视频时,对应点播的VideoId。
FileURL StringOSS文件地址。
NewRegister Boolean新注册或重复注册。true-表示新注册,false-表示重复注册。

API示例

请求示例

  1. http://vod.cn-shanghai.aliyuncs.com/?Action=RegisterMedia&MediaMetadatas=[{"FileURL":"https://xxxxx.oss-cn-shanghai.aliyuncs.com/xxxx/vod_sample.mp4","Title":"测试标题"}]&Format=JSON&<公共参数>

注意:示例中的“公共参数”参见 公共参数说明文档

返回示例

JSON格式

  1. {
  2. "RequestId":"14F43C5C-8033-43E7-B48B-AD04F64E5098",
  3. "RegisteredMediaList": [
  4. {
  5. "MediaId":"d97af328280842229aed1896683b1aa38",
  6. "FileURL":"http://xxxx.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
  7. "NewRegister":true
  8. },
  9. {
  10. "MediaId":"d97af328280842229aed1896683b1aa38",
  11. "FileURL":"http://xxxx.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4",
  12. "NewRegister":false
  13. }
  14. ],
  15. "FailedFileURLs":[
  16. "http://xxxx.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"
  17. ]
  18. }

错误码

下表列举了本接口特有的错误码,视频点播通用的错误码信息,参见 错误码列表

错误代码错误信息HTTP 状态码说明
InvalidTemplateGroupId.NotFoundThe TemplateGroupId does not exist.404指定的模板组ID不存在。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: