shazamkit/com.shazam.shazamkit/ShazamKit

ShazamKit

object ShazamKit

Entry point to ShazamKit. Creates classes useful to match either a pre-recorded audio file or a live stream of audio (eg. obtained from a microphone).

The match can be performed against the Shazam service or against a custom catalog.

Properties

Link copied to clipboard
var allowLogs: Boolean

Enables logging. False by default

Functions

Link copied to clipboard
fun createCustomCatalog(): CustomCatalog

Creates a CustomCatalog that can be used to match signatures.

Link copied to clipboard
suspend fun createSession(catalog: Catalog): ShazamKitResult<ShazamKitException, Session>

Creates a Session that can be used to match Signatures. If the source of audio is in realtime (eg. a microphone) see createStreamingSession.

Link copied to clipboard
fun createShazamCatalog(developerTokenProvider: DeveloperTokenProvider, locale: Locale? = null): ShazamCatalog

Creates a ShazamCatalog that can be used to match signatures against.

Link copied to clipboard
suspend fun createSignatureGenerator(audioSampleRateInHz: AudioSampleRateInHz): ShazamKitResult<ShazamKitException, SignatureGenerator>

Creates a SignatureGenerator, useful to generate a Signature from pre-recorded audio.

Link copied to clipboard
suspend fun createStreamingSession(catalog: Catalog, audioSampleRateInHz: AudioSampleRateInHz, audioRecordReadBufferSize: Int): ShazamKitResult<ShazamKitException, StreamingSession>

Creates a StreamingSession that allows matching a stream of audio in realtime. The audio format must be PCM 16bit MONO in one of the following sample rates: