- 媒体信息接口
- 转码接口
- 预置智能模板推荐接口
- 自定义转码模板接口
- 水印模板接口
- 截图接口
- 管道接口
- 媒体工作流接口
- 媒体工作流执行实例接口
- 媒体Bucket接口
- 媒体接口
- 智能生产接口
- 智能标签接口
- 媒体审核接口
- 视频DNA接口
- 数字水印接口
接口说明
- 当在 OSS 上有存量视频时,可以通过此接口处理存量视频,从而避免重新上传视频到 OSS。如果已经配置过工作流,上传媒体文件到 OSS 后,OSS 会自动通知 MPS。根据设置的 OSS Bucket,Object 自动匹配处于激活状态的工作流自动执行,因此通常情况下不需要手动调用 AddMedia 接口处理文件。
- 只有指定激活状态的工作流处理媒体文件时,才会自动获取媒体信息;不指定工作流或指定其他状态的工作流时,不会获取媒体信息。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
请求参数
字段名称 | 字段详情 |
---|---|
FileURLstring | 输入文件的路径,可以通过 MPS 或 OSS 控制台获取。详细触发规则请参见下文中工作流触发匹配规则。展开详情 示例值:http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.mp4 |
Titlestring | 媒体标题。展开详情 示例值:mytest |
Descriptionstring | 描述。展开详情 示例值:A test video |
CoverURLstring | 封面 URL。即您需要设置的封面的存储地址,可以通过 MPS 控制台 > 工作流管理 > 媒体 Bucket或OSS 控制台 > 我的访问路径获取。展开详情 示例值:http://bucket.oss-cn-hangzhou.aliyuncs.com/example/1.png |
Tagsstring | 标签列表。展开详情 示例值:tag1,tag2 |
MediaWorkflowIdstring | 媒体工作流 ID。可通过 MPS 控制台或新增媒体工作流接口获取。 示例值:07da6c65da7f458997336e0de192****参考取值来源: AddMediaWorkflow UpdateMediaWorkflow SearchMediaWorkflow ActivateMediaWorkflow DeactivateMediaWorkflow ListMediaWorkflowExecutions QueryMediaWorkflowExecutionList |
MediaWorkflowUserDatastring | 媒体工作流用户自定义数据。展开详情 示例值:test |
InputUnbindboolean | 是否检查指定的工作流支持输入路径。此处建议您选择检查(true),避免因路径出错而导致的错误。取值:展开详情 示例值:false |
CateIdinteger<int64> | 媒体所属类目 ID。不允许为负数。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:123 |
OverrideParamsstring | 覆盖参数。展开详情 示例值:{“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 |
媒体工作流消息
媒体工作流采用 阿里云轻量消息队列(原 MNS) 发送消息给视频云服务接入方,媒体工作流会在(Start/Report)活动节点完成时发送消息,若需要接收消息,需要在 Start 活动上设置队列/通知名称,媒体工作流产生的消息存储在队列/通知中,可以使用 轻量消息队列(原 MNS) SDK 获取消息,消息规格如下:
名称 | 类型 | 描述 |
---|---|---|
RunId | String | 工作流执行 ID。 |
Name | String | 活动名称。 |
Type | String | 活动类型。范围:Report、Start |
State | String | 活动状态。范围:Fail、Success |
Code | String | 错误码。如果活动状态是 Fail 时,会给出具体的错误码。 |
Message | String | 错误消息。如果活动状态是 Fail 时,会给出详细的错误描述信息。 |
MediaWorkflowExecution | MediaWorkflowExecution | 媒体工作流执行信息。 |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:05F8B913-E9F3-4A6F-9922-48CADA0FFAAD |
Mediaobject | 媒体信息。 |