SpinetiX Elementi

https://support.spinetix.com/wiki/
Admin
SpinetiX Elementi is the N°1 digital signage software for creating high impact content with over 250...
Tokens:1,095,596
Snippets:15,135
Trust Score:9.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start Linking an Account (Example Provider)

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/linkaccount

Initiates the account linking process with a specified provider. Requires a return URL and a CSRF token.

```api
api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC
```

--------------------------------

### Elementi Multiscreen Array Setup Example

Source: https://support.spinetix.com/wiki/JSignage%3AMultiscreen

Example of how Elementi 2015 uses the jSignage Multiscreen add-on to configure and set up multiscreen array projects. This snippet parses configuration, sets up the viewbox, and adds layers and edge blending if configured.

```javascript
var config = $.parseJSON( $( '#config' ).text() );
var setup = $.Multiscreen.setupArray( config );
$('svg').attr( 'viewBox', setup.viewBox.join(' ') );
$(function(){
    var txt = $('#jsonLayers').text();
    $('#layers').add( $.Multiscreen.uncan( setup, $.parseJSON( txt ) ) );
    if ( setup.blending )
        $('svg').add( $.Multiscreen.edgeBlending( setup.blending ) );
});

```

--------------------------------

### Player Information Log Example

Source: https://support.spinetix.com/wiki/Player.log

Logs the player model and firmware version. This entry indicates the successful start of a specific player model with its firmware version.

```log
spx.player - logs the player model and firmware version, like _SpinetiX HMP400 version 'Stecknadelhorn 4.8.2-38890' started ..._.

```

--------------------------------

### Create Account Example

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/createaccount

This example demonstrates how to initiate the process of creating a new user account with a specified username and password, including a return URL and a create account token. This is typically the first step in the account creation process.

```api
api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC
```

--------------------------------

### Warn Log - Player Start Event

Source: https://support.spinetix.com/wiki/Deprecated_logs

Example log line for a player starting event, including date, time, firmware version, and starting flags.

```log
date time WARN spx.player - SpinetiX Hyper Media Player version 'Jungfrau 2.2.5-1.0.16095' started with : '/usr/bin/raperca -daemon'
```

--------------------------------

### CodeBlock Template Example: GET Request

Source: https://support.spinetix.com/wiki/Template%3ACodeBlock

Demonstrates the usage of the CodeBlock template for a GET request. Includes a title 'GET' and a description specifying the coaps+tcp endpoint for web storage.

```Wiki Markup
{{CodeBlock | title=GET | description=coaps+tcp://[[HMP_address]]/webstorage?v={key} | class=op-get}}
```

```Plain Text
GETcoaps+tcp://HMP_address/webstorage?v={key}
```

--------------------------------

### FSM File Example for RS232 Command

Source: https://support.spinetix.com/wiki/HMD_Templates

This example demonstrates how a command like 'PowerOn' is defined within an FSM file to be triggered. It shows the structure for initiating a command and transitioning to a 'start' state.

```xml
<onStart command='PowerOn' goto='start'>
```

--------------------------------

### Upload Current Logs and Snapshot with Buffering

Source: https://support.spinetix.com/wiki/Pull_mode

This example demonstrates uploading current log files and a snapshot with a custom naming format. The `-buffer true` option ensures valid Content-Length headers, which is necessary for certain cloud storage services. The upload occurs every two hours.

```vCalendar
BEGIN:VCALENDAR 
VERSION:2.0 
PRODID:-//Spinetix.com/NONSGML Spinetix Control Center//EN 
BEGIN:VEVENT 
UID:14d64d53-a926-4a71-848d-c78234b195fg 
DTSTART:20190101T000000 
DTEND:20190101T013000
RRULE:FREQ=HOURLY;INTERVAL=2;WKST=SU
SUMMARY:upload 
URL: http://webdav.spinetix.com/logs/ 
DESCRIPTION:-buffer true\n-currentlogs\n-snapshot %s-%n.jpg
END:VEVENT 
END:VCALENDAR
```

--------------------------------

### Hostname Address Examples for SpinetiX Players

Source: https://support.spinetix.com/wiki/Remote_access

Examples of hostname address formats for different SpinetiX player models. Ensure Bonjour service is installed for .local resolution. A trailing dot can prevent browser URL guessing.

```text
http://spx-dsos-SerialNumber.local/
```

```text
http://spx-hmp-SerialNumber.local/
```

```text
http://diva-SerialNumber.local/
```

```text
http://spx-hmp-001d502000b2.local./
```

--------------------------------

### RTSP Example URLs

Source: https://support.spinetix.com/wiki/Network_stream_input

Illustrates how to use RTSP URLs for local and external streaming servers.

```text
rtsp://172.21.3.121/high
rtsp://172.21.3.120/axis-media/media.amp
rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mp4
```

--------------------------------

### Direct RPC Request Example

Source: https://support.spinetix.com/wiki/RPC_Concentrator

Example of an HTTP POST request to send a 'restart' command directly to a player.

```http
POST /rpc HTTP/1.0
Host: spx-hmp-001d50001001.local
Content-Type: application/json

{"method":"restart","params":[],"id":1}

```

--------------------------------

### sendComPort Example Usage

Source: https://support.spinetix.com/wiki/SVG

Demonstrates how to use the sendComPort function to send a 'power on' command to a monitor.

```javascript
sendComPort( "monitor", "PowerOn" );
```

--------------------------------

### .begin() or .begin(beginTime)

Source: https://support.spinetix.com/wiki/JSignage_layer

Starts the layer immediately or after a specified delay. If an in-effect is installed, it will be triggered. Restarting an active layer triggers no out-effects.

