GetEditingProjectMaterials -

Usage notes

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

QPS limit

You can call this operation up to 30 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VOD.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetEditingProjectMaterials	The operation that you want to perform. Set the value to GetEditingProjectMaterials.
ProjectId	String	Yes	1982361011093374****	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.
Type	String	Yes	video	The type of the material. Valid values: video audio
MaterialType	String	No	video	The type of the material. Valid values: video audio image

Response parameters


Parameter	Type	Example	Description
RequestId	String	746FFA07-8BBB-46B1-3E94E3B2915E****	The ID of the request.
MaterialList	Array of Material		The materials.
Material
Status	String	Normal	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.
CreationTime	String	2017-10-19 10:48:17	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.
CateId	Integer	100005****	The category ID of the material.
MaterialType	String	video	The type of the material. Valid values: video audio image
Tags	String	Editing test	The tag of the material. Multiple tags are separated by commas (,).
SpriteConfig	String	xxx	The configuration of the sprite.
Source	String	xxx	The source of the sprite.
CateName	String	Test	The category name of the material.
ModifiedTime	String	2017-10-19 10:48:17	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.
Description	String	Test	The description of the material.
MaterialId	String	85befc4118b84c6723e53b80b1****	The ID of the material.
Size	Long	1682694	The size of the mezzanine file. Unit: byte.
CoverURL	String	http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg	The thumbnail URL of the material.
Duration	Float	15.16	The duration of the material. The value is rounded to four decimal places. Unit: seconds.
Title	String	test	The title of the material.
Sprites	Array of String	null	The URLs of material sprites. The value is an array.
Snapshots	Array of String	["http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0**.jpg?auth_key=","http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0**.jpg?auth_key="]	The URLs of material snapshots. The value is an array.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetEditingProjectMaterials
&ProjectId=1982361011093374****
&Type=video
&MaterialType=video
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "746FFA07-8BBB-46B1-3E94E3B2915E****",
  "MaterialList" : [ {
    "Status" : "Normal",
    "CreationTime" : "2017-10-19 10:48:17",
    "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" : [ "[\"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.

Sample code of SDKs for various languages

We recommend that you use a server-side SDK to call this operation. For more information about the sample code that is used to call this operation in various languages, see the following topics: