repositories {
maven {
url 'https://dmrc.io/packages/android'
}
}
dependencies {
implementation 'com.digimarc.mobile:dms:4.0.1'
}
dependencies {
implementation files('libs/dms.aar')
}
The DM SDK requires a license key to read watermarks and barcodes. You can generate a license key through the Digimarc Print & Audio Module or Illuminate. See Introducing the Digimarc Mobile SDK for instructions.
In your app's AndroidManifest.xml file, add the license key under the application tag.
<meta-data android:name="com.digimarc.LicenseKey"
android:value="your-license-key">
Digital watermarks configured in Illuminate can be read by the Mobile SDK but are encrypted and must be passed to the Platform before data can be retrieved. This communication is handled automatically by the SDK but requires a Mobile API key you create in Illuminate. Mobile API keys are available only for supported subscriptions. See Introducing the Digimarc Mobile SDK for more information.
To call the Mobile REST API directly, you must provide an encrypted cpmPath as a parameter. The cpmPath for any watermark you read is provided by the getPayloadString method. The encrypted cpmPath string begins with "ed2."
The Digimarc Resolver is an optional service which redirects the user to a URL or image if provided with a digital watermark payload. Currently, the Resolver is compatible only with digital watermarks created in the Digimarc Packaging Module, not those configured in Illuminate. To use the Resolver, you must generate a license key in the Digimarc Print & Audio Module.
If you’re a new Digimarc customer using only Illuminate, don’t use the Resolver.
Illuminate is a product digitization platform introduced by Digimarc in 2023. Digital watermarks configured in Illuminate can be read by the Mobile SDK but are encrypted and must be passed to the platform before data can be retrieved. This communication is handled automatically by the SDK but requires an authorized Account ID and Mobile API key as well as one or more requested fields to be successful. Specify these and other options in the IlluminateSessionParams class.
Finding Your Account ID
You can find your account ID on the Illuminate Account Settings page.
Creating a Mobile API Key
For instructions on creating a Mobile API key, see Introducing the Digimarc Mobile SDK or the Illuminate Account Administrator's Guide. You can download the guide by logging into Illuminate as an account administrator and clicking on Help > User Guides.
Compatible Fields
If configured in Illuminate, the redirectUrl field returns a URL associated with the digital watermark that was read. See the Illuminate Mobile API documentation for a list of available fields. A link is available in the Illuminate Account Administrator's Guide.
The DM SDK package contains three sample applications, each demonstrating different use cases. The apps can be found under the Sample Apps directory. Each app directory contains a Readme.md file describing the application, its operation, and its use cases.
| DetectorViewDemo | Kotlin app that uses the DMSDetectorView all-in-one control. DMSDetectorView provides the easiest way to create an app that detects Digimarc digital watermarks, traditional 1D barcodes, QR codes, and Digimarc Barcode for Audio. |
| DMSDemo | Java app that demonstrates the core DM SDK APIs. These APIs provide the most flexibility for customizing your app's detection process. |
| DMStockTake | Java app that demonstrates Digimarc digital watermarks and 1D barcode scanning at longer distances as in a store "stock-taking" environment. This app provides a good starting point for retail, warehouse, or other scanning scenarios. |
DM SDK declares the following permissions in its manifest:
| Permission | Reason |
|---|---|
| Camera | The CameraHelper and DMSDetectorView classes within the SDK use the camera to capture images for reading. The Camera permission is required for an application to open and use a device's camera. |
| Record Audio | The AudioCaptureReader and DMSDetectorView classes within the SDK use the microphone to listen for audio watermarks. The Record Audio permission is required for an application to open and use the microphone. |
These permissions from the SDK are merged into your application's manifest during the build process. As noted in the description column above, the permissions are used by the SDK for specific detection types. Camera permission is required if your application is using the device's camera to read Digimarc digital watermarks, 1D barcodes, or QR Codes. Record Audio permission is required if your application is detecting Digimarc Barcode for Audio (note that for the DMSDetectorView component audio detection is on by default).
Internet permission is not required, although some SDK capabilities, like resolving payloads, will not function without it. When internet permission is present, the SDK uses the internet to download updated camera settings from the Digimarc backend and to report anonymized usage metrics.
If your application does not use one of the detection types you can exclude the permission from your manifest. This is not required. On Android 6.0+ camera and audio permissions are not granted until the user has consented to their use. The primary reason to exclude a permission is to prevent it from appearing during application installation on older versions of Android.
Permissions can be removed from your application at build time using the tools:node package's remove command. For more information on the manifest merge process refer to the Android documentation.
The following example removes the Record Audio permission. Note that as shown here the tools namespace must be present in the manifest root.
<manifest ... xmlns:tools="http://schemas.android.com/tools">
...
<uses-permission android:name="android.permission.RECORD_AUDIO" tools:node="remove"/>
...
</manifest>