Package com.shazam.shazamkit

Types

AudioSampleRateInHz

enum AudioSampleRateInHz : Enum<AudioSampleRateInHz>

List of supported Sample Rates.

Catalog

interface Catalog

An interface marking a class for storing signatures.

CustomCatalog

interface CustomCatalog : Catalog

Configure a custom catalog of Signature objects to match against.

DeveloperToken

data class DeveloperToken(token: String)

Contains the developer token used to authenticate when ShazamCatalog is used to match signatures.

DeveloperTokenProvider

fun fun interface DeveloperTokenProvider

Provides a developer token when required.

HalfClosedDoubleRange

data class HalfClosedDoubleRange(lowerBound: Double, upperBound: Double)

A Range of Double where the lowerBound is included, and the upperBound is excluded: (lowerBound, upperBound].

InternalError

enum InternalError : Enum<InternalError>

Error codes returned when creating SDK components.

MatchedMediaItem

class MatchedMediaItem : MediaItem

MatchedMediaItem represents metadata that has been matched against a Catalog.

MatchError

enum MatchError : Enum<MatchError>

Represents some issue occurred during generating or matching signatures.

MatchResult

sealed class MatchResult

Represents the outcome of a match.

MediaItem

open class MediaItem

MediaItem represents metadata associated Signature.

Session

interface Session

A Session matches instances of Signature against a Catalog.

ShazamCatalog

class ShazamCatalog : Catalog

An online catalog containing signatures.

ShazamKit

object ShazamKit

Entry point to ShazamKit.

ShazamKitException

class ShazamKitException(internalError: InternalError, cause: Throwable?) : Exception

Exception representing an internal error from ShazamKit components.

ShazamKitMatchException

class ShazamKitMatchException(matchError: MatchError, cause: Throwable?) : Exception

Exception representing an error that might occur when using ShazamKit components.

ShazamKitResult

sealed class ShazamKitResult<out A, out B>

Utility class that allows to identify if an operation was successful or failed.

Signature

data class Signature

The Signature class is an opaque data container that can be used to store recognition data.

SignatureGenerator

interface SignatureGenerator

SignatureGenerator provides a way to convert audio data into instances of Signature.

StreamingSession

interface StreamingSession

A StreamingSession matches instances of Signature against a Catalog.