GetEditingProjectMaterials - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries materials that are waiting to be edited in an online editing project.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:GetEditingProjectMaterials	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	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****
Type	string	Yes	The type of the material. Valid values: video audio	video
MaterialType	string	No	The type of the material. Valid values: video audio image	video

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request.	746FFA07-8BBB-46B1-3E94E3B2915E****
MaterialList	array<object>	The materials.
Material	object	The details of the materials.
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.	test1
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.	test2
MaterialId	string	The ID of the material.	85befc4118b84c6723e53b80b1****
Size	long	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	float	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	array	The URLs of material sprites. The value is an array.
Sprite	string	The URLs of material sprites. The value is an array.	{"Sprite":["http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="]}
Snapshots	array	The URLs of material snapshots. The value is an array.
Snapshot	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

Sample success responses

JSONformat

{
  "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": "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": [
            "{\"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

For a list of error codes, visit the Service error codes.