在项目中导入媒体

最近更新时间:2024-04-03 11:14:21

我的收藏

1. 接口描述

接口请求域名: cme.tencentcloudapi.com 。

将云点播中的媒资或者用户自有媒资文件添加到项目中与项目关联,供后续视频编辑使用。目前仅视频编辑项目和智能视频拆条项目有效。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportMediaToProject。
Version String 公共参数,本接口取值:2019-10-29。
Region String 公共参数,本接口不需要传递此参数。
Platform String 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台
示例值:cme_platform
ProjectId String 项目 Id。
示例值:600aae0bb1cc1c000129214b
SourceType String 导入媒资类型,取值:
  • VOD:云点播文件;
  • EXTERNAL:媒资绑定。


  • 注意:如果不填默认为云点播文件,如果媒体存储在非腾讯云点播中,都需要使用媒资绑定。
    示例值:VOD
    VodFileId String 云点播媒资文件 Id,当 SourceType 取值 VOD 或者缺省的时候必填。
    示例值:5285890813075978720
    ExternalMediaInfo ExternalMediaInfo 原始媒资文件信息,当 SourceType 取值 EXTERNAL 的时候必填。
    Name String 媒体名称,不能超过30个字符。如果不填,则媒体名称为点播媒资文件名称。
    示例值:测试
    PreProcessDefinition Integer 媒体预处理配置 ID,取值:
  • 10:进行视频编辑预处理。


  • 注意:如果填0或者不填则不进行处理,如果原始视频不可在浏览器直接播放将无法在编辑页面编辑。
    示例值:10
    Operator String 操作者。如不填,默认为 cmeid_system,表示平台管理员操作,可以向所有视频编辑项目导入媒体;如果指定操作者,则操作者必须为项目所有者。
    示例值:abf00b8b-9482-4c34-b72c-bea5da0a27ce

    3. 输出参数

    参数名称 类型 描述
    MaterialId String 媒体 Id。
    示例值:600a2c94e5c6aa0001b9ef78
    TaskId String 媒体预处理任务 ID,如果未指定发起预处理任务则为空。
    示例值:1900001191-tfusion-5e299c12c63f6af4c95f34159f19137345t0
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 在项目中导入外部媒体

    在项目中导入一个 COS 桶中媒体 ,并发起预处理。

    输入示例

    https://cme.tencentcloudapi.com/?Action=ImportMediaToProject
    &Platform=test
    &ProjectId=cmepid_6f16967b64436100015fb046
    &SourceType=EXTERNAL
    &Name=视频2
    &ExternalMediaInfo.MediaKey=example-folder/example-object.mp4
    &PreProcessDefinition=10
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "248208104522663991",
            "TaskId": "125xxxxxx65-procedurev2-3ab512f07530b88bc1aabb01fac345bcd",
            "RequestId": "c44cbb5b-b809-4061-8c45-7469b64e8e738"
        }
    }

    示例2 在项目中导入云点播文件

    在项目中导入云点播文件,并发起预处理。

    输入示例

    https://cme.tencentcloudapi.com/?Action=ImportMediaToProject
    &Platform=test
    &ProjectId=cmepid_6f16967b64436100015fb046
    &SourceType=VOD
    &VodFileId=52858908114334690679
    &Name=视频1
    &PreProcessDefinition=10
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "248208104522663991",
            "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca",
            "RequestId": "c44cbb5b-b809-4061-8c45-7469b64e8e56"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 云点播用户无效。
    InternalError.CreateTask 发起预处理任务失败。
    InvalidParameter 参数错误。
    InvalidParameterValue.ExternalMediaInfoNotExist 原始媒资信息不存在。
    InvalidParameterValue.MaterialId 媒体 ID 无效。
    InvalidParameterValue.Name 名称字段编辑错误,需使用 UTF8 编码。
    InvalidParameterValue.NameLenLimt 名称字段长度超长,限制 30 个中文字符。
    InvalidParameterValue.Platform 平台参数取值错误。
    InvalidParameterValue.PreProcessDefinition 预处理模板 ID 无效。
    InvalidParameterValue.ProjectId 项目不存在。
    InvalidParameterValue.VodFileId 参数缺少 VodFile。
    InvalidParameterValue.VodFileNotExist 点播文件不存在。
    InvalidParameterValue.VodSubAppid 绑定的点播子应用无效。
    OperationDenied.PermissionDeny 权限不足,请检查对应操作者的权限。
    ResourceNotFound.Platform 平台不存在。
    UnauthorizedOperation 未授权操作。