文档

GetEditingProjectMaterials - 获取剪辑工程关联素材

更新时间:

获取当前工程绑定的所有素材。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetEditingProjectMaterials
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectIdstring

云剪辑工程 ID。

*****fb2101cb318*****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

******89-C21D-4B78-AE24-3788B8******
ProjectIdstring

项目 ID 号。

*****67ae06542b9b93e0d1c387*****
MediaInfosarray<object>

符合要求的媒资集合。

MediaInfoobject
MediaIdstring

媒资 ID。

*****64623a94eca8516569c8fe*****
MediaBasicInfoobject

媒资基础信息。

MediaIdstring

媒资 ID。

*****64623a94eca8516569c8f*****
InputURLstring

待注册的媒资在相应系统中的地址。

http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4
MediaTypestring

媒资媒体类型。

video
BusinessTypestring

媒资业务类型。

general
Sourcestring

来源。

oss
Titlestring

标题。

file.mp4
Descriptionstring

内容描述。

sample_description
Categorystring

分类。

video
MediaTagsstring

标签。

标签,tag1
CoverURLstring

封面地址。

http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature
UserDatastring

用户数据。

userData
Snapshotsstring

截图。

null
Statusstring

资源状态。

Normal
TranscodeStatusstring

转码状态。

枚举值:
  • TranscodeSuccess转码完成
  • TranscodeFailed转码失败
  • Init初始化
  • Transcoding转码中
Init
CreateTimestring

媒资创建时间。

2020-12-26T04:11:08Z
ModifiedTimestring

媒资修改时间。

2020-12-26T04:11:08Z
DeletedTimestring

媒资删除时间。

2020-12-26T04:11:08Z
SpriteImagesstring

雪碧图。

null
FileInfoListarray<object>

文件信息。

FileInfoobject
FileBasicInfoobject

文件基础信息,包含时长,大小等。

FileNamestring

文件名。

example.mp4
FileStatusstring

文件状态。

Normal
FileTypestring

文件类型。

source_file
FileSizestring

文件大小(字节)。

30611502
FileUrlstring

文件 OSS 地址。

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>
Regionstring

文件存储区域。

cn-shanghai
FormatNamestring

封装格式。

mov,mp4,m4a,3gp,3g2,mj2
Durationstring

时长。

216.206667
Bitratestring

码率。

1132.68
Widthstring

宽。

960
Heightstring

高。

540
LiveMaterialsarray<object>

直播流关联素材。

LiveStreamConfigobject
AppNamestring

直播播流应用名。

testrecord
StreamNamestring

直播播流流名。

testrecord
DomainNamestring

直播播流域名。

test.alivecdn.com
LiveUrlstring

直播播流地址。

rtmp://test.alivecdn.com/testrecord/teststream
ProjectMaterialsarray

剪辑工程关联素材。直播工程在直播结束后会关联到一个普通剪辑工程。

projectMaterialstring

直播剪辑工程关联的普通剪辑工程 ID。

*****c38767ae06542b9b93e0d1*****

示例

正常返回示例

JSON格式

{
  "RequestId": "******89-C21D-4B78-AE24-3788B8******",
  "ProjectId": "*****67ae06542b9b93e0d1c387*****",
  "MediaInfos": [
    {
      "MediaId": "*****64623a94eca8516569c8fe*****",
      "MediaBasicInfo": {
        "MediaId": "*****64623a94eca8516569c8f*****",
        "InputURL": "http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4",
        "MediaType": "video",
        "BusinessType": "general",
        "Source": "oss",
        "Title": "file.mp4",
        "Description": "sample_description",
        "Category": "video",
        "MediaTags": "标签,tag1",
        "CoverURL": "http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature",
        "UserData": "userData",
        "Snapshots": "null",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2020-12-26T04:11:08Z",
        "ModifiedTime": "2020-12-26T04:11:08Z",
        "DeletedTime": "2020-12-26T04:11:08Z",
        "SpriteImages": "null"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "example.mp4",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "30611502",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
            "Region": "cn-shanghai",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "216.206667",
            "Bitrate": "1132.68",
            "Width": "960",
            "Height": "540"
          }
        }
      ]
    }
  ],
  "LiveMaterials": [
    {
      "AppName": "testrecord",
      "StreamName": "testrecord",
      "DomainName": "test.alivecdn.com",
      "LiveUrl": "rtmp://test.alivecdn.com/testrecord/teststream"
    }
  ],
  "ProjectMaterials": [
    "*****c38767ae06542b9b93e0d1*****"
  ]
}

错误码

HTTP status code错误码错误信息
400InvalidParameterThe specified parameter \ is not valid.
404ProjectNotFoundThe specified project not found

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-04-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情