API概览

本产品(智能媒体生产/2020-11-09)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

媒体上传

API标题API概述
CreateUploadMedia获取媒资上传地址和凭证调用CreateUploadMedia获取媒资上传地址和凭证,并创建媒资信息。
CreateUploadStream获取媒体流上传地址和凭证调用CreateUploadStream获取媒体流上传地址和凭证。
RefreshUploadMedia刷新媒资上传凭证调用RefreshUploadMedia用于媒资文件上传超时后重新获取媒资上传凭证。
RegisterMediaInfo注册内容库资源发起一个注册媒资的任务,赋予新媒资一个IMS的mediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口,获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。
RegisterMediaStream注册媒体流调用RegisterMediaStream注册媒体流。
UploadMediaByURLURL拉取上传调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。
UploadStreamByURL媒体流URL拉取上传调用UploadStreamByURL基于源文件URL,拉取媒体流文件进行上传。
GetUrlUploadInfos获取URL上传信息调用GetURLUploadInfos获取URL上传信息。

媒资管理

API标题API概述
媒资库媒资库
DeleteMediaInfos删除媒资内容批量删除媒资信息,最多一次删20个。
UpdateMediaInfo更新媒体信息根据IMS mediaId或媒资InputURL,更新一个媒资的媒资信息。
GetMediaInfo获取媒资内容信息根据IMS mediaId或媒资InputURL,获取并返回媒资信息。
ListMediaBasicInfos列出媒资基础信息根据用户所给参数,返回所有符合条件的媒资的基础信息。
ListPublicMediaBasicInfos列出公共素材库媒资基础信息列出符合条件的公共素材库媒资基础信息,最多筛选出100条。
ListAllPublicMediaTags列出公共素材库所有标签列出公共素材库媒资的所有标签。
BatchGetMediaInfos批量获取媒体信息批量获取媒资信息,支持传入多个mediaId。
分类管理分类管理
AddCategory创建分类调用AddCategory创建媒资分类。
DeleteCategory删除分类调用DeleteCategory删除媒资分类。
UpdateCategory更新分类调用UpdateCategory更新媒资分类。
GetCategories获取分类及子分类调用GetCategories获取指定的分类信息,及其子分类(即下一级分类)的列表。
DeletePlayInfo删除媒体流调用DeletePlayInfo删除媒体流(视频流,音频流)信息。
GetPlayInfo获取音视频播放地址调用GetPlayInfo通过音视频ID直接获取媒体文件(支持视频和音频)的播放地址。
SearchMedia搜索媒体信息根据用户所提供参数,返回符合条件的媒资信息。

配置管理

API标题API概述
模板管理模板管理
CreateCustomTemplate创建用户自定义模板创建媒体处理用户自定义模板。
DeleteCustomTemplate删除自定义模板删除用户自定义模板。
UpdateCustomTemplate修改用户自定义模板信息修改媒体处理用户自定义模板信息。
SetDefaultCustomTemplate设置默认自定义模板设置用户自定义点播媒体处理默认模板。
GetCustomTemplate获取自定义模板信息获取媒体处理用户自定义模板信息。
ListCustomTemplates获取自定义模板列表获取用户自定义点播媒体处理模板列表。
ListSystemTemplates获取系统模板列表获取媒体处理系统预置模板列表。
GetSystemTemplate获取系统模板信息获取单个系统预置模板信息。
管道管理管道管理
CreatePipeline创建管道创建管道。
DeletePipeline删除用户管道删除用户管道信息。
UpdatePipeline更新管道信息更新用户管道信息。
GetPipeline获取管道详细信息获取用户管道详细信息。
ListPipelines获取管道列表获取用户管道列表。

媒体处理

