Android Player

Introduction

The Android Player is the CM Player equivalent application designed for a run on Android devices, like Mini PC, tablets or mobile phones. The Android Player has essentially the same functionality as the CM Player, with some limitations:

  • No Flash support, Android Player should skip flash files.
  • Watermark & Player status not supported.
  • Play logs and post back to Neptune (only sequential log is supported)
  • No Player Monitor.
  • Only Single Screen support.
  • Node server not supported.
  • Proxy not supported.
  • Player offline update.
  • Time Synchronized playlist.
  • Screen orientation
  • Not implemented remote device management
  • Not implemented triggering campaigns and media with barcode

Start the Player

If you followed the steps closely, and the diagnostics passed, you can now start the Player. You can do this by going to the main app screen of your device and clicking the CM Player icon.

The player will start and you will receive a message denoting that the download of files has started. After all of the media has been downloaded the player will start playing your campaigns.

Daily Reboot

This feature reboots the device every day between 2AM and 3AM (device time).

The player checks for reboot time every 30 minutes from the time he starts to play. When the time for rebooting comes (between 2AM and 3AM the next day), the player reboots. Reboots are made every day only once. That means the function gets the last reboot time (date part) and if it is equal to the current date, the player will not be rebooted. For example, if the player is rebooted manually or started on 3/15/2018 01:12, and the current time is 3/15/2018 02:12 the player will not be rebooted.

Note that for not rooted devices this function is disabled.

Details View

After configuration of an android player, start the player in order for CampaignManager Web to sync the data for the new device. After few seconds, the new device is visible, at first at a domains level Devices list view, then on project level Devices list view for appropriate projects.

When the user selects a device row, two panels correspond to player’s data: The Details view with unique information about the selected device, and the left panel where the tasks and player activities are placed.

The details view is the panel placed above the device’s list view and replaces the pie and the location map when the user selects a device.

Under the Details view we have information about the name, the status, when the player was last online (Last Seen), subscribed channels, gateway IP, screen status, client version, alert, location and time zone.

All system related information of the Android CM Player device is provided when Android CM Player is selected. Android CM Player collects this information and sends them to the CM Service so that user can monitor the device status remotely from Campaign Manager.

All system information is described in the following table.

Gateway IPShows the gateway IP address for the device
DNS NameShows the device name
Last SeenShows when the device last contacted the CM Service
O/SShows the windows operating system
RAMShows the RAM information for the device
DiskShows the device hard disk space-related information
CPUShows the device average CPU usage information
RebootedShows the date/time when the device was last rebooted
Up TimeShows how long Android CM Player has been running
PhysicalLocation Shows the location of the device
Time zoneShows the time zone of the device
Player VersionShows the Android CM Player software version
AMT CapableShows whether the device is AMT capable or not
Average speedShows the average speed of download
Live download speedShows the current download speed
Sync PercentageShows the sync percentage of metadata/media download
Call IntervalShows the duration at which Android CM Player contacts CM Service at regular interval
Gateway IPShows the gateway IP address for the device
DNS NameShows the device name
Last SeenShows when the device last contacted the CM Service
O/SShows the windows operating system
RAMShows the RAM information for the device
DiskShows the device hard disk space-related information
CPUShows the device average CPU usage information
RebootedShows the date/time when the device was last rebooted
Up TimeShows how long Android CM Player has been running
Physical LocationShows the location of the device
Time zoneShows the time zone of the device
Player VersionShows the Android CM Player software version
AMT CapableShows whether the device is AMT capable or not
Average speedShows the average speed of download
Live download speedShows the current download speed
Sync PercentageShows the sync percentage of metadata/media download
Call IntervalShows the duration at which Android CM Player contacts CM Service at regular interval

Android device’s right panel has two main sections: Tasks and Player activity. Below those sections is the map with the pin that points to the player’s physical location.

Player Tasks

Because the Remote device management feature is not implemented for Android device the commands below are disabled all the time.

Remote DesktopFrom this page the Domain Admin can manage the remote desktop of the selected online device.
File ExplorerFrom this page user can see the file system of the remote machine and manage files like add or remove a file, or replace a file to another folder.
Show DesktopIn this page user can monitor the screen activity of selected devices
TerminalThis page provides terminal where the user can type commands for the remote device’s machine.

Player activity

In the player activity, we can see the channels associated with the Android CM Player. Under currently playing we can see which campaigns are published to the Android CM Player and which campaigns are downloading or pulling from the Android CM Player.

Also, we can see which media is in the campaigns and we can preview it by clicking on its name.

Context menu

The context menu contains all the options for the specific type of entity. The context menu for devices is located on the left side and replaces the site’s navigational menu. You can also approach Device’s context menu by right click on the list view area.

Below there is an explanation for all the context menu items:

 Export device listClicking on this option will create a CSV file of all devices that are currently in the list view with all the information about them.
 Change The ChannelThis option is enabled only for single selected device row, and will redirect the user to device’s Channel Settings.
 Pause DownloadWhen this option is set, the player does not download new content: You can publish new content or pull published campaigns, tickers or commands, but the player will not receive requests. After this option is disabled by clicking on the Resume Downloading, the player will receive all the changes.
 Player Log ReportUser can approach the Neptune Player Report by clicking on this option only if the service is linked with Neptune service. Also if you want Neptune to make reports, you have to go to the domain’s Control Panel and check Record what has been played in play log.
 RenameWe can use this option to change the name of the selected player.
 DeleteIf some player is inactive for a long time, and we want to remove it from the Devices list view, we can delete it by selecting its row first. More than one device can be deleted at once.
 Refine LocationWhen no device row is selected in Devices page, on the panel above the list view is displayed the devices status pie and the map with location pointers of all devices in the list.

