Enum SORIAudioMarkerCadence

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable

    
    public enum SORIAudioMarkerCadence
    extends Enum<SORIAudioMarkerCadence>
                        

    Schedule of the audio-marker scan, selected with SORIConfig.audioMarkerCadence. It applies only while marker scanning is on and never enables the detector itself.

    Behaviour per recognition path:

    • audiomarker = true on Android 10+ (continuous capture): as described on each value.

    • SORIConfig.markerOnlyRecognition diagnostic: there is no fingerprint window, so BATTERY_SAVING scans once per 3.25 s (the fingerprint window length, starting at the first full window) instead of every 0.8125 s.

    • Android 7-9 (segmented capture): the marker is always detected on the fingerprint window itself; both values behave the same.

    • Server recognition (SORIConfig.recognitionMode other than SORIRecognitionMode.ON_DEVICE): audio markers are rejected there, so the value has no effect. It is accepted, not rejected.

    • Capture-only and feature-only diagnostics run no marker scan; the value has no effect.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LOW_LATENCY

      Default. A marker scan over the newest 3.25 s every 0.8125 s (13 hops), independently of the 3.25 s fingerprint windows. Lowest marker latency; each moment of audio is scanned four times.

      BATTERY_SAVING

      One marker scan per 3.25 s fingerprint window, run back-to-back with that window's fingerprint match on the same PCM, with no marker scan in between. The marker result is reported independently of the material match, as with LOW_LATENCY, so a marker without a matching material is still reported. Marker latency is at least 3.25 s, and a marker that a single window misses (for example one straddling a window boundary) is not detected until a later window.

    • Method Summary

      Modifier and Type Method Description
      final SORIAudioMarkerCadence valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<SORIAudioMarkerCadence> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final EnumEntries<SORIAudioMarkerCadence> getEntries() Schedule of the audio-marker scan, selected with SORIConfig.audioMarkerCadence.
      • Methods inherited from class kotlin.Enum

        getName, getOrdinal
      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • valueOf

         final SORIAudioMarkerCadence valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<SORIAudioMarkerCadence> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.

      • getEntries

         final EnumEntries<SORIAudioMarkerCadence> getEntries()

        Schedule of the audio-marker scan, selected with SORIConfig.audioMarkerCadence. It applies only while marker scanning is on and never enables the detector itself.

        Behaviour per recognition path:

        • audiomarker = true on Android 10+ (continuous capture): as described on each value.

        • SORIConfig.markerOnlyRecognition diagnostic: there is no fingerprint window, so BATTERY_SAVING scans once per 3.25 s (the fingerprint window length, starting at the first full window) instead of every 0.8125 s.

        • Android 7-9 (segmented capture): the marker is always detected on the fingerprint window itself; both values behave the same.

        • Server recognition (SORIConfig.recognitionMode other than SORIRecognitionMode.ON_DEVICE): audio markers are rejected there, so the value has no effect. It is accepted, not rejected.

        • Capture-only and feature-only diagnostics run no marker scan; the value has no effect.