The ACTV8me Audio Recognition Android SDK allows an app to detect the world around it using audio. We utilize a combination of technologies that trigger user experiences and open up new digital interactions.

I. Getting Started

To use ACTV8me's Audio Watermark & Fingerprint Recognition in an Android application, simply include the following libraries in your project.

Libraries to include:

• audioHybridSearchSoundCode2Lib-release.aar
• audioRecordLib-release.aar
• downloadTaskLib-release.aar
• hybridSearchCommonLib-release.aar

Finally, before installing, please refer to the references page as there are many useful key fields and definitions available.

II. Using the Hybrid Audio SDK in your Project

Using ACTV8me hybrid audio fingerprint recognition and SoundCode watermark decoder in your application.

Step 1 - Import

Please contact us to get the most up-to-date list of dependencies that need to be imported.

Step 2 - Customize

Overwrite default settings for fingerprint recognition and watermark decoding service and audio recording service.

hsSettings = new AudioHybridSearchSoundCodeSettings();

// Settings for fingerprinting library 
hsSettings.dataDirectory = Environment.getExternalStorageDirectory().getPath() + "/HybridSearchSoundCode";
hsSettings.fileName = "testFP.dat";
hsSettings.url = <This value will be provided to you>;

// Settings for SoundCode watermark decoder library
hsSettings.counterLength = 16;
hsSettings.counterIncrement = 1;
hsSettings.delayAdjustment = +0.6f;

// Audio recorder settings (e.g. use default audio source)
arSettings = new AudioRecordServiceSettings();
arSettings.audioSource = AudioSource.DEFAULT;

Step 3 - Create Listener

Create listener and add your own callback processing functions before starting recognition service:

final AudioHybridSearchSoundCodeListener ahslistener = new AudioHybridSearchSoundCodeListener() {
  
  @Override 
		public void onAudioInitFailed() {
			// Do something if audio initialization is failed
			// (usually it means that the mic is occupied by another application)
		}
  
  	@Override
		public void onError(String message) {
		// Internal error (with error message) 
  	}
	
  	@Override
		public void onSearchCompleted(SearchResult result) {
			// Analyze audio fingerprint recognition result       
			// if (result.getExternalId() == -1) no match detected
			// if (result.getExternalId() > 0)  some  track was detected 
			// (track_ID = result.getExternalId())      
			// Offset in milliseconds from track beginning = result.getShift() 
			// result.getAccuracy()  returns  ResultAccuracy.{UNIQUE, SOLVED, 			
			// CONFLICTING, SELF_CONFLICTING} 
			// if  result.isLocalSearch() == true  then the recognition was done 
			// without server interaction (via local database)
		}
  
  	@Override
		public void onNewDatabaseDownloaded() {
		// This method is called then the new local audio database is loaded 		
		// (usually no action needed)
		}
  
  	@Override
		public void onDetectedSCId(long[] result) {
		// We have recognized SoundCode audio watermark
		// Track ID = result[1]
		// Offset from track beginning (in milliseconds)  =  result[3]
	}
 };

Step 4 - Initialize Service

In your activity or service, initialize context for AudioHybridSearchSoundCode service (usually, in onCreate() method).

// Firstly, initialize context via instance() method:
// 1st parameter 	application or activity context
// 2nd parameter 	if true then the debug mode is enabled
AudioHybridSearchSoundCode.instance(this, false);

// Secondly, prepare the service to run
// 1st parameter 	object of AudioHybridSearchSoundCodeSettings class with 
// 			default or non-default settings
// 2nd parameter 	object of AudioHybridSearchSoundCodeListener class
// 3rd parameter 	object of AudioRecordServiceSettings class with
//			default or non-default settings
// 4th parameter	if true, auto start search upon service creation
AudioHybridSearchSoundCode.instance().prepare(hsSettings, ahslistener, arSettings, false);

Step 5 - Start Listener

To start fingerprint recognition and watermark decoding in your application use startSearch() method.

AudioHybridSearchSoundCode.instance().startSearch();

• Not necessary if 3-rd parameter of prepare() method is set to "true"
  -- Both services (fingerprint recognition and watermark decoding) will be started simultaneously

Step 6 - Stop Listener

To stop fingerprint recognition and watermark decoding in your application use stopSearch() method.

AudioHybridSearchSoundCode.instance().stopSearch();

• Both services (fingerprint recognition and watermark decoding) will be stopped simultaneously
  -- You may call start and stop method several times

It is also possible to perform one-time recognition via

AudioHybridSearchSoundCode.instance().singleSearch();

Step 7 - Release

When you no longer need fingerprint recognition and watermark decoding release resources via release() method.

AudioHybridSearchSoundCode.release();

III. References

HIGH-LEVEL Hybrid Audio Fingerprinting and SoundCode Watermark Decoder API

High-level interaction with fingerprint recognition and watermark decoding service is implemented via AudioHybridSearchSoundCode class

To start listening to audio and decoding audio watermarks and recognize audio fingerprints, the application should initialize and start the AudioHybridSearchSoundCode service with an object of AudioHybridSearchSoundCodeSettings class, which contains the system parameters for audio fingerprinting and audio watermarking decoders.

An object of AudioRecordServiceSettings class contains audio recording parameters, e.g. audio recording source.

Audio Hybrid Search SoundCode Settings

Please refer to the table below for key fields (parameters) of the AudioHybridSearchSoundCodeSettings class.

Audio Record Service Settings

Please refer to the table below for key fields (parameters) of the AudioRecordServiceSettings class.