GetEditingProjectMaterials - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieve all media assets bound to the current editing project.

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

ice:GetEditingProjectMaterials

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	ID of the online editing project.	***fb2101cb318***

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	ID of the request.	****89-C21D-4B78-AE24-3788B8****
ProjectId	string	ID of the project.	***67ae06542b9b93e0d1c387***
MediaInfos	array<object>	Collection of matching media assets.
	array<object>
MediaId	string	ID of the media asset.	***64623a94eca8516569c8fe***
MediaBasicInfo	object	Basic information about the media asset.
MediaId	string	ID of the media asset.	***64623a94eca8516569c8f***
InputURL	string	URL of the media asset in the source system.	http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4
MediaType	string	Media type of the asset.	video
BusinessType	string	Business type of the media asset.	general
Source	string	Source of the media asset.	oss
Title	string	Title of the media asset.	file.mp4
Description	string	Description of the media asset.	sample_description
Category	string	Category of the media asset.	video
MediaTags	string	Tags associated with the media asset.	标签,tag1
CoverURL	string	URL of the thumbnail image.	http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature
UserData	string	User-defined data.	userData
Snapshots	string	Thumbnail images.	null
Status	string	Status of the resource.	Normal
TranscodeStatus	string	Status of the transcoding task. Valid values: TranscodeSuccess : Transcoding completed TranscodeFailed : Transcoding failed Init : Initializing Transcoding : Transcoding in progress	Init
CreateTime	string	Time when the media asset was created.	2020-12-26T04:11:08Z
ModifiedTime	string	Time when the media asset was last modified.	2020-12-26T04:11:08Z
DeletedTime	string	Time when the media asset was deleted.	2020-12-26T04:11:08Z
SpriteImages	string	Sprite image.	null
FileInfoList	array<object>	File information.
	array<object>
FileBasicInfo	object	Basic file information, such as duration and size.
FileName	string	Name of the file.	example.mp4
FileStatus	string	Status of the file.	Normal
FileType	string	Type of the file.	source_file
FileSize	string	Size of the file, in bytes.	30611502
FileUrl	string	OSS URL of the file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=
Region	string	Region where the file is stored.	cn-shanghai
FormatName	string	Container format.	mov,mp4,m4a,3gp,3g2,mj2
Duration	string	Duration of the file.	216.206667
Bitrate	string	Bitrate of the file.	1132.68
Width	string	Width of the video.	960
Height	string	Height of the video.	540
LiveMaterials	array<object>	Media assets associated with live streams.
	object
AppName	string	Name of the live streaming application.	testrecord
StreamName	string	Name of the live stream.	testrecord
DomainName	string	Streaming domain name for live streaming.	test.alivecdn.com
LiveUrl	string	Streaming URL for the live stream.	rtmp://test.alivecdn.com/testrecord/teststream
ProjectMaterials	array	Media assets associated with the editing project. After a live stream ends, it is linked to a standard editing project.	***9b145c5cafc2e057304fcd***
	string	ID of the standard editing project associated with the live editing project.	***c38767ae06542b9b93e0d1***

Examples

Success response

JSON format

{
  "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=&OSSAccessKeyId=&Signature=&security-token=",
            "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*****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter \ is not valid.
404	ProjectNotFound	The specified project not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.