API标题API概述
转码接口转码接口
SubmitTranscodeJob提交转码任务提交转码任务。
GetTranscodeJob查询转码任务查询单个转码任务详情。
ListTranscodeJobs查询转码任务列表查询转码任务列表。
截图接口截图接口
SubmitSnapshotJob提交截图任务提交截图任务。
SubmitDynamicImageJob提交动图任务提交动图任务。
GetSnapshotUrls获取截图任务输出URL获取截图任务输出图片的可访问URL。
GetSnapshotJob查询截图任务详细信息查询截图任务详细信息。
ListSnapshotJobs获取截图任务列表获取截图任务列表。
GetDynamicImageJob查询动图任务详细信息查询动图任务详细信息。
ListDynamicImageJobs获取动图任务列表获取动图任务列表。
媒体信息接口媒体信息接口
SubmitSyncMediaInfoJob提交同步媒体信息任务提交同步媒体信息任务。
SubmitMediaInfoJob提交媒体信息异步任务提交媒体信息异步任务。
GetMediaInfoJob媒体信息任务查询查询媒体信息。
ListMediaInfoJobs查询媒体信息任务列表查询媒体信息任务列表。

实时处理

API标题API概述
实时媒体转码实时媒体转码
SendLiveTranscodeJobCommand发送实时转码任务指令发送实时转码任务指令。
ListLiveTranscodeJobs获取实时媒体转码任务列表调用ListLiveTranscodeJobs获取实时媒体转码任务列表。
GetLiveTranscodeJob获取单个实施媒体转码任务调用GetLiveTranscodeJob获取单个实时转码任务。
DeleteLiveTranscodeJob删除实时媒体转码任务
UpdateLiveTranscodeJob更新实时媒体转码任务调用UpdateLiveTranscodeJob更新实时转码任务信息。
SubmitLiveTranscodeJob提交实时媒体转码任务调用SubmitLiveTranscodeJob提交实时转码任务。
GetLiveTranscodeTemplate获取单个实时媒体转码模版调用GetLiveTranscodeTemplate获取单个实时转码模板。
UpdateLiveTranscodeTemplate更新实时媒体转码模版更新实时转码模板。
DeleteLiveTranscodeTemplate删除实时媒体转码模版删除实时转码模板。
CreateLiveTranscodeTemplate创建实时媒体转码模版调用CreateLiveTranscodeTemplate创建实时转码模板,便于提交实时转码任务。
ListLiveTranscodeTemplates获取实时媒体转码模版列表调用ListLiveTranscodeTemplates获取实时媒体转码模版列表。
实时媒体录制实时媒体录制
CreateLiveRecordTemplate创建实时录制模板调用CreateLiveRecordTemplate创建实时录制模板,便于提交实时录制任务。
GetLiveRecordTemplate获取实时录制模板明细调用GetLiveRecordTemplate获取实时录制模板明细或任务模板快照。
ListLiveRecordTemplates获取实时录制模板列表调用ListLiveRecordTemplates获取实时录制模板列表。
UpdateLiveRecordTemplate更新实时录制模板调用UpdateLiveRecordTemplate更新实时录制模板。
DeleteLiveRecordTemplate删除实时录制模板调用DeleteLiveRecordTemplate删除实时录制模板,不影响现有任务。
SubmitLiveRecordJob提交实时录制任务调用SubmitLiveRecordJob提交实时录制任务,对直播流进行录制。
GetLiveRecordJob获取实时录制任务明细调用GetLiveRecordJob获取单个实时录制任务明细。
ListLiveRecordJobs获取实时录制任务列表调用ListLiveRecordJobs获取实时录制任务列表,可分页获取。
ListLiveRecordFiles查询所有录制索引文件调用ListLiveRecordFiles查询某个时间段内的所有录制索引文件。
DeleteLiveRecordFiles删除实时录制文件调用DeleteLiveRecordFiles删除实时录制文件,可选择只删除记录或同时删除原始OSS文件。
实时媒体截图实时媒体截图
CreateLiveSnapshotTemplate创建实时截图模板调用CreateLiveSnapshotTemplate创建实时截图模板,模板便于创建截图任务。
GetLiveSnapshotTemplate获取实时截图模板调用GetLiveSnapshotTemplate获取单个实时截图模板。
ListLiveSnapshotTemplates获取实时截图模板列表调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。
UpdateLiveSnapshotTemplate更新实时截图模板更新实时截图模板。
DeleteLiveSnapshotTemplate删除实时截图模板删除实时截图模板。
SubmitLiveSnapshotJob提交实时截图任务调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交,则会自动异步启动任务,否则为未启动状态。
GetLiveSnapshotJob获取实时截图任务调用GetLiveSnapshotJob获取单个实时截图任务。
ListLiveSnapshotJobs获取实时截图任务列表调用ListLiveSnapshotJobs获取实时截图任务列表,可分页获取。
SendLiveSnapshotJobCommand发送实时截图任务指令发送实时截图任务指令。
ListLiveSnapshotFiles获取实时截图文件列表调用ListLiveSnapshotFiles获取实时截图文件列表,可分页获取。
DeleteLiveSnapshotFiles删除实时截图文件调用DeleteLiveSnapshotFiles删除实时截图文件,可选择只删除记录或同时删除原始OSS文件。

