Use GetEditingProjectMaterials to query materials in an online editing project - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the list of materials to be edited in an online editing project.

Operation description

During the editing process, materials can be added to the timeline but are not necessarily fully used.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetEditingProjectMaterials

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The online editing project ID. You can obtain the ID by using one of the following methods: Log on to the ApsaraVideo VOD console, and choose Production Center > Video Editing to view the ID. Obtain the value of the ProjectId response parameter when you create a project by calling the CreateEditingProject operation.	1982361011093374****
Type	string	No	The material type. Valid values: video: video audio: audio-only	video
MaterialType	string	No	The material type. Valid values: video: video audio: audio-only image: image	video

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	746FFA07-8BBB-46B1-3E94E3B2915E****
MaterialList	object
Material	array<object>	The material list.
	array<object>	The material details.
Status	string	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
CreationTime	string	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
CateId	integer	The category ID of the material.	100005****
MaterialType	string	The type of the material. Valid values: video audio image	video
Tags	string	The tag of the material. Multiple tags are separated by commas (,).	Editing test
SpriteConfig	string	The configuration of the sprite.	xxx
Source	string	The source of the sprite.	xxx
CateName	string	The category name of the material.	Test
ModifiedTime	string	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
Description	string	The description of the material.	Test
MaterialId	string	The ID of the material.	85befc4118b84c6723e53b80b1****
Size	integer	The size of the mezzanine file. Unit: byte.	1682694
CoverURL	string	The thumbnail URL of the material.	http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg
Duration	number	The duration of the material. The value is rounded to four decimal places. Unit: seconds.	15.16
Title	string	The title of the material.	test
Sprites	object
Sprite	array	The URLs of material sprites. The value is an array.
	string	The URLs of material sprites. The value is an array.	"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="
Snapshots	object
Snapshot	array	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="

Examples

Success response

JSON format

{
  "RequestId": "746FFA07-8BBB-46B1-3E94E3B2915E****",
  "MaterialList": {
    "Material": [
      {
        "Status": "Normal",
        "CreationTime": "2017-10-19 10:48:17",
        "CateId": 0,
        "MaterialType": "video",
        "Tags": "Editing test",
        "SpriteConfig": "xxx",
        "Source": "xxx",
        "CateName": "Test",
        "ModifiedTime": "2017-10-19 10:48:17",
        "Description": "Test",
        "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": {
          "Snapshot": [
            "\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\",\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\""
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.