Install the Broadsign Android Player Application
Note: This feature is in Beta version.
The following methods are available to install the Broadsign Android Player application.
The easiest way of installing the Broadsign Android Player application is to download it from the Play Store and install it on your Android device.
To install the APK, tap the downloaded file in your Android device's file explorer. This action might require you to enable special permissions in your settings; a notification will prompt you if you need to adjust these.
To install the APK file from your computer using ADB, run the following command:
adb install -r path/to/file.apkAfter you install the Broadsign Android Player application, launch it directly from your device. The application appears in your Android device's Applications menu.
When you launch the application, you will see a black screen displaying a small notification: "Register using credentials".
You now need to Register the Broadsign Android Player.
Once you have started the Broadsign Android Player application, proceed to register it.
Note: You can only register a player once. To change the player ID or the API token, you must uninstall and reinstall the application.
To register the application:
- Click the Register using credentials button.
- Enter the following information:
- Player identifier – Enter the Custom ID value defined in Step 4 – Create a Player Registration
- API token – Enter the API token created in Step 5 – Generate an API Token
The Custom ID value serves as the Player Identifier within the Broadsign Android Player registration process.
The Player registration screen displays.
The player is registered.
The application is ready to display your campaigns.
Using a Custom Server
You can use a custom server to register your Broadsign Android Player.
- This method is optional.
- This method is useful if you are using a test server.
- Use the server's Hostname provided by Broadsign Services.
To use a custom server:
- In the Player registration screen, click the wheel icon.
- Check Use custom server and enter the server's Hostname.
- Go back to the registration screen by clicking the back arrow.
The Settings screen displays.
Use ADB to register the Broadsign Android Player using Android intents.
You will need the following information:
- The Player Identifier as defined in Step 4 – Create a Player Registration
- The API token as created in Step 5 – Generate an API Token
The Custom ID value serves as the Player Identifier within the Broadsign Android Player registration process.
Run the following command:
adb shell am broadcast -a com.broadsign.intents.ACTION_REGISTER --es api_token <YOUR_API_TOKEN> --es player_id <YOUR_PLAYER_ID>For example, with the API token 4ac454fe431aefd3f and player ID my_custom_player, you would run the following command:
adb shell am broadcast -a com.broadsign.intents.ACTION_REGISTER --es api_token 4ac454fe431aef --es player_id my_custom_playerThe application will start playing the content that you scheduled within one minute.
Notes
You can only register a player once. To change the player ID or the API token, you must either:
- Uninstall and reinstall the application.
- Clear the app data using the command
adb shell pm clear com.broadsign.androidplayer, then restart the application.
You can add the optional parameter hostname to the command line to use a custom server. For example:
--es hostname https://control-sandbox.broadsign.com
