ShazamKit recognizes audio by matching it against Shazam's catalog or against custom reference signatures, returning the matched media metadata to your app. You capture audio and generate an SHSignature with SHSignatureGenerator, then match it through an SHSession or SHManagedSession, receiving results via SHSessionDelegate as an SHMatch containing SHMatchedMediaItem values. To match against your own audio, build an SHCustomCatalog of SHSignature and SHMediaItem pairs, and use SHMediaLibrary and SHLibrary to work with matched items.
Recognizing Audio 4
Run recognition sessions that match captured audio and deliver results to your app.
- ClSHSessioniOS 15.0+An object that matches a specific audio recording when a segment of that recording is part of captured sound in the Shazam catalog or your custom catalog.
- ClSHManagedSessioniOS 17.0+An object that records and matches a recording with captured sound in the Shazam catalog or your custom catalog.
- PrSHSessionDelegateiOS 15.0+Methods that the session calls with the result of a match request.
- ClSHMatchiOS 15.0+An object that represents the catalog media items that match a query.
Generating Signatures 2
Create the acoustic fingerprints used to identify audio.
- ClSHSignatureiOS 15.0+An object that contains the opaque data and other information for a signature.
- ClSHSignatureGeneratoriOS 15.0+An object for converting audio data into a signature.
Matched Media 3
Represent the songs and media items returned from a successful match.
- ClSHMatchedMediaItemiOS 15.0+An object that represents the metadata for a matched reference signature.
- ClSHMediaItemiOS 15.0+An object that represents the metadata for a reference signature.
- StSHMediaItemPropertyiOS 15.0+Constants for the media item property names.
Custom Catalogs 2
Build and reference catalogs of signatures and media to match against your own audio.
- ClSHCatalogiOS 15.0+An abstract base class for storing reference signatures and their associated metadata.
- ClSHCustomCatalogiOS 15.0+An object for storing the reference signatures for custom audio recordings and their associated metadata.
Media Library 2
Work with the user's library of previously matched Shazam items.
- ClSHMediaLibraryAn object that represents the user's Shazam library.
- ClSHLibraryiOS 17.0+An object that represents a user's synced Shazam library.
Errors 1
Inspect the errors that ShazamKit operations can produce.
- StSHErroriOS 15.0+A structure describing the errors that ShazamKit operations can return.