Custom Attributes
Custom Attributes are variables stored locally on the player, which can be:
Read by apps;
Used to create playback rules;
Logged and made available in media playback reports.
Unlike Tags, the idea behind Player Attributes is that they can vary and be changed at any time.
Here are some use cases for Player Custom Attributes:
Storing sensor data: A plugin can connect to an external temperature sensor and store the collected data in a Custom Player Attribute every minute.
API call: An external device can make calls to the player’s Local Web API to trigger content playback and, at the same time, store data in a Player Attribute. A good example is a player on a bus, receiving a call from another on-board computer informing when and what the name of the next stop is. This data is stored in a Player Attribute and can be used by an app to display the information on the screen.
Integration with Audience Analytics systems: A plugin integrates with an external system that collects audience data and updates several Player Attributes with this information.
Connectivity Status Plugin: The "Player Internet Connection" plugin checks the player's connectivity every minute and stores "1" in the Player Attribute when connected, and "0" when disconnected. For example, this functionality can be used to condition the playback of streaming content to occur only when the attribute shows a value of "1."
Player Attributes can also be manually updated remotely through the HD2 Platform, but they will be overwritten if the player itself writes newer information.
Another interesting aspect is that Custom Attributes can also appear in media playback reports. For this to happen, the attribute must be explicitly configured to "Show in reports." This way, it is possible to see the Player Attribute's value at the exact moment each media was played in the report.
Lastly, Player Attributes can also be used as triggers for interactivity. A simple example is, "Do this" whenever the Player Attribute's content changes from 0 to 1.
Once configured and created, the Custom Attributes can be consulted or changed on the Player Settings page.
How to Create a Custom Attribute
Click on your name in the lower-left corner > click on Settings > click on Custom Attributes.
Click the Create a custom attribute button in the upper-right corner of the screen.
Configure your attribute as you prefer, choosing a name, adding a help text to make it easier for other users to understand, selecting a type (text or number), and click save.
Once created, custom attributes will appear in a list on the same page. They can be edited at any time by clicking the edit icon in the last column, except for the name and type.
Additionally, by selecting an attribute in the checkbox to the left of its name, you can change its group or even delete it using the buttons at the top of the list.