When you select one device, the details view for this device replaces the all devices view. Among the devices, information is shown the physical location of the device. The physical location is not precise all the time and can point a nearby location of your actual. If you like to change the location and where the pinpoints on the map, you can press on Refine Location.

You can drag and drop the pin in a wanted location. Also, you can change the description of the location in the field above. This field also will offer suggestions of existing location while typing. If the user chooses to go by suggestion, the pointer will automatically change to a new location. Relocate button will save the changes, and Reset to default will reset to a predefined location.

 Reboot deviceThis option will restart selected player’s device.

Android player’s Configurational page in CampaignManager Web

Besides the Android configurational file, the user can set settings for the Android player in the device’s configurational page in CampaignManager Web.

This page differs from the configurational file with the fact that the player must play when the user makes changes in this page.

This page can be opened with a double-click on a specific Android device’s row.

Player Details

Under Player Details, are listed three sections: Summary, Player Activity and Status information.

Summary

This section gives you information about player’s status, number of attached display devices, how many of available devices are configured to run the CM Player and the channels used in the configuration.

Player Activity

In the Player Activity subsection, we have information about the channel that the player is configured with. There is also information about which campaigns are Currently Playing and how much they have been downloaded.

And below the Currently Playing there is the Live Playlist section which is displaying the files in a campaign. These files can be also previewed by clicking on them and their content will be displayed in the Preview box.

Status Information

In the Status information subsection, there is information about further details of the machine that is running the player.

Channel Settings

Screen Management

In the top of the channel settings is placed the section for selecting the channel.

Connection Settings

Here we can set the time (in seconds) that the player checks back (contacts) the CM service.

General Settings

The General Settings section in the Android Player configuration is made of five subsections.

Network Settings

The Network Settings is made of the Connection Settings and the Network interface section. Under the Connection Settings, we can set the settings if we are using Node Server, Proxy Server or enable external trigger events.

Enable external trigger eventsUsually, the default trigger port is 9500.
COM portHere you can type the COM port code where the external device that you want to interact with the Android player is attached.
USB VID / USB PIDHere user should type the VID and PID codes of the USB device. In our case when the user wants to use barcode reader for triggering campaigns and media he should type the codes from the barcode reader. In order to find those pins for the specific device:

<tab> 1. Attach the device to your windows pc and open the Device Manager,
<tab> 2. Select Human Interface Devices and find your USB Input Device,
<tab> 3. Open its Properties window,
<tab> 4. Go to Details and select Hardware Ids property.
Suspend campaign distribution between these timesWill stop receiving new campaign versions between set times. If the start time is bigger than the end time, than the suspension will be between the start time Today, and the end time Tomorrow.

General Settings

Enable process monitorIf this check box is selected, when the player is running in the background in parallel the player process monitor will run. This application is controlling the execution of the player, and if the player has some problems and shuts down, the process monitor can restart it.
Auto updateWith this option, if the CM Service is upgraded, when the Android player communicates with it, it will download the update automatically and it will upgrade the version of the player when ready. Every 30 minutes player checks for upgrades. Player will upgrade immediately only if it is started after service upgrade.
Use image blendingIf this option is selected, if there are multiple images in the campaign when transitioning between images, they will use blending effect.
Use overlay for text zonesWhen many text zones are added to campaigns, on a player they often don’t appear at once. With this option checked, the player puts all text zones in a single image so when the time for playing the campaign comes, all the zones will appear at the same time. This feature also prevents the performance issue.

Note that social zones, especially posts with videos can’t be played or have issues with this option on.
Playback modeThere are four playback modes:

<tab>* Default mode

<tab>* Mouse activates the pending trigger Campaigns: This option activates the trigger campaign with mouse activity (clicking on the player). Also, another option inactivity buffer goes alongside this option and by default is set to 30 seconds. This means that from the time the user stops with activities to the player, the trigger campaign will play for 30 seconds more before a normal campaign goes back.

<tab> * Mouse stays playing the current content: Player configured with this option will play the current media as long as the user is active – clicks on the player. Another option that has inactivity buffer.

<tab> * Play media by trigger code: Media that has trigger code in its description will be played by a player configured with this option when barcode reader reads the same code.

Restart and Exit Settings

Allow PC RebootIf this option is selected, the CM Player will allow an outside script or program to reboot the PC. We can Enable Windows auto log on by entering the Username and Password of the windows user that runs the player on the machine.

Log Settings

Overwrite Domain SettingsWe can set the log settings from the domain for all the players. If we want this player to have separate settings, this option should be checked.
Record what has been playedIf this is checked the media playing will be logged in Sequential logging (logged in multiple files according to the log post back schedule) or in Cumulative logging in one file.
Play log blackout periodThis option is used if we don’t want to log any play out in a certain time interval during the day.

Media Cache Settings

The settings for keeping the unused media files can be set in the CampaignManager Web under domain settings, but we can override this setting here and set the time we want to keep the media files if they are not used in a campaign.