Class SHErrorCode


  • public final class SHErrorCode
    extends java.lang.Object
    Error codes returned when generating and matching signatures
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static long AudioDiscontinuity
      The audio provided was not contiguous Shazam requires audio to be contiguous in order to match.
      static long CustomCatalogInvalid
      Failed to load the Custom Catalog Validate the structure of the Catalog file
      static long CustomCatalogInvalidURL
      The Custom Catalog URL was invalid The URL must be a filePath URL that contains a valid Catalog
      static long InternalError
      Internal Error ShazamKit encountered an internal error API-Since: 16.0
      static long InvalidAudioFormat
      The @c AVAudioFormat is not supported ShazamKit only accepts certain audio formats
      static long MatchAttemptFailed
      The request to match the signature failed The attempt failed and was not matched, trying again may result in success [@note] This code does not indicate a 'No Match'
      static long MediaItemFetchFailed
      Failed to fetch @c SHMediaItem There was an error fetching the @c SHMediaItem or the provided @c shazamID is invalid.
      static long MediaLibrarySyncFailed
      Failed to sync some content to the user's library Failed to sync the user's library, trying again may result in success Underlying error may contain more details about the failure
      static long SignatureDurationInvalid
      The signature duration is outside the valid range The signature is valid but is too long/short for the service attempting to match it
      static long SignatureInvalid
      Failed to create a signature from the provided audio Validate the audio you are supplying, it may be silence.
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • InvalidAudioFormat

        public static final long InvalidAudioFormat
        The @c AVAudioFormat is not supported ShazamKit only accepts certain audio formats
        See Also:
        Constant Field Values
      • AudioDiscontinuity

        public static final long AudioDiscontinuity
        The audio provided was not contiguous Shazam requires audio to be contiguous in order to match.
        See Also:
        Constant Field Values
      • SignatureInvalid

        public static final long SignatureInvalid
        Failed to create a signature from the provided audio Validate the audio you are supplying, it may be silence.
        See Also:
        Constant Field Values
      • SignatureDurationInvalid

        public static final long SignatureDurationInvalid
        The signature duration is outside the valid range The signature is valid but is too long/short for the service attempting to match it
        See Also:
        Constant Field Values
      • MatchAttemptFailed

        public static final long MatchAttemptFailed
        The request to match the signature failed The attempt failed and was not matched, trying again may result in success [@note] This code does not indicate a 'No Match'
        See Also:
        Constant Field Values
      • CustomCatalogInvalid

        public static final long CustomCatalogInvalid
        Failed to load the Custom Catalog Validate the structure of the Catalog file
        See Also:
        Constant Field Values
      • CustomCatalogInvalidURL

        public static final long CustomCatalogInvalidURL
        The Custom Catalog URL was invalid The URL must be a filePath URL that contains a valid Catalog
        See Also:
        Constant Field Values
      • MediaLibrarySyncFailed

        public static final long MediaLibrarySyncFailed
        Failed to sync some content to the user's library Failed to sync the user's library, trying again may result in success Underlying error may contain more details about the failure
        See Also:
        Constant Field Values
      • InternalError

        public static final long InternalError
        Internal Error ShazamKit encountered an internal error API-Since: 16.0
        See Also:
        Constant Field Values
      • MediaItemFetchFailed

        public static final long MediaItemFetchFailed
        Failed to fetch @c SHMediaItem There was an error fetching the @c SHMediaItem or the provided @c shazamID is invalid. API-Since: 17.0
        See Also:
        Constant Field Values