This topic describes the data types related to media fingerprint analysis.
AliyunOSSFile
Description
The details of the Object Storage Service (OSS) object that is used as the job input.
| Parameter | Type | Description |
|---|---|---|
| Bucket | String | The name of the OSS bucket in which the OSS object is stored. The value must be 3 to 63 bytes in length. |
| Location | String | The name of the OSS region in which the OSS object resides. The value can be up to 64 bytes in length. |
| Object | String | The name of the OSS object. The value can be up to 1,024 bytes in length. |
AliyunFpShotJob
Description
The details of the media fingerprint analysis job.
| Parameter | Type | Description |
|---|---|---|
| Id | String | The ID of the job. |
| InputFile | AliyunOSSFile | The information about the job input. |
| FpShotConfig | AliyunFpShotConfig | The configurations of the job. |
| PipelineId | String | The ID of the ApsaraVideo Media Processing (MPS) queue. |
| State | String | The status of the job. Valid values:
|
| Code | String | The error code returned when the job fails. |
| Message | String | The error message returned when the job fails. |
| UserData | String | The custom data. |
| FpShotResult | FpShotResult | The media fingerprint analysis results. |
FpShotConfig
The configurations of the media fingerprint analysis job.
| Parameter | Type | Required | Description |
|---|---|---|---|
| PrimaryKey | String | Yes | The unique primary key of the input video. |
| SaveType | String | Yes | The storage type. Valid values: nosave and save. |
| FpDBId | String | Yes | The ID of the media fingerprint library involved in a query operation. |
| TextType | String | Yes | The text type. This parameter is valid only for text fingerprint analysis. A value of Text indicates a long text string. A value of ASR indicates speech recognition text. |
FpShotResult
The media fingerprint analysis results.
| Parameter | Type | Description |
|---|---|---|
| FpShots | FpShot[] | The video fingerprint analysis results. |
| TextFpShots | TextFpShots[] | The text fingerprint analysis results. |
FpShot
Description
The details of the video fingerprint analysis results.
| Parameter | Type | Description |
|---|---|---|
| PrimaryKey | String | The unique primary key of the input video. |
| Similarity | String | The similarity of the input video against videos that have similar fingerprints to the input video in the media fingerprint library. |
| FpShotSlices | FpShotSlice[] | The array of videos that have similar fingerprints to the input video in the media fingerprint library. If a video clip in the input video has similar fingerprints to a video clip in a video in the media fingerprint library, the start point in time and length of the similar video clip in the input video and similar video are returned. |
FpShotSlice
Description
The details of the similar video clip.
| Parameter | Type | Description |
|---|---|---|
| Input | String | The start point in time and length of the similar video clip in the input video. |
| Duplication | String | The start point in time and length of the similar video clip in the video that has similar fingerprints to the input video in the media fingerprint library. |
TextFpShotSlice
The details of the text fingerprint analysis results.
| Parameter | Type | Example | Description |
|---|---|---|---|
| PrimaryKey | String | f3bd5404 | The unique primary key of the input video. |
| Similarity | String | 1.0 | The similarity of the input text against text snippets that have similar fingerprints to the input text in the text fingerprint library. |
| TextFpShotSlices | TextFpShotSlice[] | - | The array of text snippets that have similar fingerprints to the input text in the text fingerprint library. |
The details of the similar text snippet.
| Parameter | Type | Example | Description |
|---|---|---|---|
| InputFragment | InputFragment | - | The start point in time and length of the similar text snippet in the input text. |
| InputText | String | Li Xiangqian sits down in silence and puts his arms on the dirty table. Two dishes and two liang liquor, as usual. These are delicacies this mom-and-pop stall can provide. | The speech recognition results of the input text for text fingerprint analysis. |
| DuplicationText | String | It seems that he is a regular guest of this stall. The stall owner does not ask what he wants to order, but turns backward and shouts, "Scrambled eggs! Pig ear salad! Two liang liquor!" Li Xiangqian sits down in silence and puts his arms on the dirty table... | The text snippet that has similar fingerprints to the input text in the text fingerprint library. |
| Similarity | String | 1.0 | The similarity of the input text against the text snippet that has similar fingerprints to the input text in the text fingerprint library. |
| Parameter | Type | Description |
|---|---|---|
| Start | String | The start point in time. |
| Duration | String | The length. |
AliyunFpShotJobNotify
Description
The notification of the results of the media fingerprint analysis job.
| Parameter | Type | Description |
|---|---|---|
| Type | String | The type of the notification. |
| UserData | Stromg | The custom data that you specified when you submit the job. This parameter is returned in the response. |
| JobId | String | The ID of the job. |
| State | String | The results of the job. Valid values:
|
| Code | String | The error code returned when the job fails. |
| Message | String | The error message returned when the job fails. |
| FpShots | FpShot[] | The details of the media fingerprint analysis results. |
FpResultLogInfo
Description
The logs that record the results of importing text files to the text fingerprint library.
| Parameter | Type | Description |
|---|---|---|
| LogPath | String | The path for downloading the log. |
| LogName | String | The name of the log file. |
| LogStartTime | Long | The start point in time of the log. |
| LogEndTime | Long | The end point in time of the log. |
| LogSize | Long | The size of the log file. Unit: byte. |
| CreateTime | Long | The point in time when the log was generated. |
PageInfo
Description
The paging information about the query results.
| Parameter | Type | Description |
|---|---|---|
| PageIndex | Long | The number of the returned page. |
| PageSize | Long | The number of entries returned on each page. |
| Total | Long | The total number of log files that are queried. |
FpShotFile
Description
The information about the media fingerprint file.
| Parameter | Type | Description |
|---|---|---|
| FileId | String | The ID of the file. |
| PrimaryKey | String | The primary key of the file user. |
| InputFile | AliyunOSSFile | The OSS URL of the file. |
FpFileDeleteJob
Description
The details of a job of deleting media fingerprint files.
| Parameter | Type | Description |
|---|---|---|
| Id | String | The ID of the job. |
| PipelineId | String | The ID of the MPS queue. |
| Status | String | The status of the job. |
| Code | String | The error code returned when the job fails. |
| Message | String | The error message returned when the job fails. |
| UserData | String | The custom data. |
| FpDBId | String | The ID of the media fingerprint library. |
| FileIds | String | The IDs of the media fingerprint files to be deleted. |
| CreationTime | String | The point in time when the job was created. |
| FinishTime | String | The point in time when the job was complete. |
FpDBDeleteJob
Description
The details of a job of deleting media fingerprint libraries.
| Parameter | Type | Description |
|---|---|---|
| Id | String | The ID of the job. |
| PipelineId | String | The ID of the MPS queue. |
| DelType | String | The operation type. |
| Status | String | The status of the job. |
| Message | String | The error message returned when the job fails. |
| Code | String | The error code returned when the job fails. |
| UserData | String | The custom data. |
| FpDBId | String | The ID of the media fingerprint library. |
| CreationTime | String | The point in time when the job was created. |
| FinishTime | String | The point in time when the job was complete. |