生产制作

API标题API概述
素材中心素材中心
CancelFavoritePublicMedia取消收藏公共版权媒资根据输入的mediaId 列表,将所有媒资取消收藏。
AddFavoritePublicMedia收藏公共版权媒资根据输入的mediaId 列表,将所有媒资加入收藏。
GetPublicMediaInfo获取公共版权媒资根据ICE公共版权媒资的 mediaId,获取并返回媒资信息。接口返回的URL为版权媒资的试听或试看地址,合成时会使用正式素材。
SearchPublicMediaInfo搜索公共版权媒资根据用户所给参数,搜索符合条件的媒资。
云剪辑工程管理云剪辑工程管理
CreateEditingProject创建云剪辑工程创建云剪辑工程,支持设置标题、描述、时间线和工程封面等。
AddEditingProjectMaterials增加剪辑工程关联素材将一个或多个素材添加到剪辑工程中。
DeleteEditingProjectMaterials删除剪辑工程管理素材将一个或多个素材同类型素材剪辑工程中删除。
DeleteEditingProjects删除云剪辑工程删除云剪辑工程,支持批量删除。
UpdateEditingProject修改云剪辑工程修改云剪辑工程,支持修改标题、时间线和封面等。
GetEditingProject获取单个云剪辑工程获取云剪辑工程的详细信息。
GetEditingProjectMaterials获取剪辑工程关联素材获取当前工程绑定的所有素材。
SearchEditingProject搜索云剪辑工程支持按创建时间、状态搜索。
GetLiveEditingIndexFile获取直播剪辑索引文件获取直播流的索引文件,用于控制台剪辑预览。
剪辑制作剪辑制作
SubmitMediaProducingJob提交剪辑合成作业将一个或多个素材片段合成为成品。
SubmitLiveEditingJob提交直播剪辑任务将一个或多个直播流区间合成为成品。提交直播剪辑任务后,任务将进入后台排队,异步执行。提交后可以调用查询直播剪辑作业(GeLiveEditingJob )接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。
GetMediaProducingJob查询剪辑合成作业获取剪辑合成作业的详细信息,包括剪辑合成任务的任务状态、时间线、模板及数据等。
GetLiveEditingJob查询直播剪辑作业获取剪辑合成作业的详细信息,具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。
模板工厂模板工厂
AddTemplate创建模板创建云剪辑模板。模板工厂是对剪辑合成时间线的一个封装,用户可以把常用的剪辑保存为模板,当有同样的需求出现时,只需要传入替换素材即可生产视频。调用AddTemplate接口创建模板,Config为模板描述,普通模板和高级模板Config有较大差异,参考下方使用文档。
DeleteTemplate删除模板删除模板。
UpdateTemplate修改模板修改模板,支持修改模板标题、模板配置等信息。
GetTemplate获取模板信息根据模板ID获取模板信息。高级模板有解析过长,当类型为高级模板时,Status为Available时即可使用。
ListTemplates列出符合条件的模板列出符合条件的模板,支持根据模板状态、创建来源等信息查询。
GetTemplateMaterials获取模板素材地址返回高级模板包中的素材地址,供高级模板编辑器使用,素材链接30分钟过期。FileList为所需素材数组,不填则默认返回全部素材地址,最多返回400个。
智能任务智能任务
SubmitASRJob提交ASR智能字幕任务根据视频语音提取时间起止点及对应文字信息。
SubmitAudioProduceJob智能语音任务将文本内容转化成语音文件。
SubmitDynamicChartJob提交动态图表任务根据Excel生成折线图、饼图、柱状图等视频,支持修改线条颜色、字体等信息。
DeleteSmartJob删除智能任务用户可以根据任务ID删除智能任务。
GetSmartHandleJob获取智能任务结果获取智能任务结果,可以根据任务ID,获取智能任务信息及执行结果。
ListSmartJobs获取任务列表根据用户所给参数,返回所有符合条件的任务列表。

