All Products
Search
Document Center

ApsaraVideo VOD:GetEditingProjectMaterials

Last Updated:Nov 09, 2022

Queries materials to be edited for an online editing project.

Operation Description

During editing, you can add materials to the timeline, but some of them may not be used.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:GetEditingProjectMaterialsList
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdstringYes

The ID of the online editing project. You can use one of the following methods to obtain the ID of the online editing project:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Production Center > Video Editing to obtain the ID of the specified online editing project.
  • Call the AddEditingProject operation. The value of the response parameter ProjectId is the ID of the specified online editing project.
1982361011093374****
TypestringYes

The type of the material. Valid values:

  • video
  • audio
video
MaterialTypestringNo

The type of the material. Valid values:

  • video
  • audio
  • image
video

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

746FFA07-8BBB-46B1-3E94E3B2915E****
MaterialListarray

The materials.

object

The details of the materials.

Statusstring

The status of the material. Valid values:

  • Normal: The material is in draft.
  • Producing: The material is being produced.
  • Produced: The material was produced.
  • ProduceFailed: The material failed to be produced.
Normal
CreationTimestring

The time when the material was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-10-19 10:48:17
CateIdinteger

The category ID of the material.

100005****
MaterialTypestring

The type of the material. Valid values:

  • video
  • audio
  • image
video
Tagsstring

The tag of the material. Multiple tags are separated by commas (,).

editing test
SpriteConfigstring

The configuration of the sprite.

xxx
Sourcestring

The source of the sprite.

xxx
CateNamestring

The category name of the material.

test1
ModifiedTimestring

The time when the material was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-10-19 10:48:17
Descriptionstring

The description of the material.

test2
MaterialIdstring

The ID of the material.

85befc4118b84c6723e53b80b1****
Sizelong

The size of the mezzanine file. Unit: byte.

1682694
CoverURLstring

The thumbnail URL of the material.

http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg
Durationnumber

The duration of the material. The value is rounded to four decimal places. Unit: seconds.

15.16
Titlestring

The title of the material.

test
Spritesarray

The URLs of material sprites. The value is an array.

string

The URLs of material sprites. The value is an array.

{"Sprite":["http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="]}
Snapshotsarray

The URLs of material snapshots. The value is an array.

string

The URLs of material snapshots. The value is an array.

["http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=","http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="]

Example

Normal return example

JSONFormat

{
  "RequestId": "746FFA07-8BBB-46B1-3E94E3B2915E****",
  "MaterialList": [
    {
      "Status": "Normal",
      "CreationTime": "2017-10-19 10:48:17",
      "CateId": 0,
      "MaterialType": "video",
      "Tags": "editing test",
      "SpriteConfig": "xxx",
      "Source": "xxx",
      "CateName": "test1",
      "ModifiedTime": "2017-10-19 10:48:17",
      "Description": "test2",
      "MaterialId": "85befc4118b84c6723e53b80b1****",
      "Size": 1682694,
      "CoverURL": "http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg",
      "Duration": 15.16,
      "Title": "test",
      "Sprites": [
        "{\"Sprite\":[\"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\"]}"
      ],
      "Snapshots": [
        "[\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\",\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\"]"
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.