Audio Built-ins¶
Audio Built-ins provide functionality to match audio files. For Steps and Compound Steps, refer to Audio and Speech Channel Steps and Compound Steps.
Match References¶
matchesReference
compares an audio recording to a reference file. The Step optionally receives a parameter indicating the required similarity of the two audio files, expressed in percentage, in order for the step to succeed.
Syntax
1 | Audio.matchesReference(<audio File>, <reference String>, <minimumSimilarityPercentage Number>, <profile String>) |
Parameters
-
audio - The audio file to be matched
-
reference - The name of the expected reference recording
-
minimumSimilarityPercentage (Optional) - The percentage between
0
and100
that defines the extent to which the audio recording must match the reference recording- Default value is set to
0
- Default value is set to
-
profile (Optional) - The name of the Audio Match profile to be used for the audio matching, which must evaluate to a string
- If not specified, the default profile will be used
Example - 2 Arguments
1 | Audio.matchesReference(file, "referenceName") |
The example above specifies the audio file and the expected reference recording are specified.
Example - 3 Arguments
1 | Audio.matchesReference(file, "referenceName", 50.0) |
The example above specifies one additional argument for the similarity score, in addition to the audio file and the expected reference recording.
Example - 4 Arguments
1 | Audio.matchesReference(file, "referenceName", 50.0, "hd-profile") |
The example above specifies two additional arguments for the similarity score and the profile, in addition to the audio file and the expected reference recording.