```APIDOC
## .begin() or .begin(beginTime)

### Description
Start the layer immediately or after `beginTime` seconds (if provided and positive). If an in-effect has been installed, it will be triggered. If the layer is already active at the moment of call, the layer is restarted (without triggering the out-effects). For interactive layers, the `begin` attribute of the layer is typically set to `'indefinite'` so that the layer does not start until the call to `.begin()`.

### Parameters
#### Path Parameters
- **beginTime** (number) - Optional - The time in seconds after which the layer should begin. If not provided or not positive, the layer begins immediately.
```

--------------------------------

### Get Schedule as JSON Example

Source: https://support.spinetix.com/wiki/Parsing_functions

Demonstrates how to retrieve a list of events for a specific day in JSON format. Ensure iCalendar data is valid before parsing.

```javascript
var ical = parseICAL( ical_data );
var now = new Date();
var start = new Date( now.getFullYear(), now.getMonth(), now.getDate() );
var end = new Date( now.getFullYear(), now.getMonth(), now.getDate()+1 );
var schedule = ical.getScheduleAsJSON( start, end );

for ( var i=0; i<schedule.length; i++ ) {
  var item = schedule[i];
  // ...
```

--------------------------------

### Reset All and Set Specific Preferences

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/options

This example first resets all preferences and then sets specific ones like 'skin' and 'nickname'. It shows how to use 'reset', 'change', 'optionname', and 'optionvalue' parameters. A 'token' parameter is required.

```api
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC
```

--------------------------------

### HTTP Endpoint for Updating Shared Variables

Source: https://support.spinetix.com/wiki/Shared_Variables_legacy_server

Example of updating a shared variable using the HTTP GET endpoint. Replace player address and port as needed.

```http
http://spx-hmp-001d50100033:1234/update?var1=value1
```

--------------------------------

### Date, Time, and Number Formatting Examples

Source: https://support.spinetix.com/wiki/JSignage%3ALocalization

Demonstrates setting locale and formatting dates, times, and numbers using predefined formats and custom patterns in different locales.

```javascript
  // formatting date, time and numbers 

  $.setLocale( 'es_ES' ); // sets the default locale

  f = new $.DateTimeFormat( $.DateTimeFormat.Format.LONG_DATE );
  str = f.format( new Date() );   // -> "24 de abril de 2013"

  f = new $.DateTimeFormat( "dd/MM/yyyy" );
  str = f.format( new Date() );   // -> "24/04/2013"

  f = new $.DateTimeFormat( $.DateTimeFormat.Format.LONG_DATE, 'zh_Hans_CN'  );
  str = f.format( new Date() );   // -> "2013年4月24日"

  f = new $.NumberFormat( $.NumberFormat.Format.DECIMAL );
  str = f.format( Math.PI );    // -> "3.142"

  f = new $.NumberFormat( "#.#####" );
  str = f.format( Math.PI );    // -> "3.14159"


```

--------------------------------

### Resource Loading Log Example

Source: https://support.spinetix.com/wiki/Player.log

Logs information about newly loaded resources, whether they are local or from a remote server.

```log
spx.resource, spx.resource.media - logs resource related information, like     _New Resource 'spx://interface/index.svg', New Resource 'spx://localserver/index.svg'_     _New Resource 'http://download.spinetix.com/spxjslibs/jSignage.js'_

```

--------------------------------

### Get Site Info in XML Format

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/xml

Use this endpoint to retrieve site information, including namespaces, formatted as XML. This is a common starting point for interacting with the MediaWiki API.

```api
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml
```

--------------------------------

### Display Legacy Player Blocks with Custom Descriptions

Source: https://support.spinetix.com/wiki/Template%3APlayerBlocksLegacy

This example demonstrates how to add custom, longer descriptions to each player block. Descriptions can include line breaks using `<br/>` for better formatting.

```wikitext
{{PlayerBlocksLegacy | Market Introduction: February 2011<br/>End-of-Warranty: January 2020 | Market Introduction: October 2011<br/>End-of-Warranty: January 2019 | Market Introduction: January 2007<br/>End-of-Warranty: July 2014 }}
```

--------------------------------

### Get parameter information for all submodules of a module

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/paraminfo

This example shows how to use the `modules` parameter with `+*` to fetch parameter information for all direct submodules of a given module, in this case, the `query` module.

```APIDOC
## GET api.php

### Description
Retrieves parameter information for all direct submodules of a specified API module.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `paraminfo`.
- **modules** (string) - Required - Specifies the module and its submodules. `query+*` requests all direct submodules of the `query` module.

### Request Example
```
api.php?action=paraminfo&modules=query%2B*
```

### Response
#### Success Response (200)
(Response structure not explicitly defined in source, but would detail module parameters)

#### Response Example
(Response example not explicitly defined in source)
```

--------------------------------

### Main Index File Log Example

Source: https://support.spinetix.com/wiki/Player.log

Logs the opening and closing of main index files, including their source path, dimensions, duration, and loading times.

```log
spx.display.media - logs the opening and closing of main index files, like     _Open: spx://localserver/index.svg (Size:1920x1080) (Dur: indefinite) in 4ms (network 0ms)_     _Close: spx://localserver/index.svg, Close: spx://elementi/index.svg_

```

--------------------------------

### Query Site Info in JSON Format

Source: https://support.spinetix.com/wiki/Special%3AApiHelp/json

Use this example to retrieve site information, including namespaces, formatted as JSON. This is a common starting point for interacting with the MediaWiki API.

```URL
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
```

```URL
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Data_formats
```

```URL
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json
```
Tokens:
Raw