提交新增媒体作业。
接口说明
- 当在OSS上有存量视频时,可以通过此接口处理存量视频,从而避免重新上传视频到OSS。如果已经配置过工作流,上传媒体文件到OSS后,OSS会自动通知MPS。根据设置的OSS Bucket,Object自动匹配处于激活状态的工作流自动执行,因此通常情况下不需要手动调用AddMedia接口处理文件。
- 只有指定激活状态的工作流处理媒体文件时,才会自动获取媒体信息;不指定工作流或指定其他状态的工作流时,不会获取媒体信息。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileURL | string | 是 | 输入文件的路径,可以通过MPS或OSS控制台获取。详细触发规则请参见下文中工作流触发匹配规则。
| http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4 |
Title | string | 否 | 媒体标题。
| mytest |
Description | string | 否 | 描述。
| A test video |
CoverURL | string | 否 | 封面URL。即您需要设置的封面的存储地址,可以通过MPS控制台 > 工作流管理 > 媒体Bucket或OSS控制台 > 我的访问路径获取。
| http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png |
Tags | string | 否 | 标签列表。 说明媒体处理中,每个媒体的每个标签都是独立的,可以通过搜索媒体库来查找所有设置了相同标签的媒体。
| tag1,tag2 |
MediaWorkflowId | string | 否 | 媒体工作流ID。可通过MPS控制台或新增媒体工作流接口获取。 | 07da6c65da7f458997336e0de192**** |
MediaWorkflowUserData | string | 否 | 媒体工作流用户自定义数据。
| test |
InputUnbind | boolean | 否 | 是否检查指定的工作流支持输入路径。此处建议您选择检查(true),避免因路径出错而导致的错误。取值:
| false |
CateId | long | 否 | 媒体所属类目ID。不允许为负数。 | 123 |
OverrideParams | string | 否 | 覆盖参数。
| {“subtitleTransNodeName”:{“InputConfig”:{“Format”:”stl”,”InputFile”:{“URL”:”http://exampleBucket.oss-cn-hangzhou.aliyuncs.com/package/example/CENG.stl"}}}} |
工作流触发匹配规则
规则匹配执行策略如下:以新增文件的路径为基础,检查工作流绑定的位置,如果新增文件的路径中包含规则绑定的字符串则匹配,不包含则不匹配。例如:http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv
规则:
1、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/ 匹配
2、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/ 匹配
3、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/ 匹配
4、http://bucket.oss-cn-hangzhou.aliyuncs.com/ 匹配
5、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv 匹配
6、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/ 不匹配
7、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/ 不匹配
8、http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/ 不匹配
匹配文件扩展名
触发要求必须是多媒体文件,媒体库服务是通过文件扩展名来判断的。文件或者没有扩展名(文件名中不包含扩展名分割符号“.”),或者扩展名符合下面的规则:
类型 | 扩展名 |
---|---|
视频 | 3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm |
音频 | aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff |
媒体工作流消息
媒体工作流采用 阿里云消息服务 发送消息给视频云服务接入方,媒体工作流会在(Start/Report)活动节点完成时发送消息,若需要接收消息,需要在Start活动上设置队列/通知名称,媒体工作流产生的消息存储在队列/通知中,可以使用 消息服务SDK 获取消息,消息规格如下:
名称 | 类型 | 描述 |
---|---|---|
RunId | String | 工作流执行ID。 |
Name | String | 活动名称。 |
Type | String | 活动类型。范围:Report、Start |
State | String | 活动状态。范围:Fail、Success |
Code | String | 错误码。如果活动状态是Fail时,会给出具体的错误码。 |
Message | String | 错误消息。如果活动状态是Fail时,会给出详细的错误描述信息。 |
MediaWorkflowExecution | MediaWorkflowExecution | 媒体工作流执行信息。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "05F8B913-E9F3-4A6F-9922-48CADA0FFAAD",
"Media": {
"CreationTime": "2016-09-20T03:02:40Z",
"CateId": 1,
"Height": "1280",
"CensorState": "Initiated",
"Tags": {
"Tag": [
"tag,tag2"
]
},
"Bitrate": "1148.77",
"MediaId": "3e6149d5a8c944c09b1a8d2dc3e4****",
"File": {
"State": "Normal",
"URL": "http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4"
},
"PublishState": "Published",
"Description": "A test video",
"Width": "1280",
"Size": "379860",
"CoverURL": "http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png",
"RunIdList": {
"RunId": [
"{\"RunId\":[\"cbad98d35629470fa05ff393d347****\"]}"
]
},
"Duration": "2.645333",
"Fps": "25.0",
"Title": "mytest.mp4",
"Format": "mp4"
}
}
错误码
访问错误中心查看更多错误码。