媒体AI

API标题API概述
SubmitIProductionJob提交智能生产任务调用SubmitIProductionJob提交智能生产任务。
QueryIProductionJob查询智能生产任务调用QueryIProductionJob查询智能生产任务状态与结果。

用量统计

API标题API概述
DescribeMeterImsMediaConvertUHDUsageIMS的MPS转码UHD计量查询IMS的MPS转码UHD计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMediaConvertUsageIMS的点播转码计量查询IMS的点播转码计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsEditUsageIMS点播视频剪辑用量查询IMS点播视频剪辑用量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsSummaryIMS点播用量统计查询IMS点播用量统计查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMpsAiUsageIMS的MPS-AI计量查询IMS的MPS-AI用量查询,最大查询范围31天,最远可查90天内的数据。

全局配置

API标题API概述
SetDefaultStorageLocation设置默认存储位置设置临时文件的默认存储路径。默认存储地址用于ICE在线编辑器及集成webSDK使用时,剪辑过程产生的临时文件存储,如智能配置生成的音频文件等;设置默认存储地址,可避免在编辑过程中申请填写各类临时资源的存储路径时,对使用者造成困扰;如果通过API接入ICE剪辑能力,可在接口中灵活设置路径,此默认路径不生效。
SetEventCallback设置事件回调设置特定事件的通知机制,目前仅支持剪辑合成作业完成后进行MNS回调。
GetDefaultStorageLocation获取默认存储位置本文为您介绍获取默认存储配置API请求参数及示例。
GetEventCallback获取事件回调调用GetEventCallback获取事件回调配置。

其他

API标题API概述
QueryCensorJobList查询媒体审核作业列表调用QueryCensorJobList查询媒体审核作业列表。
QueryMediaCensorJobDetail查询媒体审核作业详情调用QueryMediaCensorJobDetail查询媒体审核作业的详细信息。
SubmitMediaCensorJob提交媒体审核作业调用SubmitMediaCensorJob提交媒体审核作业。
UpdateSmartJob更新智能任务更新智能任务额外信息。
DescribeMeterIceLiveMediaConvertUsageICE的实时转码计量查询ICE的实时转码计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterIceEditUsageICE点播视频剪辑用量查询ICE点播视频剪辑用量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterIceMediaConvertUHDUsageICE的MPS转码UHD计量查询ICE的MPS转码UHD计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterIceMediaConvertUsageICE的点播转码计量查询ICE的点播转码计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterIceMpsAiUsageICE的MPS-AI计量查询ICE的MPS-AI用量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsLiveSnapshotUsage
DescribeMeterImsLiveEditUsage
DescribeMeterImsLiveRecordUsage
DescribeMeterImsLiveMediaConvertUsage
DescribePlayQosList
DescribeFilterConfigs
DescribePlayList
DescribeQueryConfigs
DescribePlayQoeList
DescribePlayFirstFrameDurationMetricData
DescribePlayDetail
DescribePlayEventList
DescribePlayMetricData
阿里云首页 智能媒体生产 相关技术圈