Difference between revisions of "Player ID"

From A-SMIL.org
Jump to: navigation, search
(User-Agent Header)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
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 (in 8-4-4-4-12 hex string format) and a player name (configurable by the user).
+
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 <tt>{$player-id}</tt> that is replaced with the player's UUID.
 +
 
 +
For example, player with ID "f1835d9f-be8f-4054-9e6c-123456789012" configured to load from
 +
 
 +
<pre>
 +
http://server.com/player-{$player-id}/index.smil
 +
</pre>
 +
 
 +
loads the following actual URL at boot time:
 +
 
 +
<pre>
 +
http://server.com/player-f1835d9f-be8f-4054-9e6c-123456789012/index.smil
 +
</pre>
 +
 
 +
Another macro that is available is <tt>{$fw-version}</tt> which gives the firmware version of the player.
 +
 
 +
'''Please noted that Content Source Macro is not supported on XMP-2200, XDS-1060, MBR-1100, XMP-6200/6250/6400/7300 and XDS-1078 series 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.
 +
 
 +
For IAdea player XMP-2200 series, IAdea Digital Signboard XDS-1060 series, MBR-1100,XMP-6200/6250/6400/7300 and XDS-1078 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}
+
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) SMP863X-ADAPI/1.3.2
+
User-Agent: ADAPI/[APIVersion] (UUID:[playerId]; NAME:[UrlEncode(UTF8(playerName))]) [firmwareFamily]/[firmwareVersion] (MODEL:modelName)
 
</pre>
 
</pre>
  

Latest revision as of 08:40, 22 June 2017

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.

Please noted that Content Source Macro is not supported on XMP-2200, XDS-1060, MBR-1100, XMP-6200/6250/6400/7300 and XDS-1078 series 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.

For IAdea player XMP-2200 series, IAdea Digital Signboard XDS-1060 series, MBR-1100,XMP-6200/6250/6400/7300 and XDS-1078 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