Open topic with navigation

# AfpMatch

The `AfpMatch` task searches an audio file or stream for any sections that match audio indexed in an AFP database.

By default, the `AfpMatch` task uses acoustic landmark matching. You can set AfpMode to use template-based matching, which is more robust but less scalable.

## Parameters

Parameter | Description | Required
--- | --- | ---
Type | The task name. Set to `AfpMatch`. | Yes
AfpDb | The audio fingerprint database (if it is defined in the configuration file). | See Comments
AfpMode | The mode to use for audio fingerprinting. |
AudioUpsampling | Whether to allow audio upsampling if the input audio has a sample rate too low for the task. |
Delay | The delay in updating results. |
EndTime | The end of an audio section to process. |
File | The audio file to search. | Yes, if InputType is `File`.
InputType | The type of audio to process (file, binary data, or stream). |
MinDuration | The minimum duration of a section that must match before that match is considered. |
MinHits | The minimum number of hits that a section of audio must generate before IDOL Speech Server returns it as a match for a clip in an audio fingerprinting database. |
MinRate | The minimum hit rate threshold for audio fingerprint identification. |
NBest | The maximum number of matching AFP clips to include in the results for a section. |
Out | The file to write the results to. |
OutputNonResults | A value that specifies how often to output a non-result tag when the audio does not contain a match. |
Pack | The audio fingerprint database (if it is not defined in the configuration file). | See Comments
PackDir | The path to the directory containing the database. | See Comments
Rnd | A window size within which a random offset shift is calculated. |
Sfreq | The sample frequency of the audio file to process. |
SpecSize | The analysis resolution. |
StartTime | The beginning of an audio section to process. |
SugdInputChannels | The channel layout of the input media file. This parameter does not apply when InputType is `Stream`. |
SugdInputFrequency | The sampling rate of the input media file. This parameter does not apply when InputType is `Stream`. |
TimeQ | The degree of quantization to perform. |

## Comments

If the database is defined in the IDOL Speech Server configuration file, you must set the AfpDb parameter. If the database is not defined, set both the Pack and PackDir parameters instead.

## Example

    http://localhost:15000/action=AddTask&Type=AfpMatch&File=C:\Data\July18.wav&Pack=Adverts&PackDir=C:\resources&Out=July18Results.ctm

This action searches the `July18.wav` file for sections that match audio indexed in the `Adverts` database and writes the search results to the `July18Results.ctm` file.

    http://localhost:15000/action=AddTask&Type=AfpMatch&InputType=Stream&Pack=Adverts&PackDir=C:\resources&Out=Results.ctm

This action searches the audio stream for sections that match audio indexed in the `Adverts` database and writes the search results to the `Results.ctm` file.

© 2015-2018 EntIT Software LLC, a Micro Focus company | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm