SearchMediaClipByFace - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about media asset clips that are related to a specific face based on the response to the SearchMediaByFace operation.

Operation description

If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).

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
ice:SearchMediaClipByFace	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The name of the search library.	test1
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 50.	10
EntityId	string	No	The ID of the entity.	2d3bf1e35a1e42b5ab338d701efa****
FaceSearchToken	string	Yes	The value of this parameter is the same as that of the FaceSearchToken parameter in the SearchMediaByFace request. This specifies to return media asset clips that meet the same query conditions.	zxtest-huangxuan-2023-3-7-V1
MediaId	string	Yes	The ID of the media asset.	3b187b3620c8490886cfc2a9578c****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	E44FFACD-9E90-555A-A09A-6FD3B7335E39
Success	string	Indicates whether the request was successful. Valid values: true and false.	true
Code	string	The status code returned.	200
MediaClipList	array<object>	The media asset clips that meet the requirements.
MediaClip	object
Score	float	The score of the clip. The value is of the Float type. The value is in the range of [0,1].	0.99041677
EntityId	string	The ID of the entity, which is the same as the entity ID returned in tag analysis.	1031025****
LabelName	string	The name of the entity.
OccurrencesInfos	array<object>	The information about clips related to the face.
OccurrencesInfo	object
StartTime	float	The start time of the clip. Unit: seconds. The value is of the Float type.	61.066353
EndTime	float	The end time of the clip. Unit: seconds. The value is of the Float type.	69.06635
TrackData	array<object>	The information about the face in the clip.
TrackData	object
Timestamp	float	The timestamp when the face appears in the clip. Unit: seconds. The value is of the Float type.	62.03302
BoxPosition	object	The coordinates of the face.
X	integer	The x-axis coordinate of the upper-left corner. Unit: pixels.	517
Y	integer	The y-axis coordinate of the upper-left corner. Unit: pixels.	409
W	integer	The width of the rectangle frame. Unit: pixels.	128
H	integer	The height of the rectangle frame. Unit: pixels.	168
Category	string	The type of the character. Valid values: celebrity sensitive politician custom unknown	celebrity
Total	long	The total number of media asset clips that meet the conditions.	5

Examples

Sample success responses

JSONformat

{
  "RequestId": "E44FFACD-9E90-555A-A09A-6FD3B7335E39",
  "Success": "true",
  "Code": "200",
  "MediaClipList": [
    {
      "Score": 0.99041677,
      "EntityId": "1031025****",
      "LabelName": "",
      "OccurrencesInfos": [
        {
          "StartTime": 61.066353,
          "EndTime": 69.06635,
          "TrackData": [
            {
              "Timestamp": 62.03302,
              "BoxPosition": {
                "X": 517,
                "Y": 409,
                "W": 128,
                "H": 168
              }
            }
          ]
        }
      ],
      "Category": "celebrity"
    }
  ],
  "Total": 5
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-10-12	The request parameters of the API has changed	View Change Details