Implementing Android Player

This section describes configuring Android player. It provides information of the configuration file and the options available and recommendations as to which settings to use for development and testing.

Additionally, Watchdog is a solution to recover the player from crashes. An application needs to register itself with the watchdog service and then periodically send messages to the service that it is alive. In case the watchdog service does not receive a keep-alive message within a stipulated time, the service attempts to reboot the device for a clean recovery (if it has the sufficient privileges) or restart the application.

Installing Android Player

To implement Android Player for AEM Screens, please install Android Player for AEM Screens.

Visit the AEM 6.5 Player Downloads page.

Setting up Environment for AEM Screens 6.5.5 Service Pack

NOTE

You must set up an environment for Android player if you are using AEM Screens 6.5.5 Service Pack.

Set the SameSite attribute for the login-token cookies from Lax to None from Adobe Experience Manager Web Console Configuration on all AEM author and publish instances.

Follow the steps below:

  1. Navigate to Adobe Experience Manager Web Console Configuration using http://localhost:4502/system/console/configMgr.

  2. Search for Adobe Granite Token Authentication Handler.

  3. Set the SameSite attribute for the login-token cookies from Lax to None.
    image

  4. Click Save.

Ad-Hoc Method

The Ad-Hoc method allows you to install the latest Android Player (.exe). Visit AEM 6.5 Player Downloads page.

Once you download the application, follow the steps on the player to complete the ad-hoc installation:

  1. Long-press on the top left corner to open the admin panel.

  2. Navigate to Configuration from the left action menu and enter the location (address) of the AEM instance you wish to connect to and click Save.

  3. Navigate to the Device Registration link from the left action menu to check the status of the device registration process.

NOTE

If the State is REGISTERED, you will notice the Device id field will be populated.

If the State is UNREGISTERED, you can use the Token to register the device.

Implementing Android Watchdog

Due to Android’s architecture, rebooting the device requires that the application has system privileges. To do this, you need to sign the apk using the manufacturer’s signing keys, otherwise watchdog will restart the player application and not reboot the device.

Signage of Android apks using Manufacturer Keys

To access some of the privileged APIs of Android such as PowerManager or HDMIControlServices, you need to sign the android apk using the manufacturer’s keys.

CAUTION

Pre-requisites:

You should have the android SDK installed, before you perform the following steps.

Follow the steps below to sign the android apk using the manufacturer’s keys:

  1. Download the apk from Google Play or from AEM Screens Player Downloads page

  2. Obtain the platform keys from the manufacturer to get a pk8 and a pem file

  3. Locate the apksigner tool in android sdk using find ~/Library/Android/sdk/build-tools -name “apksigner”

  4. <pathto> /apksigner sign --key platform.pk8 --cert platform.x509.pem aemscreensplayer.apk

  5. Find the path to the zip align tool in android sdk

  6. <pathto> /zipalign -fv 4 aemscreensplayer.apk aemscreensaligned.apk

  7. Install aemscreensaligned.apk using adb install to the device

Understanding Android Watchdog Services

The cross-Android watchdog service is implemented as a cordova plugin using AlarmManager.

The following diagram shows the implementation of watchdog service:

chlimage_1-31

1. Initialization At the time of initialization of the cordova plugin, permissions are checked to see if we have system privileges and thus the Reboot permission. If these two criteria are met, a pending Intent for Reboot is created, otherwise a pending Intent to restart the application (based on its Launch Activity) is created.

2. Keep Alive Timer A keep alive timer is used to trigger an event every 15 seconds. In that event, you need to cancel the existing pending intent (to reboot or restart the app) and register a new pending intent for the same 60 seconds in the future (essentially postponing reboot).

NOTE

In Android, the AlarmManager is used to register the pendingIntents that can execute even if the app has crashed and its alarm delivery is inexact from API 19 (Kitkat). Keep some spacing between the timer’s interval and the AlarmManager’s pendingIntent’s alarm.

3. Application Crash In case of a crash, the pendingIntent for Reboot registered with AlarmManager is no longer reset and thus it executes a reboot or restart of app (depending on permissions available at the time of initialization of the cordova plugin).

Bulk Provisioning of Android Player

When rolling out the Android player in bulk, there is a need to provision the player to point to an AEM instance as well as configure other properties without manually entering those in the Admin UI.

NOTE

This feature is available from Android player 42.0.372.

Follow the steps below to allow bulk provisioning in the Android player:

  1. Create a configuration JSON file with the name player-config.default.json.
    Refer to a Example JSON Policy as well as a table that describes the use of the various Policy Attributes.

  2. Use an MDM or ADB or Android Studio file explorer to drop this policy JSON file to the sdcard folder on the Android device.

  3. Once the file is deployed, use the MDM to install the player application.

  4. When the player application launches, it will read this configuration file and point to the applicable AEM server where it can be registered and subsequently controlled.

    NOTE

    This file is read only the first time the application is launched and cannot be used for subsequent configurations. If the player is launched before the configuration file was dropped, simply uninstall and re-install the application on the device.

Policy Attributes

The following table summarizes the policy attributes with an example policy JSON for reference:

Policy Name Purpose
server The URL to the Adobe Experience Manager server.
resolution The resolution of the device.
rebootSchedule The schedule to reboot applies to all platforms.
enableAdminUI Enable the Admin UI to configure the device on site. Set to false once it is fully configured and in production.
enableOSD Enable the channel switcher UI for users to switch channels on device. Consider setting to false once it is fully configured and in production.
enableActivityUI Enable to show progress of activities such as download and sync. Enable for troubleshooting and disable once it is fully configured and in production.
enableNativeVideo Enable to use native hardware acceleration for video playback (Android only).

Example JSON Policy

{
  "server": "https://author-screensdemo.adobecqms.net",
"device": "",
"user": "",
"password": "",
"resolution": "auto",
"rebootSchedule": "at 4:00 am",
"maxNumberOfLogFilesToKeep": 10,
"logLevel": 3,
"enableAdminUI": true,
"enableOSD": true,
"enableActivityUI": false,
"enableNativeVideo": false,
"enableAutoScreenshot": false,
"cloudMode": false,
"cloudUrl": "https://screens.adobeioruntime.net",
"cloudToken": "",
"enableDeveloperMode": true
}
NOTE

All Android devices have an sdcard folder whether an actual sdcard is inserted or not. This file when deployed would be at the same level as the Downloads folder. Some MDMs such as Samsung Knox may refer to this sdcard folder location as Internal storage.

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free