Difference between revisions of "Player ID"

From A-SMIL.org
Jump to: navigation, search
(Added player ID XPath functions)
(User-Agent Header)
Line 28: Line 28:
  
 
A-SMIL players use the HTTP "User-Agent" header to report its ID to server. Each player reports two pieces of information in this process: a 128-bit UUID and a player name (configurable by the user).
 
A-SMIL players use the HTTP "User-Agent" header to report its ID to server. Each player reports two pieces of information in this process: a 128-bit UUID and a player name (configurable by the user).
 +
 +
For IAdea player XMP-2200 series and IAdea Digital Signboard XDS-1060 series,
  
 
The player formats its User-Agent string in the following format:
 
The player formats its User-Agent string in the following format:
  
 
<pre>
 
<pre>
User-Agent: ADAPI/[APIVersion] (UUID:[playerId]; NAME:[UrlEncode(UTF8(playerName))]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)
+
User-Agent: ADAPI/[APIVersion] (UUID:[playerId]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)
 
</pre>
 
</pre>
  
For example, for a player with player ID "f1835d9f-be8f-4054-9e6c-123456789012" and player name "12:34:56:78:90:12", the User-Agent header may look like:
+
For other A-SMIL players, the player formats its User-Agent string in the following format:
  
 
<pre>
 
<pre>
User-Agent: ADAPI/1.0 (UUID:f1835d9f-be8f-4054-9e6c-123456789012; NAME:12%3A34%3A56%3A78%3A90%3A12) SMP864X-ADAPI/2.0.6 (MODEL:XMP-320)
+
User-Agent: ADAPI/[APIVersion] (UUID:[playerId]; NAME:[UrlEncode(UTF8(playerName))]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)
 
</pre>
 
</pre>
 
Note: this feature is only available in player firmware version 2.0 and later.
 
  
 
== Related ==
 
== Related ==

Revision as of 12:53, 24 September 2013

There are two ways a server can identify the player by its 128-bit UUID (in 8-4-4-4-12 lower-case hex string format). Server finds the UUID in the following ways.

Content Source Macro

Each player as a "Content Source" setting configured to point to an URL loaded at boot time. The URL can contain a macro {$player-id} that is replaced with the player's UUID.

For example, player with ID "f1835d9f-be8f-4054-9e6c-123456789012" configured to load from

http://server.com/player-{$player-id}/index.smil

loads the following actual URL at boot time:

http://server.com/player-f1835d9f-be8f-4054-9e6c-123456789012/index.smil

Another macro that is available is {$fw-version} which gives the firmware version of the player.

XPath Function within SMIL

You can obtain player's UUID via the XPath function {smil-payerId()} or its user-configured player name via {smil-playerName()} inside your SMIL scripts.

See License Enforcement via USB Update on a best practice of sneaker-net application based on the {$player-id} macro.

User-Agent Header

A-SMIL players use the HTTP "User-Agent" header to report its ID to server. Each player reports two pieces of information in this process: a 128-bit UUID and a player name (configurable by the user).

For IAdea player XMP-2200 series and IAdea Digital Signboard XDS-1060 series,

The player formats its User-Agent string in the following format:

User-Agent: ADAPI/[APIVersion] (UUID:[playerId]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)

For other A-SMIL players, the player formats its User-Agent string in the following format:

User-Agent: ADAPI/[APIVersion] (UUID:[playerId]; NAME:[UrlEncode(UTF8(playerName))]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)

Related