Media fingerprint data types-ApsaraVideo Media Processing(MPS)-阿里云帮助中心

This topic describes the data types related to media fingerprint analysis.

AliyunOSSFile

Description

File types in OSS.

Parameter	Type	Description
Bucket	String	The OSS bucket. The value is 3 to 63 bytes in length.
Location	String	The area where the OSS endpoint is deployed. The value is a maximum of 64 bytes.
Object	String	The OSS object. The value is a maximum of 1024 bytes.

AliyunFpShotJob

Description

Media fingerprinting job type.

Parameter	Type	Description
Id	String	The job ID.
InputFile	AliyunOSSFile	The job input.
FpShotConfig	AliyunFpShotConfig	The configuration.
PipelineId	String	The pipeline ID.
State	String	The job status can be one of the following: Queuing: The job is in a queue. Analysing: The job is being analyzed. Success: The job is successful. Fail: The operation failed.
Code	String	The error code if the analysis fails.
Message	String	The error message if the analysis fails.
UserData	String	The user-defined data.
FpShotResult	FpShotResult	The media fingerprint results.

FpShotConfig

The configurations of the media fingerprint analysis job.

Name	Type	Required	Description
PrimaryKey	String	Yes	The unique primary key of the video. You must ensure its uniqueness.
SaveType	String	Yes	The storage class. Valid values: nosave and save.
FpDBId	String	Yes	The ID of the fingerprint DB. It specifies the fingerprint DB for a query operation.
TextType	String	Yes	The text type. This parameter is for text media fingerprints only. "Text" indicates a long text string. "ASR" indicates a speech recognition result.

FpShotResult

The media fingerprint analysis results.

Parameter	Type	Description
FpShots	FpShot[]	The query results of video media fingerprints.
TextFpShots	TextFpShots[]	Results of the Text DNA query.

FpShot

Description

The details of the video fingerprint analysis results.

Parameter	Type	Description
PrimaryKey	String	The unique primary key of the video.
Similarity	String	The video similarity.
FpShotSlices	FpShotSlice[]	Details of similar videos, including their positions and durations.

FpShotSlice

Description

Details of duplicate videos.

Parameter	Type	Description
Input	String	The start time and duration of the segment in the input video.
Duplication	String	The start time and duration of the segment in the video from the DB.

TextFpShotSlice

The details of the text fingerprint analysis results.

Name	Type	Example	Description
PrimaryKey	String	f3bd5404	The unique primary key of the video. You must ensure its uniqueness.
Similarity	String	1.0	The similarity value for the full text.
TextFpShotSlices	TextFpShotSlice[]	-	Similarity matching information for text segments.

TextFpShotSlices

The details of the similar text snippet.

Name	Type	Example value	Description
InputFragment	InputFragment	-	The start time and duration of the matched query segment.
InputText	String	Li Xiangqian sat down in silence and placed his arms on the dirty table. Two dishes. Four liang of liquor. This was the usual, and also the best food and drink this mom-and-pop shop could offer.	The speech recognition result for the matched query segment.
DuplicationText	String	It seems he often visited this place and was already a regular. The owner, without asking for his opinion, shouted to the back: "One plate of scrambled eggs, one plate of cold pig ears, two liang of liquor!" Li Xiangqian sat down in silence, placing his arms on the dirty...	An excerpt from the matching chapter in the source DB.
Similarity	String	1.0	The confidence level for the matched segment.

InputFragment definition:

Name	Type	Description
Start	String	The start time.
Duration	String	The duration of the segment.

AliyunFpShotJobNotify

Description

The notification of the results of the media fingerprint analysis job.

Parameter	Type	Description
Type	String	The notification type.
UserData	String	The UserData submitted with the job. This data is passed back in the notification.
JobId	String	The job ID.
State	String	Job results Success: The job is successful. Fail: The task or operation failed.
Code	String	The error code if the analysis fails.
Message	String	The error message if the analysis fails.
FpShots	FpShot[]	The matching results for duplicate videos.

FpResultLogInfo

Description

Database import logs.

Parameter	Type	Description
LogPath	String	The download path for the log.
LogName	String	The log file name.
LogStartTime	Long	The start time of the log.
LogEndTime	Long	The end time of the log.
LogSize	Long	The log size. Unit: byte.
CreateTime	Long	The time when the log was generated.

PageInfo

Description

The paging information about the query results.

Parameter	Type	Description
PageIndex	Long	The page number of the query results.
PageSize	Long	The number of entries on each page.
Total	Long	The total number of available log files.

FpShotFile

Description

The information about the media fingerprint file.

Parameter	Type	Description
FileId	String	The file ID.
PrimaryKey	String	The primary key of the user for the DNA file.
InputFile	AliyunOSSFile	The OSS address of the file.

FpFileDeleteJob

Description

The details of a job of deleting media fingerprint files.

Parameter	Type	Description
Id	String	The job ID.
PipelineId	String	The ID of the pipeline.
Status	String	The job status.
Code	String	The error code.
Message	String	The error message.
UserData	String	The user-defined data.
FpDBId	String	The fingerprint DB ID.
FileIds	String	The IDs of the video files to delete.
CreationTime	String	The creation time.
FinishTime	String	The finish time.

FpDBDeleteJob

Description

The details of a job of deleting media fingerprint libraries.

Parameter	Type	Description
Id	String	The job ID.
PipelineId	String	The pipeline ID.
DelType	String	The operation type.
Status	String	The job status.
Message	String	The error message.
Code	String	The error code.
UserData	String	Custom data.
FpDBId	String	The fingerprint DB ID.
CreationTime	String	The creation time.
FinishTime	String	The finish time.