SPX API

/ Code Library /

ORIGIN
[ code library ]

SpinetiX API dictionary

1427 constructors, methods, attributes, events, endpoints and messages across jSignage, the player and the cloud. Search by name or keyword, or narrow by surface, category, task, kind and context.

1427 of 1427 entries

jSignage 425

.add()

in $.<layerType>() # method jSignage In content

Adds a sublayer, element, jSignage object or an array of them to the selected layer.

Details
.add( sublayer )

The sublayer begin time can be relative to the begin of the parent layer or to the time of the call. The active interval of the parent restricts the active interval of every sublayer.

Returns jSignage layer object

$('svg').add([
  $.image({ href: 'images/1.jpg', id: 'back' }),
  $.video({ href: 'video/1.avi', id: 'media1', width: '50%', height: '50%', top: '25%', left: '25%' })
]);

Related .addTo()

.addTo()

in $.<layerType>() # method jSignage In content

Adds the selected layer to a parent, a jSignage object or an element.

Details
.addTo( parent )

sublayer.addTo(parent) is the same as parent.add(sublayer).

Returns jSignage layer object

$.textArea({ fontSize: 60 }).text('Hello').addTo('svg');

Related .add()

.animateColor()

# method jSignage In content

Animates the color of a gradient stop or of a shape's fill or stroke.

Details
.animateColor( attributesObject ) | .animateColor( target, attributesObject )

Accepts the timing attributes (begin, dur, fill, repeatCount, repeatDur) and the value attributes (accumulate, additive, by, calcMode, from, keySplines, keyTimes, to, values). Color values are interpolated in RGB space.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectAnimation timing and value attributes.
targetNumber | StringIndex of the gradient stop to animate, or the color attribute name for a shape, e.g. 'fill' or 'stroke'. Optional.

Returns jSignage Object

$.rect({ x: 0, y: 0, width: 1280, height: 720, fill: 'blue' }).animateColor( 'fill', { begin: 5, dur: 10, from: 'blue', to: 'red', repeatCount: 'indefinite' }).addTo('svg');

Related .animateOpacity(), $.svgAnimation(), values

.animateMotion()

# method jSignage In content

Moves a layer along a path given as coordinates or a $.pathData object.

Details
.animateMotion( attributesObject )

Takes the timing and value attributes plus keyPoints, path and rotate. values, from, to and by take x,y coordinate pairs; calcMode defaults to 'paced' (constant velocity).

ParameterTypeDefaultDescription
attributesObjectPlain ObjectTiming, value, keyPoints, path and rotate attributes.

Returns jSignage Object

$.media({ href: 'image.jpeg', left: 0, top: 100, width: 80, height: 100 }).animateMotion({ begin: '0', dur: 10, from: '0,0', to: '1200,0', fill: 'freeze' }).addTo('svg');

Notes Supported on SpinetiX products, but probably does not work in most browsers. On a shape it works only when the shape sits inside a jSignage layer, e.g. $.g().add( $.circle( params ) ).

Related $.svgAnimation(), values, path, keyPoints, rotate

.animateOpacity()

# method jSignage In content

Animates the opacity of a layer, a shape color or a gradient stop.

Details
.animateOpacity( attributesObject ) | .animateOpacity( target, attributesObject )

values, from, to and by take opacity values between 0 and 1.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectAnimation timing and value attributes.
targetNumber | StringIndex of the gradient stop, or the color attribute name for a shape, e.g. 'fill' or 'stroke'. Optional.

Returns jSignage Object

$.rect({ x: 0, y: 0, width: 1280, height: 720 }).animateOpacity( 'fill', { dur: 10, from: 0, to: 1, repeatCount: 'indefinite' }).addTo('svg');

Related .animateColor(), $.svgAnimation(), values

.animateRotate()

# method jSignage In content

Rotates a layer; values, from, to and by are angles in degrees.

Details
.animateRotate( attributesObject )

Takes the timing attributes and the value attributes (accumulate, additive, by, calcMode, from, keySplines, keyTimes, to, values).

ParameterTypeDefaultDescription
attributesObjectPlain ObjectAnimation timing and value attributes.

Returns jSignage Object

$.media({ href: 'media/logo.png' }).animateRotate({ from: 0, to: 360, dur: 10 }).addTo('svg');

Since Firmware 3.1.0

Related values

.animateZoom()

# method jSignage In content

Zooms a layer; from, to and values are zoom factors.

Details
.animateZoom( attributesObject )

Takes the timing attributes and from, to and values only.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectAnimation timing attributes plus from, to, values.

Returns jSignage Object

$.media({ href: 'media/logo.png' }).animateZoom({ from: 0.5, to: 1, dur: 10 }).addTo('svg');

Notes For firmware before 3.1.0 use the zoom effects (.zoomIn(), .zoomOut()) instead.

Since Release 3.1.0

Related .zoomIn(), .zoomOut(), values

.arcTo()

in $.pathData # method jSignage In content

Elliptical arc to (x, y) from radii, x-axis rotation, and the large-arc and sweep flags.

Details
.arcTo( rx, ry, rotation, largeArc, sweep, x, y )

.audioFadeIn()

# method jSignage In content

Fades the audio level from 0 (mute) to 1.

Details
.audioFadeIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('#myVideo').audioFadeIn({ dur: '2s' });

.audioFadeOut()

# method jSignage In content

Fades the audio level from 1 to 0 (mute).

Details
.audioFadeOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('#myVideo').audioFadeOut({ dur: '2s' });

.begin()

in $.<layerType>() # method jSignage In content

Starts the layer now or after a delay in seconds.

Details
.begin() | .begin( beginTime )

Triggers an installed in-effect. If the layer is already active it restarts without triggering out-effects. For interactive layers, set the begin attribute to 'indefinite' so the layer waits for this call.

Returns jSignage layer object

$.video({ href: 'video.avi', begin: 'indefinite' }).addTo('svg').begin();

.beginEvent()

in $.<layerType>() # method jSignage In content

Installs a handler that is called when the layer begins.

Details
.beginEvent( handler )

Returns jSignage layer object

$('#movie1').beginEvent(function(){ /* layer started */ });

.blink()

# method jSignage In content

Hides the layer briefly, once or repeatedly, to draw attention.

Details
.blink( [attributesObject] )

Not an entry effect, so offset is usually above 0. The layer is hidden at offset, offset+repeatInterval, offset+2*repeatInterval and so on. repeatCount can be 'indefinite'. When repeatDur is null or undefined, repeatCount controls the repeats.

ParameterTypeDefaultDescription
durNumber | String0.5sTime the layer is hidden.
offsetNumber | String0sStart time of the effect.
repeatIntervalNumber | String1sInterval between repeats.
repeatCountNumber | String1Number of blinks.
repeatDurNumber | StringHow long to repeat the effect.

Returns jSignage Object

$('#myImage').blink({ offset: 2, repeatCount: 3 });

.click()

# event jSignage In content

Handles a click on a layer.

Details
jSignageLayer.click( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').click( function() { $.info('clicked'); });

.cubeFaceIn()

# method jSignage In content

Pseudo-3D cube face rotation bringing the layer in.

Details
.cubeFaceIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Object

$('#myVideo').cubeFaceIn({ direction: 'leftToRight' });

.cubeFaceOut()

# method jSignage In content

Pseudo-3D cube face rotation taking the layer out.

Details
.cubeFaceOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Object

$('#myVideo').cubeFaceOut({ direction: 'rightToLeft' });

.curveTo()

in $.pathData # method jSignage In content

Cubic Bezier curve to (x, y) with control points (x1, y1) at the start and (x2, y2) at the end.

Details
.curveTo( x1, y1, x2, y2, x, y )

.DOMActivate()

# event jSignage In content

Handles activation of a layer.

Details
jSignageLayer.DOMActivate( callback )

Focus-sensitive layers.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.DOMFocusIn()

# event jSignage In content

Handles a layer gaining focus.

Details
jSignageLayer.DOMFocusIn( callback )

Focus-sensitive layers.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.DOMFocusOut()

# event jSignage In content

Handles a layer losing focus.

Details
jSignageLayer.DOMFocusOut( callback )

Focus-sensitive layers.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.effectIn()

# method jSignage In content

Helper to write a custom in effect: wraps the layer in a g element and calls your callback.

Details
.effectIn( callback )

The callback may be deferred until the layer is in the rendering tree. this is the wrapping g element. The callback must not change attributes of this or inner; it adds SVG animation elements under this instead. Extend jSignage.fn with the new method and return this.

ParameterTypeDefaultDescription
callbackFunctioncallback( trigger, inner, width, height, left, top, bbw, bbh ). trigger is the begin trigger of the media; inner is the next element in the effect stack; width/height is the layer size; left/top its position in the parent; bbw/bbh the parent size, all in pixels.

Returns jSignage Object

$.fn.audioFadeIn = function( args ) {
  var dur = jSignage.durInSeconds( args && args.dur, 1 );
  return this.effectIn( function( trigger ) {
    jSignage.svgAnimation( this, 'animate', { attributeName: 'audio-level', from: '0', to: '1', begin: trigger, dur: dur });
  });
};

Related .effectOut(), $.durInSeconds(), $.svgAnimation()

.effectOut()

# method jSignage In content

Helper to write a custom out effect: wraps the layer in a g element and calls your callback.

Details
.effectOut( dur, callback )

Same wrapping and callback as effectIn, but trigger marks the end of the media.

ParameterTypeDefaultDescription
durNumberDuration of the effect in seconds.
callbackFunctioncallback( trigger, inner, width, height, left, top, bbw, bbh ).

Returns jSignage Object

$.fn.audioFadeOut = function( args ) {
  var dur = jSignage.durInSeconds( args && args.dur, 1 );
  return this.effectOut( dur, function( trigger ) {
    jSignage.svgAnimation( this, 'animate', { attributeName: 'audio-level', from: '1', to: '0', begin: trigger, dur: dur });
  });
};

Related .effectIn(), $.durInSeconds()

.end()

in $.<layerType>() # method jSignage In content

Ends the layer now or after a delay in seconds.

Details
.end() | .end( endTime )

Without a parameter out-effects are not applied. To let them run, pass an endTime equal to the duration of the out-effect.

Returns jSignage layer object

$('#movie1').end();

.endEvent()

in $.<layerType>() # method jSignage In content

Installs a handler that is called when the layer ends.

Details
.endEvent( handler )

The handler is not called if .removeAfter() is set, because its callback is called instead, or if repeatDur is 'indefinite'.

Returns jSignage layer object

$('#my_media').endEvent(function(){
  $('#my_animation').end();
});

.endsWith()

in $.<layerType>() # method jSignage In content

Ends the layer when another jSignage object ends, optionally after an offset.

Details
.endsWith( jSignageObject ) | .endsWith( jSignageObject, offsetTime )

Usually used to end an indefinite parent such as a group when a child such as a video ends. This lets an out-effect run or a slideshow move to the next slide.

Returns jSignage layer object

var video = $.media({ href: 'video/1.avi' });
$.g().add([video]).endsWith(video).addTo('svg');

.fadeIn()

# method jSignage In content

Fades the layer in from the background.

Details
.fadeIn( [attributesObject] )

In effect, runs when the layer appears.

ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('image').fadeIn({ dur: '1s' });

.fadeOut()

# method jSignage In content

Fades the layer out to the background.

Details
.fadeOut( [attributesObject] )

Out effect, runs when the layer disappears.

ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('#myImage').fadeOut({ dur: '1s' });

.flyIn()

# method jSignage In content

Flies the layer in from just outside its parent layer.

Details
.flyIn( [attributesObject] )

When the parent is the top-level svg, the start is outside the screen.

ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.
accelerationNumber3Ratio from initial to final speed.

Returns jSignage Object

$('#myImage').flyIn({ dur: '1s', direction: 'leftToRight' });

.flyOut()

# method jSignage In content

Flies the layer out to just outside its parent layer.

Details
.flyOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.
accelerationNumber3Ratio from initial to final speed.

Returns jSignage Object

$('#myImage').flyOut({ dur: '1s', direction: 'rightToLeft', acceleration: 1 });

.format()

in $.DateTimeFormat() # method jSignage In content

Formats a date with the DateTimeFormat object.

Details
f.format( date )
ParameterTypeDefaultDescription
dateDateDate to format.

Returns String

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

Notes The wiki shows this method only in the examples, not in a reference section.

.format()

in $.NumberFormat() # method jSignage In content

Formats a number with the NumberFormat object.

Details
f.format( number )
ParameterTypeDefaultDescription
numberNumberNumber to format.

Returns String

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

Notes The wiki shows this method only in the examples, not in a reference section.

.hide()

in $.<layerType>() # method jSignage In content

Makes the layer invisible after applying out-effects, same as .end(longestOutEffectDuration).

Details
.hide()

No effect if the layer is already hidden.

Returns jSignage layer object

$('#back').hide();

Related .show()

.hover()

# event jSignage In content

Handles pointer hover over a layer.

Details
jSignageLayer.hover( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.keydown()

# event jSignage In content

Handles a key press; gives the key identifier and modifier flags.

Details
jSignageLayer.keydown( callback )

Focus-sensitive layers, or on $('svg'). event.keyIdentifier holds the key as U+ code (U+0041 for 'A'); modifier flags such as shiftKey are set. Does not give the resulting character; use textInput for that.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').keydown( function( event ) {
  if ( event.keyIdentifier == 'U+0050' ) media.pause();
});

Notes For a layer that includes an svg file with this code, set the layer's 'focusable' attribute to true (Elementi: Layer Properties, Advanced tab).

Related .click()

.keyup()

# event jSignage In content

Handles a key release; gives the key identifier and modifier flags.

Details
jSignageLayer.keyup( callback )

Focus-sensitive layers, or on $('svg'). Same event object as keydown.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes For a layer that includes an svg file with this code, set the layer's 'focusable' attribute to true (Elementi: Layer Properties, Advanced tab).

Related .click()

.mousedown()

# event jSignage In content

Handles mouse button press.

Details
jSignageLayer.mousedown( callback )

All layer types. evt.button is 0 for left, 1 middle, 2 right; evt.clientX and evt.clientY give the position.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').mousedown( function( evt ) { $.info( evt.button ); });

Related .click()

.mouseenter()

# event jSignage In content

Handles the pointer entering a layer.

Details
jSignageLayer.mouseenter( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.mouseleave()

# event jSignage In content

Handles the pointer leaving a layer.

Details
jSignageLayer.mouseleave( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.mousemove()

# event jSignage In content

Handles pointer movement over a layer.

Details
jSignageLayer.mousemove( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').mousemove( function( evt ) { $.info( evt.clientX ); });

Related .click()

.mouseout()

# event jSignage In content

Handles the pointer leaving a layer.

Details
jSignageLayer.mouseout( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('#box').mouseout( function() { $(this).attr('fill','green'); });

Related .click()

.mouseover()

# event jSignage In content

Handles the pointer moving over a layer.

Details
jSignageLayer.mouseover( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('#box').mouseover( function() { $(this).attr('fill','red'); });

Related .click()

.mouseup()

# event jSignage In content

Handles mouse button release.

Details
jSignageLayer.mouseup( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').mouseup( function() { $.info('up'); });

Related .click()

.mousewheel()

# event jSignage In content

Handles the mouse wheel over a layer.

Details
jSignageLayer.mousewheel( callback )

All layer types.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

Notes The wiki lists this handler by name only; its event fields come from SVG Tiny 1.2 uDOM.

Related .click()

.nudge()

# method jSignage In content

Moves or scales the layer around its rest position to draw attention.

Details
.nudge( [attributesObject] )

nudgeX and nudgeY set motion, nudgeZ sets zoom. Motion is pixels or a percentage string such as '10%' of the layer size. At least one of the three must be set, there are no defaults that apply. Not an entry effect, so offset is usually above 0. repeatCount can be 'indefinite'.

ParameterTypeDefaultDescription
offsetNumber | String0sStart time of the effect.
durNumber | String0.5sDuration of the effect.
nudgeXNumber | String0Maximum horizontal motion; positive to the right, negative to the left.
nudgeYNumber | String0Maximum vertical motion; positive down, negative up.
nudgeZString'0%'Maximum zoom in percent; positive zooms in, negative shrinks.
repeatIntervalNumber | String1sInterval between repeats.
repeatCountNumber | String1Number of repeats.
repeatDurNumber | StringHow long to repeat the effect.

Returns jSignage Object

$('#myImage').nudge({ offset: 2, repeatCount: 3, nudgeX: '-10%' });

.pageIn()

# method jSignage In content

Fades in and zooms in quickly from the background.

Details
.pageIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('svg').add( $.video({ href: 'video/1.avi', id: '#myVideo' }).pageIn() );

.pageOut()

# method jSignage In content

Fades out and zooms out quickly to the background.

Details
.pageOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.

Returns jSignage Object

$('#myVideo').pageOut();

.pivotIn()

# method jSignage In content

Pivots the layer in around a horizontal or vertical line through its center.

Details
.pivotIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
orientationString'random''random', 'horizontal' or 'vertical'.

Returns jSignage Object

$('#myVideo').pivotIn({ orientation: 'horizontal' });

.pivotOut()

# method jSignage In content

Pivots the layer out around a horizontal or vertical line through its center.

Details
.pivotOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
orientationString'random''random', 'horizontal' or 'vertical'.

Returns jSignage Object

$('#myVideo').pivotOut({ orientation: 'vertical' });

.pushData()

in $.slideshow() # method jSignage In content

Appends items to the data array of a playlist, slideshow, crawler, text ticker, media crawler or text bar.

Details
.pushData( value1, value2, ..., valueN )

Each argument is one element or an array of elements. If the layer is active, the items are appended to an internal copy of the data and lengthen the run. If it has ended or not yet started, it restarts and earlier data is lost. A layer showing nothing turns on, as with .show().

Returns jSignage Object

var pl = $.playlist({ repeatCount: 'indefinite' }).addTo('svg');
pl.pushData('new-1.jpg', 'new-2.jpg');

Related $.playlist(), $.slideshow(), $.crawler(), $.textTicker(), $.mediaCrawler(), $.textBar()

.ready()

# method jSignage In content

Runs a handler once all elements of the SVG document are loaded.

Details
jSignage( document ).ready( handler_function ) | $( handler_function )

An SVG document cannot be manipulated safely before it is ready. Elementi wraps all jSignage code in an anonymous function passed to $().

$(function(){
  $.media({ href: 'smile.jpg' }).addTo('svg');
});

Related jSignage() / $()

.removeAfter()

in $.<layerType>() # method jSignage In content

Removes the layer from the DOM after it ends, optionally after a delay and with a callback.

Details
.removeAfter() | .removeAfter( timeAfterEnd ) | .removeAfter( timeAfterEnd, callback )

Recommended after .end() or .hide() on dynamically added layers to avoid memory leaks. It stops the handler set with .endEvent() from being called; use .removeAfter(0, handler) instead. Combine with .setFillFreeze() to keep a frozen layer visible for timeAfterEnd seconds.

Returns jSignage layer object

$.textArea({ dur: 5 }).text('Hello').removeAfter().addTo('svg');

.setFillFreeze()

in $.<layerType>() # method jSignage In content

Keeps the layer visible, frozen on its last frame, after it ends.

Details
.setFillFreeze() | .setFillFreeze( freeze )

Applies when freeze is undefined or true. Out-effects still run at the end time, so the last frame may be invisible. Call it before adding the layer to the DOM tree.

Returns jSignage layer object

$.image({ href: 'a.jpg', dur: 3 }).setFillFreeze().addTo('svg');

.setInitialVisibility()

in $.<layerType>() # method jSignage In content

Keeps the layer visible, frozen on its first frame, before it begins.

Details
.setInitialVisibility() | .setInitialVisibility( freeze )

Applies when freeze is undefined or true. In-effects run at the begin time, so the first frame may be invisible. Call it before adding the layer to the DOM tree.

Returns jSignage layer object

$.image({ href: 'a.jpg', begin: 3 }).setInitialVisibility().addTo('svg');

.setVisible()

in $.<layerType>() # method jSignage In content

Shows the layer if the parameter is true, hides it otherwise.

Details
.setVisible( isVisible )

Calls .show() when isVisible evaluates to true and .hide() otherwise.

Returns jSignage layer object

$('#back').setVisible(false);

Related .show(), .hide()

.show()

in $.<layerType>() # method jSignage In content

Makes the layer visible after applying in-effects, same as .begin(0).

Details
.show()

No effect if the layer is already visible. For interactive layers set begin to 'indefinite' so the layer starts hidden. Repeated calls do not reapply the in-effect in most cases; recreate the layer instead.

Returns jSignage layer object

$.image({ id: 'back', href: 'images/1.jpg', begin: 'indefinite' }).addTo('svg');
$('#back').show();

Related .hide()

.slideIn()

# method jSignage In content

Slides the layer in, like a projector slide.

Details
.slideIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Object

$('#myVideo').slideIn({ dur: '3s', direction: 'leftToRight' });

.slideOut()

# method jSignage In content

Slides the layer out, like a projector slide.

Details
.slideOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Object

$('#myImage').slideOut({ dur: '0.5s', direction: 'bottomToTop' });

.smoothCurveTo()

in $.pathData # method jSignage In content

Cubic Bezier curve to (x, y); the first control point mirrors the previous second control point.

Details
.smoothCurveTo( x2, y2, x, y )

.smoothQuadTo()

in $.pathData # method jSignage In content

Quadratic Bezier curve to (x, y); the control point mirrors the previous one.

Details
.smoothQuadTo( x, y )

.switchPage()

in $.multiPage() # method jSignage In content

Switches a multi-page layer to a new page layer.

Details
.switchPage( layer, transition )

layer must be a jSignage layer object. transition is optional; defaultTransition is used if omitted. It has no return value, so it cannot be chained. The wiki text also writes .switch(null) for switching to an empty page.

page.switchPage($.media({ href: '2.jpg' }), $.crossFade());

.text()

in $.textArea() # method jSignage In content

Adds or replaces the content of a text area with a string or formatted text object.

Details
.text( formattedTextObject ) | .text( text )

A new line character (\n) in the text becomes a line break, as if $.tbreak() was used. Formatted text is built with $.tspan() and $.tbreak().

Returns jSignage Object

$.textArea({ fontSize: 60 }).text('Line 1\nLine 2').addTo('svg');

Related $.tspan(), $.tbreak()

.textInput()

# event jSignage In content

Handles typed text; event.data holds the resulting character.

Details
jSignageLayer.textInput( callback )

Focus-sensitive layers, or on $('svg'). Keys such as Enter or Escape do not trigger it.

ParameterTypeDefaultDescription
callbackCallbackCalled with one parameter, an object with the event details.

Returns jSignage Object

$('svg').textInput( function( event ) {
  if ( event.data == 'p' ) media.pause();
});

Notes For a layer that includes an svg file with this code, set the layer's 'focusable' attribute to true (Elementi: Layer Properties, Advanced tab).

Related .click()

.wipeIn()

# method jSignage In content

Wipes the layer in with one of the SMPTE wipe types.

Details
.wipeIn( [attributesObject] )

If no dur is given the effect lasts 1s.

ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
typeString'random'Wipe type per SMPTE 258M-1993: 'random', 'bar', 'box', 'barnDoor', 'iris'.
subTypeString'random'Wipe subtype, depends on type.

Returns jSignage Object

$('#myImage').wipeIn({ dur: '2s', type: 'barnDoor', subType: 'horizontal' });

.wipeOut()

# method jSignage In content

Wipes the layer out with one of the SMPTE wipe types.

Details
.wipeOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
typeString'random'Wipe type per SMPTE 258M-1993: 'random', 'bar', 'box', 'barnDoor', 'iris'.
subTypeString'random'Wipe subtype, depends on type.

Returns jSignage Object

$('#myImage').wipeOut({ dur: '1s', type: 'bar', subType: 'leftToRight' });

.zoomIn()

# method jSignage In content

Zooms in from a smaller size while fading in from the background.

Details
.zoomIn( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
factorString'20%'Zoom factor.

Returns jSignage Object

$('#myVideo').zoomIn();

Related .animateZoom()

.zoomOut()

# method jSignage In content

Zooms to a larger size while fading out to the background.

Details
.zoomOut( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Effect duration.
factorString'20%'Zoom factor.

Returns jSignage Object

$('#myVideo').zoomOut();

Related .animateZoom()

$._createElement()

# function jSignage In content

Creates an SVG element with createElementNS and sets the given attributes.

Details
$._createElement( name, attributes )
ParameterTypeDefaultDescription
nameStringSVG element name.
attributesPlain ObjectAttributes to set.

Returns SVG Element

var elem = $._createElement( 'animate', { attributeName: 'opacity', from: 0, to: 1, dur: 10, begin: 0 } );

Notes Returns a DOM object, unlike $.createElement() of the jQuery port, which returns a jSignage Object.

$.<layerType>()

# constructor jSignage In content

Creates a layer of the given type from an attributes object. Layers are the building blocks of a jSignage document.

Details
$.<layerType>( { id: 'id', ... } )

layerType is media, textArea, playlist, carousel and so on. A layer is a rectangular region where content is shown during its active interval, 0s to forever by default. Z-order follows the order of elements in the document and cannot be changed. Calling the constructor on a placeholder element replaces it.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus attributes of the layer type.

Returns jSignage layer object

$.media({ id: 'movie1', width: 1280, height: 720, href: 'clip.avi' }).addTo('svg');

Related Common layer attributes

$.ajax()

# function jSignage In content

Low-level HTTP request with full control; only GET and POST are supported.

Details
$.ajax( url, [settings] )

The SVG Tiny 1.2 uDOM supports only the GET and POST methods. Posting JSON-RPC to the player's /rpc endpoint can set a Shared Variable.

ParameterTypeDefaultDescription
urlStringRequest URL.
settingsPlain ObjectRequest settings as in jQuery. Optional.
$.ajax({ type: 'POST', url: 'http://HMP_address/rpc', contentType: 'application/json', data: JSON.stringify({ method: 'webstorage_set', params: [[ { name: 'var1', value: 'Hello' } ]], id: 1 }) });

$.animation()

in $.media() # constructor jSignage In content

Animation layer that shows an SVG or SMIL document.

Details
$.animation( { href, ... } )
ParameterTypeDefaultDescription
attributesObjectPlain Objecthref plus common layer attributes and media attributes.

Returns jSignage layer object

$.animation({ href: 'anim.svg' }).addTo('svg');

$.audio()

in $.media() # constructor jSignage In content

Audio-only layer. It is not visible.

Details
$.audio( { href, ... } )
ParameterTypeDefaultDescription
attributesObjectPlain Objecthref plus common layer attributes, for example audioLevel.

Returns jSignage layer object

$.audio({ href: 'music.mp3', audioLevel: 0.5 }).addTo('svg');

$.carousel()

# constructor jSignage In content

Slideshow extension that shows several items at once and lets the viewer drag between them.

Details
$.carousel( { data, renderToSVG, numVisible, type, ... } )

Usually shows previews of the items before and after the selected one. Can replace a table for scrollable menus.

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata and renderToSVG are required.

Returns jSignage layer object

$.carousel({ data: ['1.jpg', '2.jpg', '3.jpg', '4.jpg'], numVisible: 3, renderToSVG: function() { return $.image({ href: this }); } }).addTo('svg');

Related $.slideshow(), .next(), .previous(), .auto()

$.circle()

# constructor jSignage In content

Draws a circle from a center point and a radius.

Details
$.circle( attributes )

Returns jSignage object

$.circle({ cx: 640, cy: 360, r: 200, fill: 'none', stroke: 'red', strokeWidth: 20 }).addTo('svg');

Related Shape fill and stroke attributes

$.clearInterval()

# function jSignage In content

Cancels a timer created with $.setInterval() or $.setIntervalSync().

Details
$.clearInterval( timer )
ParameterTypeDefaultDescription
timerTimer ObjectHandler returned by $.setInterval().

Returns Undefined

Notes The wiki describes it for $.setInterval(); $.setIntervalSync() says its handle can be canceled the same way.

Related $.setInterval()

$.clearTimeout()

# function jSignage In content

Cancels a timer created with $.setTimeout().

Details
$.clearTimeout( timer )
ParameterTypeDefaultDescription
timerTimer ObjectHandler returned by $.setTimeout().

Returns Undefined

$.clearTimeout( timer );

Related $.setTimeout()

$.crawler()

# constructor jSignage In content

Scrolls layers of any type across the screen, horizontally or vertically.

Details
$.crawler( { data, renderToSVG, direction, speed, smooth, spacing, ... } )

Horizontal crawlers normalise layer height to one line; vertical crawlers normalise width. Layers added must have absolute pixel width and height; a $.textArea needs only height (horizontal) or width (vertical). Supports .pushData(). $.textTicker() and $.mediaCrawler() specialise it.

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata and renderToSVG are required.

Returns jSignage layer object

$.crawler({ data: ['A', 'B'], height: 100, repeatCount: 'indefinite', renderToSVG: function() { return $.textArea({ height: 100, fontSize: 'max' }).text(this); } }).addTo('svg');

Related $.textTicker(), $.mediaCrawler(), .pushData()

$.crossFade()

# constructor jSignage In content

Cross-fades: the new slide fades in over the previous one as it starts.

Details
$.crossFade( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'1s'Duration of the transition effect.

Returns jSignage Transition Object

$.playlist({ data: ['A.jpg', 'B.jpg', 'C.jpg', 'D.jpg'], defaultTransition: $.crossFade() }).addTo('svg');

Related jSignage Transition Object, dur

$.cubeFace()

# constructor jSignage In content

Pseudo-3D cube rotation from the current slide to the new one.

Details
$.cubeFace( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Duration of the transition effect.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Transition Object

$.cubeFace({ dur: '1s', direction: 'leftToRight' });

Related jSignage Transition Object, dur

$.DateTimeFormat()

# constructor jSignage In content

Class for locale-aware date and time formatting; create it, then call .format( date ).

Details
new $.DateTimeFormat( format [, locale] )
ParameterTypeDefaultDescription
formatNumber | StringPredefined format such as $.DateTimeFormat.Format.FULL_DATETIME, or a pattern like 'EEEE, MMMM d, y'.
localeStringLocale tag. Default: the default locale.

Returns Function

$.setLocale( 'es_ES' );
var f = new $.DateTimeFormat( $.DateTimeFormat.Format.LONG_DATE );
var str = f.format( new Date() );   // "24 de abril de 2013"

Related .format(), FULL_DATE, LONG_DATE, MEDIUM_DATE, SHORT_DATE, FULL_TIME, LONG_TIME, MEDIUM_TIME, SHORT_TIME, *_DATETIME, Date format pattern letters, $.setLocale()

$.debug()

# function jSignage In content

Adds a log entry at debug level.

Details
$.debug( text )
ParameterTypeDefaultDescription
textStringLog text.
$.debug( 'message' );

Since jSignage 1.3.0

$.decodeURIQueryString()

# function jSignage In content

Parses a URI and returns an object with its query-string pairs.

Details
$.decodeURIQueryString( queryString [, qs_only] )
ParameterTypeDefaultDescription
queryStringStringURI or query string of key=value pairs separated by &.
qs_onlyBooleanIf missing or false, only the query part is processed: text before ? and after # is removed. Optional.

Returns Plain Object

var uri = document.documentURI;
var jsonParams = $.extend( $.parseJSON($('#jsonParams').text()), $.decodeURIQueryString( uri ) );

$.durInSeconds()

# function jSignage In content

Parses a time value and returns seconds, or the default if the value is missing or malformed.

Details
$.durInSeconds( time [, defaultTime] )
ParameterTypeDefaultDescription
timeNumber | StringTime value with or without unit suffix (h, min, ms).
defaultTimeNumber0Value used if parsing fails.

Returns Number

var dur = $.durInSeconds( args && args.dur, 1 );

$.ellipse()

# constructor jSignage In content

Draws an ellipse from a center point and two radii.

Details
$.ellipse( attributes )

Returns jSignage object

$.ellipse({ cx: 640, cy: 360, rx: 400, ry: 200, fill: 'none', stroke: 'red', strokeWidth: 20 }).addTo('svg');

Related Shape fill and stroke attributes

$.error()

# function jSignage In content

Throws a JavaScript error with the given text.

Details
$.error( text )
ParameterTypeDefaultDescription
textStringError text.
$.error( 'bad config' );

$.extend()

# function jSignage In content

Port of jQuery.extend: merges objects into the first one.

Details
$.extend( target [, object1 ] [, objectN ] ) | $.extend( [deep,] target, object1 [, objectN ] ) | $.extend( object1 )

With one argument the jSignage object itself is the target, which adds new functions to the jSignage namespace; useful for plugin authors.

Returns Plain Object (jSignage Object with a single argument)

var settings = $.extend( {}, defaults, options );

$.fade()

# constructor jSignage In content

Fades out the current slide, then fades in the next from the background.

Details
$.fade( [attributesObject] )

dur is the length of each fade, so the full transition lasts twice dur.

ParameterTypeDefaultDescription
durNumber | String'1s'Duration of the transition effect.
colorStringnullFade color; null is transparent (fade to the background).

Returns jSignage Transition Object

$.fade({ dur: '1s', color: 'black' });

Related jSignage Transition Object, dur

$.fitTextArea()

# constructor jSignage In content

Text area that picks the largest font size at which all the text is visible.

Details
$.fitTextArea( { factors, fontSize, ... } )

Suited to text from an external source such as a news feed, whose length is not known in advance. Relative sizes between $.tspan() parts are kept. With fontSize: 'max' the text is as large as possible; with a number that is the upper limit.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectText layer attributes plus factors.

Returns jSignage layer object

$.fitTextArea({ fontSize: 'max' }).text('Fit this text.').addTo('svg');

Related $.textArea()

$.flip()

# constructor jSignage In content

Flips the current slide over to the new one.

Details
$.flip( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Duration of the transition effect.
orientationString'random'Pivot axis: 'random', 'horizontal' or 'vertical'.

Returns jSignage Transition Object

$.flip({ dur: '1s', orientation: 'horizontal' });

Related jSignage Transition Object, dur

$.g()

# constructor jSignage In content

Group layer. Invisible container that sets position and timing for the layers inside it.

Details
$.g( { ... } )

Has no specific attributes or functions. Add sublayers with .add(), or call .addTo() on a sublayer. Effects applied to the group affect all its layers together. The active interval of the group limits that of its sublayers. Use .endsWith() to end a group with a child.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes.

Returns jSignage layer object

var myGroup = $.g({ width: '80%', height: '80%', top: '10%', left: '10%' }).addTo('svg');
$.media({ href: 'media/SpinetiX.jpg' }).addTo(myGroup);

Related .endsWith(), .add()

$.get()

# function jSignage In content

Loads data from the server with an HTTP GET request.

Details
$.get( url, [data], success( data, textStatus ), [dataType] )
ParameterTypeDefaultDescription
urlStringRequest URL.
dataPlain Object | StringData sent with the request. Optional.
successCallbackCalled with the response data and textStatus.
dataTypeStringExpected response type. Optional.
$.get( 'feed.rss', function( data ) { var news = $.parseRSS( data ); }, 'text' );

Notes Set dataType to 'text' for feeds, otherwise auto-detection may parse the response as XML. A JSON mime type is parsed automatically unless dataType is 'text'. Browsers may block cross-domain requests; players and Elementi do not.

$.getAndParseFeed()

# function jSignage In content

Loads data with an HTTP GET request, then parses the feed data.

Details
$.getAndParseFeed( dataSourceObject, callback, useGetURL )
ParameterTypeDefaultDescription
dataSourceObjectPlain ObjectDescription of the data source.
callbackCallbackCalled with the parsed data.
useGetURLBooleanUse getURL() for the request.

Notes The wiki gives only the signature and one line of description; the dataSourceObject fields are not documented on the Ajax page.

$.getCurrentTime()

# function jSignage In content

Gets the current document time in seconds.

Details
$.getCurrentTime()

Returns Number

var t = $.getCurrentTime();

$.getDocumentViewbox()

# function jSignage In content

Gets the document viewBox as an object with x, y, width and height.

Details
$.getDocumentViewbox()

Returns Plain Object

var vb = $.getDocumentViewbox();

$.getG2()

# function jSignage In content

Returns the inner element that holds the content of a layer drawn with frame decoration.

Details
$.getG2( realMediaTarget )

With frame decoration the real media target is always a <g>, and the content sits one level deeper in a direct child (G2). Always returns the right element, including the target itself.

Related $.getRealMediaTarget(), frame

$.getJSON()

# function jSignage In content

Loads JSON data from the server with an HTTP GET request.

Details
$.getJSON( url, [data], success( data, textStatus ) )
ParameterTypeDefaultDescription
urlStringRequest URL.
dataPlain Object | StringData sent with the request. Optional.
successCallbackCalled with the parsed response and textStatus.
$.getJSON( 'http://Path_to_File_Location/db.php', { table: 'prices', type: 'coffee', subtype: 'latte' }, function( response ) {
  $('#price').clearText().tspan( response.price );
});

$.getLocale()

# function jSignage In content

Gets the default locale tag.

Details
$.getLocale()

Returns String

var tag = $.getLocale();

$.getRealMediaTarget()

# function jSignage In content

Returns the element that carries the layer content, below any effect wrapper elements.

Details
$.getRealMediaTarget( element )

Returns the element itself when no effect is applied, so it is always safe to call. The target is an <image>, <video>, <audio>, <animation>, <textArea> or, most often, a <g> with a spx:layer-type attribute.

Related $.isLayer(), $.getTimingElement(), $.getG2()

$.getTimingElement()

# function jSignage In content

Returns the SMIL element whose active interval defines the active interval of a layer.

Details
$.getTimingElement( realMediaTarget )

For audio, video and animation layers it is the real media target itself. For image, textArea and g layers it is the first child, a <set> or <animate> element. Always returns the right element, including the target itself.

Related $.getRealMediaTarget()

$.guessCannedSlidesDur()

# function jSignage In content

Computes the total duration of a playlist or slideshow.

Details
$.guessCannedSlidesDur( canned [, defaultDur] )
ParameterTypeDefaultDescription
cannedPlain Object | ArrayJSON-parsed description of the playlist content.
defaultDurBooleanDuration to use as default. Optional.

Returns Number | String

Notes The wiki types defaultDur as Boolean, which looks like a typo for a duration.

$.guessSlideDur()

# function jSignage In content

Returns a layer's duration in seconds, 'media' or 'indefinite'.

Details
$.guessSlideDur( ctor, args [, defaultDur] )
ParameterTypeDefaultDescription
ctorStringConstructor type of the layer.
argsPlain ObjectJSON-parsed layer arguments.
defaultDurBooleanDuration to use as default. Optional.

Returns Number | String

Notes The wiki types defaultDur as Boolean, which looks like a typo for a duration.

$.headlineTextArea()

# constructor jSignage In content

Single-line text area that sets font size and transform so the text fills the height and is fully visible.

Details
$.headlineTextArea( { scaleMethod, ... } )

Suited to single-line text of unknown length, such as a news headline. Accepts text layer attributes except vertical alignment.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectText layer attributes plus scaleMethod.

Returns jSignage layer object

$.headlineTextArea({ scaleMethod: 'uniform' }).text('Fit this text.').addTo('svg');

Related $.textArea()

$.image()

in $.media() # constructor jSignage In content

Image layer for static content, bitmap or vector graphics.

Details
$.image( { href, ... } )

An image can also be given as a base64 data URI, such as 'data:image/png;base64,...'.

ParameterTypeDefaultDescription
attributesObjectPlain Objecthref plus common layer attributes and media attributes.

Returns jSignage layer object

$.image({ href: 'portrait.jpg', frame: { frameColor: 'white' }, layerFit: 'both', width: '50%', height: '50%' }).addTo('svg');

$.info()

# function jSignage In content

Adds a log entry at info level.

Details
$.info( text )
ParameterTypeDefaultDescription
textStringLog text.
$.info( 'message' );

Since jSignage 1.3.0

$.line()

# constructor jSignage In content

Draws a line segment between two points. It needs a stroke to be visible.

Details
$.line( attributes )

A line has no interior, so it is never filled.

Returns jSignage object

$.line({ x1: 640, y1: 0, x2: 640, y2: 720, stroke: 'red', strokeWidth: 5 }).addTo('svg');

Related Shape fill and stroke attributes

$.linearGradient()

# constructor jSignage In content

Creates a linear gradient of colors and opacities along a vector, to use as a paint through .ref().

Details
$.linearGradient( attributes )

Not rendered itself. Add it to the document, then pass gradient.ref() to fill, stroke, backColor, frameColor and similar attributes. Its stops can be animated with animateColor and animateOpacity using the stop index as first argument.

Returns jSignage object

var grad = $.linearGradient({ x1: 320, y1: 0, x2: 960, y2: 0, stops: [{ offset: 0, color: 'blue' }, { offset: 1, color: 'red' }] }).addTo('svg');
$.rect({ x: 320, y: 180, width: 640, height: 360, fill: grad.ref() }).addTo('svg');

Notes Use at least two stops; no stops behaves like color 'none', one stop gives a solid color. Stop offsets must not decrease; repeat an offset for a hard edge.

$.media()

# constructor jSignage In content

Media layer that picks the right layer type (audio, video, image, animation) from the URI. Preferred for media.

Details
$.media( { href, ... } )

Shows external content from a URI, a local file such as 'media/img.png' or a resource on a remote web server. By default media such as video plays once; use repeatDur: 'indefinite' to loop. Frame decoration has settings that apply to media layers only.

ParameterTypeDefaultDescription
attributesObjectPlain Objecthref plus common layer attributes and media attributes.

Returns jSignage layer object

$.media({ href: 'images/1.jpg', dur: 5 }).addTo('svg');

Related $.video(), $.image(), $.audio(), $.animation()

$.mediaCrawler()

# constructor jSignage In content

Crawler that scrolls media layers, one per data item.

Details
$.mediaCrawler( { data, renderToURI, mediaWidth, mediaHeight, direction, speed, smooth, spacing, ... } )

data is an array of URI strings, or of items if renderToURI is given. Use repeatCount to set how many times all items show; 'indefinite' loops forever. Frame decoration can add a background. Supports .pushData().

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata is required.

Returns jSignage layer object

$.mediaCrawler({ data: ['1.jpg', '2.jpg', '3.jpg'], height: 160, repeatCount: 'indefinite' }).addTo('svg');

Related $.crawler(), .pushData()

$.multiPage()

# constructor jSignage In content

Area that shows one layer at a time, like the pages of a book; the program switches pages.

Details
$.multiPage( { defaultTransition, pageEnded, ... } )

Initially empty: call .switchPage() at least once to show something. Page changes are driven by code or event handlers, not by data as in a slideshow.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus multi-page attributes.

Returns jSignage layer object

var page = $.multiPage({}).addTo('svg');
page.switchPage($.media({ href: '1.jpg' }));

Related .switchPage()

$.NumberFormat()

# constructor jSignage In content

Class for locale-aware number and currency formatting; create it, then call .format( number ).

Details
new $.NumberFormat( format [, locale] )
ParameterTypeDefaultDescription
formatNumber | StringPredefined format such as $.NumberFormat.Format.DECIMAL, or a pattern like '#.#####'.
localeStringLocale tag. Default: the default locale.

Returns Function

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

Related .format(), DECIMAL, SCIENTIFIC, PERCENT, CURRENCY, Number format pattern characters

$.page()

# constructor jSignage In content

Brings the new slide in with a page-in effect while the previous slide fades out quickly.

Details
$.page( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.375s'Duration of the transition effect.

Returns jSignage Transition Object

$.page({ dur: '0.5s' });

Related jSignage Transition Object, dur

$.parseCSV()

# function jSignage In content

Parses CSV text into an array of row objects keyed by column name.

Details
$.parseCSV( text [, separator, columns, keepNSWSP, keepQuotes] )

By default column names come from the first row, which is then discarded.

ParameterTypeDefaultDescription
textStringCSV content.
separatorString','Column separator character.
columnsArrayColumn names; if given, the first row is treated as data.
keepNSWSPBooleanfalseKeep leading and trailing whitespace of unquoted columns.
keepQuotesBooleanfalseDo not treat double quotes as special.

Returns Array of objects

var rows = $.parseCSV( text, ';' );

$.parseICAL()

# function jSignage In content

Parses iCalendar text into the events that start in a period, recurring ones included.

Details
$.parseICAL( text, start, end [, maxItems, format] )

Each item has title, description, startDate, endDate, enclosure (event URL), location. The array is sorted by start date.

ParameterTypeDefaultDescription
textStringiCalendar file content.
startDate | NumberPeriod start, Date or ms since 1970 UTC.
endDate | NumberPeriod end, Date or ms since 1970 UTC.
maxItemsNumber100Maximum items returned.
formatStringstrftime format for dates as strings; Date objects by default.

Returns Array of objects

$.get( 'calendar.ics', function( data ) {
  var now = new Date();
  var schedule = $.parseICAL( data, now.getTime(), now.getTime()+1, 1 );
  if ( schedule.length > 0 ) $.media({ href: schedule[0].enclosure, repeatCount: 'indefinite' }).addTo('svg');
}, 'text' );

$.parseJSON()

# function jSignage In content

Parses JSON text into an object or array.

Details
$.parseJSON( text )
ParameterTypeDefaultDescription
textStringJSON text.

Returns Object | Array

var item = $.parseJSON('{ "label": "ultimate gadget", "price": 19.99 }');

Notes A malformed string does not throw. $.get() and $.post() parse JSON automatically when the server sends a JSON mime type, unless dataType is 'text'.

$.parseRSS()

# function jSignage In content

Parses RSS text into an array of item objects.

Details
$.parseRSS( text [, baseURI, channel, multilineTitle] )

Each item has title, description, enclosure, pubDate (Date object), channel, channelTitle, channelDescription, image. title and description are plain text: HTML tags are stripped and entities converted. enclosure is the url of the first enclosure or media:content, or the src of the first img in the description.

ParameterTypeDefaultDescription
textStringRSS feed content.
baseURIStringBase for relative links; links stay relative by default.
channelStringSelect one channel by its link value; all channels by default.
multilineTitleBooleanAllow multi-line titles; only the first line by default.

Returns Array of objects

$.get( uri, function( rssFeed ) {
  var rss = $.parseRSS( rssFeed );
  $.textTicker({ data: rss, renderToText: function() { return this.title; }, repeatCount: 'indefinite' }).addTo('svg');
}, 'text' );

$.parseTXT()

# function jSignage In content

Splits multi-line text into an array of lines.

Details
$.parseTXT( text )
ParameterTypeDefaultDescription
textStringMulti-line text.

Returns Array of strings

var lines = $.parseTXT( content );

$.parseXML()

# function jSignage In content

Parses an XML string into a DOM document, or null if the XML is invalid.

Details
$.parseXML( text )

The top-level element is the documentElement property.

ParameterTypeDefaultDescription
textStringXML code.

Returns Document or null

var doc = $.parseXML( '<top><child/></top>' );
var top = doc.documentElement.localName;

$.path()

# constructor jSignage In content

Draws the outline of a shape from SVG path data; it can be filled or stroked.

Details
$.path( attributes )

Returns jSignage object

$.path({ fill: 'red', stroke: 'blue', strokeWidth: 3, d: new $.pathData().moveTo(100, 100).lineTo(300, 100).lineTo(200, 300).close() }).addTo('svg');

Related Shape fill and stroke attributes

$.pathData

in $.path() # constructor jSignage In content

Builds path data for the d attribute of $.path() with readable chained methods.

Details
new $.pathData()

Every method returns the object, so calls can be chained.

Returns pathData object

var d = new $.pathData().moveTo(100, 100).lineTo(300, 100).lineTo(200, 300).close();

$.pingPongTextArea()

# constructor jSignage In content

Text area that scrolls back and forth when the text does not fit.

Details
$.pingPongTextArea( { direction, speed, backSpeed, smooth, delay, backDelay, scrollBack, ... } )

Accepts text layer attributes plus the specific attributes listed as its children.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectText layer attributes plus ping-pong attributes.

Returns jSignage layer object

$.pingPongTextArea({ fontSize: 'max', speed: 50, scrollBack: true }).text('<--- OK --->').addTo('svg');

Related $.textArea()

$.playlist()

# constructor jSignage In content

Sequence of media files (images, video, animation) shown one after the other.

Details
$.playlist( { data, defaultDur, defaultTransition, ... } )

Without an explicit duration a file plays for its media duration; images use defaultDur. The playlist loops with repeatCount or repeatDur set to 'indefinite'. Supports .pushData().

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus playlist attributes.

Returns jSignage layer object

$.playlist({ data: ['smile.jpg', 'frown.jpg', 'grin.jpg'], defaultDur: '10s', repeatCount: 'indefinite' }).addTo('svg');

Related $.slideshow(), .pushData()

$.polygon()

# constructor jSignage In content

Draws a closed shape from connected straight segments.

Details
$.polygon( attributes )

For open shapes use $.polyline(). The wiki page writes the call as jSignage.polygon( attributesObject ).

Returns jSignage object

$.polygon({ fill: 'lime', stroke: 'red', strokeWidth: 5, points: ['850, 75', '958, 137.5', '958, 262.5', '850, 325', '742, 262.5', '742, 137.5'] }).addTo('svg');

Related Shape fill and stroke attributes

$.polyline()

# constructor jSignage In content

Draws connected straight segments, typically an open shape.

Details
$.polyline( attributes )

For closed shapes use $.polygon().

Returns jSignage object

$.polyline({ fill: 'none', stroke: 'blue', strokeWidth: 5, points: ['50, 375', '150, 375', '150, 325', '250, 325'] }).addTo('svg');

Related Shape fill and stroke attributes

$.popup()

# constructor jSignage In content

Shows a layer centred over a dimmed viewport, to get the viewer's attention.

Details
$.popup( layer, { dimming, popupDur, popoutDur } )

Only the width and height of the layer are used for geometry; the layer is centred. The dimming background is removed when the popup ends. The popup group is added to the top-level svg element. Common layer functions apply.

ParameterTypeDefaultDescription
layerjSignage ObjectLayer to display on top of the viewport.
attributesObjectPlain ObjectOptional: dimming, popupDur, popoutDur.

Returns jSignage Object

$.popup($.textArea({ width: 400, height: 100, fontSize: 40, frame: { backColor: 'white' } }).text('Are you sure?'), { dimming: '70%' }).addTo('svg');

$.post()

# function jSignage In content

Loads data from the server with an HTTP POST request.

Details
$.post( url, [data], success( data, textStatus ), [dataType] )
ParameterTypeDefaultDescription
urlStringRequest URL.
dataPlain Object | StringData sent with the request. Optional.
successCallbackCalled with the response data and textStatus.
dataTypeStringExpected response type. Optional.
$.post( 'http://server/api', { id: 1 }, function( data ) { $.info( data ); }, 'text' );

$.progressBar()

# constructor jSignage In content

Rectangle that fills from left to right to show progress.

Details
$.progressBar( { style, color, ... } )

The interior can be a solid colour, a smooth gradient from the fill colour to the border colour, or a stripe pattern alternating the two.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus style and color.

Returns jSignage layer object

var bar = $.progressBar({ width: 400, height: 40 }).addTo('svg');
bar.setProgress(50);

Related .setProgress()

$.progressWheel()

# constructor jSignage In content

Rotating wheel pattern that tells the viewer an asynchronous process is running.

Details
$.progressWheel( { style, color, barCount, ... } )

Has no specific functions. The advanced attributes customise the bars beyond the three styles.

ParameterTypeDefaultDescription
paramsPlain ObjectCommon layer attributes plus wheel attributes.

Returns jSignage layer object

$.progressWheel({ width: 100, height: 100, color: 'white', barCount: 12 }).addTo('svg');

$.push()

# constructor jSignage In content

Flies the new slide in while the previous one flies out, like a slide projector.

Details
$.push( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Duration of the transition effect.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Transition Object

$.push({ dur: '1s', direction: 'leftToRight' });

Related jSignage Transition Object, dur

$.pushButton()

# constructor jSignage In content

Button frame with a text label or a custom layer inside. Meant for quick prototypes.

Details
$.pushButton( attributesObject ) | $.pushButton( attributesObject, text ) | $.pushButton( attributesObject, layer )

Built on $.g() with a UI-type background frame. Production projects normally use project-specific PNG images instead. It has no specific functions; attach a .click() handler. If no inner content is passed, add a layer later with .add().

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus style, color, direction.
textStringOptional plain-text label.
layerjSignage ObjectOptional layer shown on the button.

Returns jSignage Object

$.pushButton({ left: 100, top: 100, width: 200, height: 60 }, 'More').click(function(){ /* handler */ }).addTo('svg');

$.radialGradient()

# constructor jSignage In content

Creates a radial gradient of colors and opacities from a center outwards, to use as a paint through .ref().

Details
$.radialGradient( attributes )

Offset 0 is the center (cx, cy) and offset 1 the outer ring at radius r. Add it to the document, then pass gradient.ref() to fill, stroke, backColor or frameColor.

Returns jSignage object

var grad = $.radialGradient({ cx: 640, cy: 40, r: 360, stops: [{ offset: 0, color: '#ffffff' }, { offset: 0.25, color: '#ffffff' }, { offset: 1, color: '#ff0000' }] }).addTo('svg');
$.rect({ x: 460, y: 180, width: 360, height: 360, rx: 75, fill: grad.ref() }).addTo('svg');

Notes No stops behaves like color 'none'; one stop gives a solid color. Stop offsets must not decrease; repeat an offset for a hard edge.

$.random()

# constructor jSignage In content

Picks a transition at random.

Details
$.random( [attributesObject] )

Arguments are passed to the chosen transition, so do not use transition-specific ones: their random defaults give a random variant.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectOptional; only dur.

Returns jSignage Transition Object

$.random({ dur: '1s' });

Related jSignage Transition Object, dur

$.randomChoice()

# function jSignage In content

Returns one randomly selected item of an array.

Details
$.randomChoice( array )
ParameterTypeDefaultDescription
arrayArraySource array.
var pick = $.randomChoice([ 'A.jpg', 'B.jpg', 'C.jpg' ]);

$.rect()

# constructor jSignage In content

Draws a rectangle, with optional rounded corners.

Details
$.rect( attributes )

The wiki page writes the call as jSignage.rect( attributesObject ).

Returns jSignage object

$.rect({ x: 320, y: 180, width: 640, height: 360, rx: 100, stroke: 'red', strokeWidth: 50 }).addTo('svg');

Related Shape fill and stroke attributes

$.scrollingTextArea()

# constructor jSignage In content

Text area that scrolls vertically, line by line or page by page, when the text has more lines than fit.

Details
$.scrollingTextArea( { lines, lineDur, pageDur, scrollDur, ... } )

By default the text shows once, for lines x lineDur + (totalLines - lines) x (scrollDur + lineDur) seconds. To jump back to the top and repeat, set repeatDur or repeatCount.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectText layer attributes plus scrolling attributes.

Returns jSignage layer object

$.scrollingTextArea({ lines: 2, repeatCount: 'indefinite', top: '80%', height: '20%' }).text('Line one\nLine two\nLine three').addTo('svg');

Related $.textArea()

$.setAttributes()

# function jSignage In content

Sets the given attributes on an SVG element.

Details
$.setAttributes( element, attributes )
ParameterTypeDefaultDescription
elementSVG ElementElement to modify.
attributesPlain ObjectAttributes to set.

Returns Undefined

$.setGetURLFlags()

# function jSignage In content

Sets the global caching flags for HTTP GET requests.

Details
$.setGetURLFlags( flags )

GETURL_CACHE_CONTENT saves the resource in the player cache. GETURL_TRACK_CHANGES detects server changes and calls back. GETURL_ALWAYS_CHECK (3.0.1+) forces a check on every request. The first two together are the recommended value.

ParameterTypeDefaultDescription
flagsNumberCombination of GETURL_CACHE_CONTENT, GETURL_TRACK_CHANGES, GETURL_ALWAYS_CHECK.
$.setGetURLFlags( GETURL_CACHE_CONTENT|GETURL_TRACK_CHANGES );

$.setInterval()

# function jSignage In content

Runs a callback repeatedly with a fixed delay between calls.

Details
$.setInterval( callback, ms )
ParameterTypeDefaultDescription
callbackCallbackFunction to run repeatedly.
msNumberPositive delay between calls, in milliseconds.

Returns Timer Object

var timer = $.setInterval( function() { $.info('tick'); }, 1000 );

Related $.clearInterval(), $.setIntervalSync()

$.setIntervalSync()

# function jSignage In content

Like $.setInterval(), but the first call comes early so timers with the same delay stay in step.

Details
$.setIntervalSync( callback, ms )

The first call happens after a delay most probably shorter than ms, to synchronize multiple timers that share the same delay.

ParameterTypeDefaultDescription
callbackCallbackFunction to run repeatedly.
msNumberPositive delay between calls, in milliseconds.

Returns Timer Object

Since Firmware 3.0.6

Related $.setInterval()

$.setLocale()

# function jSignage In content

Sets the default locale and returns the previous one.

Details
$.setLocale( locale )
ParameterTypeDefaultDescription
localeStringLocale tag, e.g. 'es_ES'.

Returns String

$.setLocale( 'es_ES' );

$.setTimeout()

# function jSignage In content

Runs a callback once after a delay.

Details
$.setTimeout( callback, ms )
ParameterTypeDefaultDescription
callbackCallbackFunction to run after ms.
msNumber0Delay in milliseconds.

Returns Timer Object

var timer = $.setTimeout( function() { $.info('done'); }, 5000 );

Related $.clearTimeout()

$.shuffle()

# function jSignage In content

Returns an array of items selected randomly from the input array.

Details
$.shuffle( array [, limit] )
ParameterTypeDefaultDescription
arrayArraySource array.
limitNumberMaximum number of items in the result. Optional.

Returns Array

var items = $.shuffle([ 'A.jpg', 'B.jpg', 'C.jpg', 'D.jpg' ]);
$.playlist({ data: items, repeatDur: 'indefinite' }).addTo('svg');

$.slide()

# constructor jSignage In content

Slides the new slide in over the previous, frozen slide.

Details
$.slide( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'0.5s'Duration of the transition effect.
directionString'random''random', 'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'.

Returns jSignage Transition Object

$.slide({ dur: '1s', direction: 'leftToRight' });

Related jSignage Transition Object, dur

$.slideshow()

# constructor jSignage In content

Shows slides one after the other; the layout of each slide is built by your renderToSVG callback.

Details
$.slideshow( { data, renderToSVG, defaultSlideDur, defaultTransition, ... } )

Unlike a playlist, where each item is one media layer, a slide can hold any layers. Loops with repeatCount or repeatDur 'indefinite'. Supports .pushData().

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata and renderToSVG are required.

Returns jSignage Object

$.slideshow({ data: rss, defaultSlideDur: 3, renderToSVG: function() { return $.textArea().text(this.title); } }).addTo('svg');

Related $.playlist(), .pushData()

$.solidColor()

# constructor jSignage In content

Creates a solid color element to reference later through .ref() in fill, stroke, backColor or frameColor.

Details
$.solidColor( color, opacity )

It must be added to the document to be referenced, anywhere. Color and opacity can be animated with animateColor and animateOpacity.

ParameterTypeDefaultDescription
colorColorblackThe color.
opacitynumber1Opacity from 0.0 to 1.0.

Returns jSignage object

var bColor = $.solidColor('red', 0.5).addTo('svg');
$.textArea({ width: '90%', height: '15%', top: '75%', left: '5%', fontSize: 32, frame: { backColor: bColor.ref() } }).text('Red background !').addTo('svg');

$.svgAnimation()

# function jSignage In content

Adds an SVG animation element to a target element; uses SMIL when the player supports it.

Details
$.svgAnimation( target, name, attributesObject ) | $.svgAnimation( target, name, attributesObject, endCallback )

name is one of animate, animateTransform, animateColor, animateMotion. attributesObject holds id, attributeName, timing and value attributes and type-specific ones (type for animateTransform; path, keyPoints, rotate for animateMotion). Use string notation for keyTimes, keySplines and values.

ParameterTypeDefaultDescription
targetSVG ElementElement to animate.
nameStringAnimation tag name.
attributesObjectPlain ObjectAttributes of the animation.
endCallbackCallbackRuns at the end of the animation. Optional.

Returns SVG Element

var img = $.media({ href: 'media/Fusion.jpg' }).addTo('svg');
$.svgAnimation( img[0], 'animate', { attributeName: 'opacity', from: '1', to: '0', dur: 10, fill: 'freeze' });

Related .animateColor(), .animateMotion(), values

$.table()

# constructor jSignage In content

Container layer that arranges child layers in a 1D or 2D grid, with optional staggered start times.

Details
$.table( { rows, columns, data, renderToSVG, primaryOrder, secondaryOrder, ... } )

Cell layers are positioned with a horizontal and/or vertical offset. The table has no specific functions.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes plus table attributes.

Returns jSignage layer object

$.table({ data: [1, 2, 3, 4], rows: 4, renderToSVG: function() { return $.textArea({ fontSize: 32 }).text('Line ' + this); } }).addTo('svg');

Related $.carousel()

$.tbreak()

in $.textArea() # function jSignage In content

Creates a line break element that breaks the current line even when it is empty.

Details
$.tbreak()

Consecutive tbreak elements each cause a line break.

Returns formatted text object

$.textArea({ fontSize: 40 }).text($.tspan('Item 1').tbreak().tspan('Item 2').tbreak()).addTo('svg');

Related $.tspan()

$.textArea()

# constructor jSignage In content

Text layer that wraps plain or formatted text inside a fixed rectangle.

Details
$.textArea( { left, top, width, height, fontSize, ... } )

Set or replace the content with .text(). The font size 'max' fits the text to the area height; text that is too long is truncated, use $.fitTextArea() to show all of it. Text attributes of this entry also apply to the smart text areas.

ParameterTypeDefaultDescription
attributesObjectPlain ObjectCommon layer attributes, text alignment attributes and text styling attributes.

Returns jSignage layer object

$.textArea({ id: 'txt1', width: '90%', height: '15%', top: '80%', left: '5%', fontSize: 60 }).text('Welcome to jSignage demo').addTo('svg');

Related .text(), $.tspan(), $.tbreak()

$.textBar()

# constructor jSignage In content

Slideshow specialised for text, typically on one or two lines, one data item after another.

Details
$.textBar( { data, lines, lineDur, scrollDur, transition, renderToText, ... } )

Accepts common layer attributes, frame, alignment and styling attributes. The text is scaled to the full height of the area, so fontSize is ignored. Each item shows for lines x lineDur + (totalLines - lines) x (scrollDur + lineDur) seconds. Supports .pushData().

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata is required.

Returns jSignage Object

$.textBar({ data: ['First message', 'Second message'], height: '20%', bottom: 0, lines: 1, lineDur: 2, frame: { backColor: 'white' }, repeatCount: 'indefinite' }).addTo('svg');

Related $.slideshow(), .pushData()

$.textTicker()

# constructor jSignage In content

Crawler specialised for text, scrolling across the screen horizontally or vertically.

Details
$.textTicker( { data, direction, speed, spacing, lines, baseLine, smooth, renderToText, ... } )

A horizontal ticker fits one line in its area; a vertical ticker shows several lines. The text is scaled to the full height of the area, so fontSize is ignored. Use repeatCount to set the number of runs; 'indefinite' loops forever. fill and fontFamily set colour and font. Supports .pushData().

ParameterTypeDefaultDescription
attributesObjectPlain Objectdata is required.

Returns jSignage layer object

$.textTicker({ data: ['Welcome !', 'Bienvenue !', 'Wilkommen !'], repeatCount: 'indefinite' }).addTo('svg');

Related $.crawler(), .pushData()

$.triggerWithOffset()

# function jSignage In content

Builds a valid SVG time point for the begin or end attribute of an animation element.

Details
$.triggerWithOffset( trigger, offset )
ParameterTypeDefaultDescription
triggerArrayTime point used as base.
offsetNumberOffset from the trigger, in seconds.

Returns Number | String

animateElement.setAttribute( 'begin', $.triggerWithOffset( trigger, offset ) );

$.tspan()

in $.textArea() # function jSignage In content

Creates a formatted text object, with or without styling attributes. Calls can be chained.

Details
$.tspan( text, { stylingAttributes } ) | $.tspan( text )

Chain .tspan() and .tbreak() to build text with mixed styles. A new line character (\n) in text becomes a line break.

Returns formatted text object

$.textArea({ fontSize: 60 }).text(
  $.tspan('Welcome to the ').tspan('jSignage', { fill: 'blue' }).tspan(' API demo')
).addTo('svg');

Related $.tbreak(), .text()

$.uiStyle

# property jSignage In content

Default UI style for push buttons and progress bars.

Details
$.uiStyle = 'round'

Used as the default of the style attribute of $.pushButton() and $.progressBar(). Values used in the wiki: 'manzana', 'round', 'square'.

$.uiStyle = 'round';

Related style (pushButton), style (progressBar)

$.video()

in $.media() # constructor jSignage In content

Video layer, with optional audio.

Details
$.video( { href, ... } )

Videos play once unless repeatCount or repeatDur is set.

ParameterTypeDefaultDescription
attributesObjectPlain Objecthref plus common layer attributes and media attributes.

Returns jSignage layer object

$.video({ href: 'clip.avi', id: 'vid1', repeatCount: 'indefinite', width: '50%', height: '50%', top: '25%', left: '25%' }).addTo('svg');

$.warn()

# function jSignage In content

Adds a log entry at warning level.

Details
$.warn( text )
ParameterTypeDefaultDescription
textStringLog text.
$.warn( 'message' );

Since jSignage 1.3.0

$.wipe()

# constructor jSignage In content

Wipes the new slide in over the previous, frozen slide with an SMPTE wipe type.

Details
$.wipe( [attributesObject] )

bar: leftToRight, rightToLeft, topToBottom, bottomToTop. box: topLeft, topRight, bottomRight, bottomLeft, topCenter, rightCenter, bottomCenter, leftCenter. barnDoor: vertical, horizontal. iris: rectangle.

ParameterTypeDefaultDescription
durNumber | String'0.5s'Duration of the transition effect.
typeString'random'Wipe type per SMPTE 258M-1993: 'random', 'bar', 'box', 'barnDoor', 'iris'.
subTypeString'random'Wipe subtype.

Returns jSignage Transition Object

$.wipe({ dur: '1s', type: 'barnDoor', subType: 'vertical' });

Related jSignage Transition Object, dur

$.zoom()

# constructor jSignage In content

Fades and zooms the new slide in from a smaller size, and zooms it out when it ends.

Details
$.zoom( [attributesObject] )
ParameterTypeDefaultDescription
durNumber | String'1s'Duration of the transition effect.
factorInString'20%'Zoom factor at the beginning.
factorOutString'20%'Zoom factor at the end.
keepZoomingBooleanfalseKeep zooming while the slide is shown; factorOut is then ignored.

Returns jSignage Transition Object

$.slideshow({ begin: '0s', repeatCount: 'indefinite', defaultSlideDur: 5, defaultTransition: $.zoom({ keepZooming: true, factorIn: '10%' }), data: ['This is text:', 'Text is good for you !'], renderToSVG: function() { return $.textArea({ fontSize: 48, fill: 'white' }).tspan( this ); } }).addTo('svg');

Related jSignage Transition Object, dur

acceleration

in .flyIn() # attribute jSignage In content

Acceleration or deceleration as the ratio from initial to final speed (default 3).

Details

Used by flyIn/flyOut. A value of 1 gives constant speed.

accumulate

in $.svgAnimation() # attribute jSignage In content

'sum' makes each repeat build on the previous one; 'none' does not.

Details
ParameterTypeDefaultDescription
accumulateString'none''sum' makes each repeat build on the previous one; 'none' does not.

additive

in $.svgAnimation() # attribute jSignage In content

'sum' adds the values to the target value; 'replace' overrides it.

Details
ParameterTypeDefaultDescription
additiveString'replace''sum' adds the values to the target value; 'replace' overrides it.

autoNext (carousel)

in $.carousel() # attribute jSignage In content

Moves through the choices automatically, as if calling .next() periodically.

Details
autoNext: true

Default false.

begin

in Common layer attributes # attribute jSignage In content

Begin time of the layer: a delay, 'now', 'now+offset' or 'indefinite'.

Details
begin: 2.5 | '2500ms' | 'now' | 'now+1s' | 'indefinite'

A number or time string is a delay relative to the begin of the parent layer, e.g. 2.5 or '2500ms'. 'now' begins the layer when .add() is called; 'now+1s' adds an offset to that. 'indefinite' waits for .begin() or .show(). A fixed offset on a layer added after its parent has begun may show the layer only in part or not at all. Default: 0 when the parent is not in the rendering tree, 'now' otherwise.

$.image({ href: 'images/3.jpg', begin: 5, dur: 5 }).addTo('svg');

begin

in $.svgAnimation() # attribute jSignage In content

When the animation starts, relative to the layer start, or 'indefinite'.

Details

Used by animateColor, animateOpacity, animateMotion, animateRotate, animateZoom and svgAnimation. 'indefinite' means it is started with the .begin() layer function.

ParameterTypeDefaultDescription
beginNumber | String0When the animation starts, relative to the layer start, or 'indefinite'.

bottom

in Common layer attributes # attribute jSignage In content

Position of the bottom of the layer relative to the bottom of its parent layer.

Details
bottom: '20%'

Absolute or relative value. Default 'auto'.

$.image({ href: 'images/bottom.jpg', width: '20%', height: '20%', bottom: '20%', right: '0%' }).addTo('svg');

by

in $.svgAnimation() # attribute jSignage In content

Relative offset for the animation. Ignored if values is set.

Details

A by animation equals a values array of [ 0, by ] with additive 'sum'.

ParameterTypeDefaultDescription
byNumber | StringRelative offset for the animation. Ignored if values is set.

calcMode

in $.svgAnimation() # attribute jSignage In content

Interpolation mode: 'discrete', 'linear', 'paced' or 'spline'.

Details

Default is 'linear', except for .animateMotion() where it is 'paced'.

ParameterTypeDefaultDescription
calcModeString'linear'Interpolation mode: 'discrete', 'linear', 'paced' or 'spline'.

cellPadding (table)

in $.table() # attribute jSignage In content

Extra padding between cells, in pixels or percent.

Details
cellPadding: 10

A relative value refers to the greater of the width or height. Default 0.

columnPadding (table)

in $.table() # attribute jSignage In content

Extra padding between columns, in pixels or percent of the table width.

Details
columnPadding: 10

Default 0.

Common layer attributes

# attribute jSignage In content

Attributes accepted by every jSignage layer: position, size, timing, opacity, transform and frame.

Details
$.<layerType>({ left, top, right, bottom, width, height, begin, dur, min, max, repeatCount, repeatDur, opacity, audioLevel, transform, viewBox, frame, id })

Each attribute is its own entry. Layer types add their own attributes on top of these.

$.image({ id: 'logo', href: 'logo.png', left: 100, top: 50, width: '20%', height: '20%', begin: 2, dur: 5 }).addTo('svg');

Related $.<layerType>()

d

in $.path() # attribute jSignage In content

Path data with moveto, line, curve (cubic and quadratic Bezier) and closepath commands; a $.pathData object is accepted.

Details

Type: String or Object.

data (carousel)

in $.carousel() # attribute jSignage In content

One-dimensional array of the choices. Required.

Details
data: [a, b, c]

An object with a length property is enough if no data is needed.

data (playlist)

in $.playlist() # attribute jSignage In content

Array of playlist elements: URI strings or descriptor objects.

Details
data: ['a.jpg', { href: 'b.mp4', dur: 'media', transition: $.crossFade() }]

A descriptor object has href (the only required field), dur (seconds; 'media' by default for video and animation, defaultDur for images) and transition (from the previous element; defaultTransition if omitted).

$.playlist({ data: ['a.jpg', { href: 'b.jpg', dur: 8 }] }).addTo('svg');

data (slideshow)

in $.slideshow() # attribute jSignage In content

Array with the data of each slide. Required.

Details
data: [item1, item2] | { length: 3 }

At minimum an object with a length property, such as { length: 3 }.

data (table)

in $.table() # attribute jSignage In content

Data for the cells: a 1D or 2D array, an array of layers, or null.

Details
data: [['Quick check', 20], ['Winter pack', 50]]

Values are passed to renderToSVG. If renderToSVG is not defined, data must hold jSignage layers. null needs renderToSVG. A 1D array fills cells in primaryOrder, then secondaryOrder; a 2D array maps inner arrays to the primary direction, which allows a variable number of cells. Default null.

Date format pattern letters

in $.DateTimeFormat() # attribute jSignage In content

Unicode CLDR pattern letters for date and time formats.

Details
$.DateTimeFormat( 'EEEE, MMMM d, y hh:mm a' )

Supported (fully or partly): G y u U r Q q M L d g E e c; a h H K k m s S A; z Z v. Not supported: w W Y D F b B O V X x. Quote literal text in apostrophes ('of'); two apostrophes give one. Numerals: prefix #hanidec# for all fields or #d=hanidays# per field; time fields cannot be overridden.

new $.DateTimeFormat( "d 'of' MMMM" )   // "14 of April"

DECIMAL, SCIENTIFIC, PERCENT, CURRENCY

in $.NumberFormat() # attribute jSignage In content

Predefined number formats.

Details
$.NumberFormat.Format.DECIMAL

DECIMAL is the default (generic decimals). SCIENTIFIC or E: scientific notation. PERCENT or %: percent values such as 12%. CURRENCY or $: currency values such as $12.00 for the US locale.

defaultSlideDur (slideshow)

in $.slideshow() # attribute jSignage In content

Default duration of slides without their own duration.

Details
defaultSlideDur: 5

Default 'indefinite': a slide with no duration shows forever.

defaultTransition (multiPage)

in $.multiPage() # attribute jSignage In content

Default transition between pages.

Details
defaultTransition: $.crossFade()

Default null: no transition.

defaultTransition (playlist)

in $.playlist() # attribute jSignage In content

Default transition from the previous element.

Details
defaultTransition: $.crossFade()

Used when an element has no transition of its own.

defaultTransition (slideshow)

in $.slideshow() # attribute jSignage In content

Default transition between slides.

Details
defaultTransition: $.push({ direction: 'rightToLeft' })

Default null: no transition.

dimming (popup)

in $.popup() # attribute jSignage In content

Dimming applied to the viewport behind the popup.

Details
dimming: '50%'

A percentage or a number between 0 and 1. Default '50%'.

direction

in $.textArea() # attribute jSignage In content

Controls the Unicode bidirectional text layout algorithm.

Details
direction: 'rtl'

CSS direction property. Can be set on the text area or on parts of formatted text.

direction

in .slideIn() # attribute jSignage In content

Direction of motion: random (default), rightToLeft, leftToRight, bottomToTop, topToBottom.

Details

Used by slideIn/slideOut, flyIn/flyOut and cubeFaceIn/cubeFaceOut.

direction

in $.slide() # attribute jSignage In content

Direction of motion: random (default), rightToLeft, leftToRight, bottomToTop, topToBottom.

Details

Used by slide, push and cubeFace.

direction (carousel)

in $.carousel() # attribute jSignage In content

Presentation order of the choices.

Details
direction: 'leftToRight'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'leftToRight'.

direction (crawler)

in $.crawler() # attribute jSignage In content

Crawling direction.

Details
direction: 'rightToLeft'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'rightToLeft'.

direction (mediaCrawler)

in $.mediaCrawler() # attribute jSignage In content

Crawling direction.

Details
direction: 'rightToLeft'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'rightToLeft'.

direction (pingPongTextArea)

in $.pingPongTextArea() # attribute jSignage In content

Scrolling direction.

Details
direction: 'rightToLeft'

'rightToLeft', 'leftToRight', 'bottomToTop' or 'topToBottom'. Default 'rightToLeft'.

direction (textTicker)

in $.textTicker() # attribute jSignage In content

Scrolling direction.

Details
direction: 'rightToLeft'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'rightToLeft'.

displayAlign

in $.textArea() # attribute jSignage In content

Vertical alignment of the text inside a text area.

Details
displayAlign: 'center' | 'before' | 'after'

'center', 'before' (top) or 'after' (bottom). Default 'center'. Text area level only.

$.textArea({ displayAlign: 'before' }).text('Top').addTo('svg');

dur

in Common layer attributes # attribute jSignage In content

Duration of the active period of the layer.

Details
dur: 5 | '5s' | 'media'

If not specified, or 'media', the intrinsic duration of the layer is used, for example the clip length of a video.

$.media({ href: 'images/1.jpg', dur: 5 }).addTo('svg');

dur

in $.svgAnimation() # attribute jSignage In content

Animation duration in seconds, or 'indefinite'.

Details

Used by all animate functions and svgAnimation.

ParameterTypeDefaultDescription
durNumber | String0Animation duration in seconds, or 'indefinite'.

dur

in .fadeIn() # attribute jSignage In content

Duration of an effect; the default is usually '0.5s'.

Details

Common to all effects. Wipe-in without dur lasts 1s; blink and nudge describe their own dur.

dur

in $.random() # attribute jSignage In content

Duration of the transition effect(s); the default is usually '0.5s'.

Details

Common to all transitions. For transitions with two effects (fade) each effect lasts dur. Defaults: crossFade, fade, zoom 1s; page 0.375s; others 0.5s.

factors (fitTextArea)

in $.fitTextArea() # attribute jSignage In content

Scaling steps for the font size: 'fine', 'coarse' or an array of factors.

Details
factors: 'fine' | 'coarse' | [1, 2, 4]

'fine' is the default. 'coarse' is preferred when several text areas on the page should be aligned. An array of integer factors such as [1,2,4] aligns the baselines of side-by-side areas.

$.fitTextArea({ left: '0%', width: '33%', fontSize: 150, factors: [1,2,4], displayAlign: 'before' }).text('Small text').addTo('svg');

fill

in $.textArea() # attribute jSignage In content

Text colour.

Details
fill: 'blue'

Can be set on the text area or on parts of formatted text.

$.tspan('Welcome to ').tspan('jSignage', { fill: 'blue' });

fill

in $.svgAnimation() # attribute jSignage In content

'freeze' keeps the last value after the animation ends; 'remove' removes the effect.

Details

Used by all animate functions and svgAnimation.

ParameterTypeDefaultDescription
fillString'remove''freeze' keeps the last value after the animation ends; 'remove' removes the effect.

fontFamily

in $.textArea() # attribute jSignage In content

Font used to render the text.

Details
fontFamily: 'Arial'

Can be set on the text area or on parts of formatted text.

fontSize

in $.textArea() # attribute jSignage In content

Font size. The special value 'max' fits the text to the height of the text area.

Details
fontSize: 60 | '60px' | 'max'

'max' is valid at text area level only. A number or a string such as '60px' sets a fixed size.

$.textArea({ width: '90%', height: '15%', fontSize: 'max' }).text('Welcome').addTo('svg');

fontVariant

in $.textArea() # attribute jSignage In content

Normal or small-caps glyphs for lowercase characters.

Details
fontVariant: 'small-caps'

'normal' (default) or 'small-caps'.

fontWeight

in $.textArea() # attribute jSignage In content

Boldness of the font relative to other fonts of the family.

Details
fontWeight: 'bold'

'normal' (default), 'bold', 'bolder' or 'lighter'.

$.tspan(this.title, { fontWeight: 'bold' });

frame

in Common layer attributes # attribute jSignage In content

Optional frame decoration object: background, frame, corners, shadow, padding.

Details
frame: { backColor: 'white', shape: 'round' }

Default null. See the frame decoration entries for the keys. The frame cannot be changed with .attr(); the layer has to be recreated.

$.textArea({ frame: { backColor: 'white', frameColor: 'black' } }).text('Hello').addTo('svg');

frame.backColor

in frame # attribute jSignage In content

Colour of the layer background. Layers are transparent by default.

Details
frame: { backColor: 'white' }

Default 'none'.

$.textArea({ frame: { backColor: 'white', frameColor: 'black' } }).text('Hello').addTo('svg');

frame.backOpacity

in frame # attribute jSignage In content

Opacity of the background.

Details
frame: { backColor: 'blue', backOpacity: 0.5 }

Default '100%'.

frame.clip

in frame # attribute jSignage In content

Controls whether content is clipped at the corners: 'none', 'auto' or 'force'.

Details
frame: { clip: 'auto' }

Clipping hides content outside the frame shape behind the opaque screenColor. 'auto' (default) clips only media layers with content outside the shape.

frame.corners

in frame # attribute jSignage In content

Array of the corners whose shape is changed.

Details
frame: { shape: 'snip', corners: [ 'topRight', 'bottomLeft' ] }

Default [ 'topLeft', 'topRight', 'bottomRight', 'bottomLeft' ]. Elements must appear in that order.

$.media({ left: '35%', top: '25%', width: 400, height: 300, href: 'image_4_3.jpg', frame: { screenColor: 'white', shape: 'snip', corners: ['topRight', 'bottomLeft'] } }).addTo('svg');

frame.frameColor

in frame # attribute jSignage In content

Colour of the frame. 'none' draws no frame.

Details
frame: { frameColor: 'white' }

Default 'none'. The frame sits inside the area of the layer and reduces the content area; the aspect ratio is kept by clipping content at the border.

$.image({ href: 'portrait.jpg', frame: { frameColor: 'white' } }).addTo('svg');

frame.frameSize

in frame # attribute jSignage In content

Size of the frame.

Details
frame: { frameColor: 'white', frameSize: '5%' }

Pixels or percent of the smaller of layer width and height. Default '6%'.

frame.padding

in frame # attribute jSignage In content

Padding between the layer borders and its content.

Details
frame: { padding: '5%' }

One value for all borders, or four values (top, right, bottom, left) separated by spaces. Each is pixels or percent of the smaller of layer width and height. Default '0'.

frame.rx

in frame # attribute jSignage In content

Horizontal size of non-square corners, the radius for round corners.

Details
frame: { shape: 'round', rx: '10%' }

Pixels or percent of the smaller of layer width and height. Default '20%'.

frame.ry

in frame # attribute jSignage In content

Vertical size of non-square corners.

Details
frame: { shape: 'round', ry: '15%' }

Default: equal to rx. If different, round corners become elliptical.

frame.screenColor

in frame # attribute jSignage In content

Colour of the screen area around a media frame; default for decoration effects that must match the screen.

Details
frame: { screenColor: 'white' }

Default 'currentColor'.

$.media({ href: 'a.jpg', frame: { screenColor: 'white', shape: 'round' } }).addTo('svg');

frame.shadow

in frame # attribute jSignage In content

When true, draws a semi-transparent shadow around the layer borders.

Details
frame: { shadow: true }

The shadow is drawn outside the layer area and does not change the content size. Default false. Looks best on white or bright backgrounds.

$.media({ left: 120, top: 30, width: 400, height: 300, href: 'image_4_3.jpg', frame: { frameColor: 'white', frameSize: '5%', shadow: true } }).addTo('svg');

frame.shadowColor

in frame # attribute jSignage In content

Colour of the shadow.

Details
frame: { shadow: true, shadowColor: '#808080' }

Default '#A0A0A0'.

frame.shadowSize

in frame # attribute jSignage In content

Size of the drop shadow.

Details
frame: { shadow: true, shadowSize: '5%' }

Pixels or percent of the smaller of layer width and height. Default '3%'.

frame.shape

in frame # attribute jSignage In content

Shape of the corners: 'square', 'round' or 'snip'.

Details
frame: { shape: 'round' }

Default 'square'. For round and snip the background must be one uniform colour equal to screenColor, and the media aspect ratio must match the layer for the corners to show.

$.media({ left: '10%', top: '20%', width: 640, height: 480, href: 'image_4_3.jpg', frame: { screenColor: 'white', shape: 'round' } }).addTo('svg');

frame.softEdge

in frame # attribute jSignage In content

When true, draws a mask over the media that blends its borders into the background.

Details
frame: { softEdge: true }

Default false. The media aspect ratio must match the layer for the soft edges to apply correctly.

$.media({ left: '10%', top: '10%', width: '80%', height: '80%', href: 'image_16_9.jpg', frame: { softEdge: true, screenColor: 'white', softEdgeSize: '10%' } }).addTo('svg');

frame.softEdgeColor

in frame # attribute jSignage In content

Colour used to soften the borders.

Details
frame: { softEdge: true, softEdgeColor: 'white' }

Default: frameColor if a frame is set, otherwise screenColor.

frame.softEdgeSize

in frame # attribute jSignage In content

Size of the soft edge gradient.

Details
frame: { softEdge: true, softEdgeSize: '10%' }

Pixels or percent of the smaller of layer width and height. Default '6%'.

frame.specialFX

in frame # attribute jSignage In content

Special effect around the layer: 'reflection' or 'rotate'.

Details
frame: { specialFX: 'reflection' }

reflection draws a mirror image at the bottom; rotate draws a pseudo-3D paper sheet effect. For reflection the screen behind must be one constant colour, set as reflectionColor or by default screenColor.

Notes On a video or animation layer a special effect causes a severe performance penalty; test the project.

frame.uiStyle

in frame # attribute jSignage In content

Applies one of the UI styles to the background: 'manzana', 'round' or 'square'.

Details
frame: { uiStyle: 'round' }

Default null.

freezeDuringEffects (slideshow)

in $.slideshow() # attribute jSignage In content

Freezes animations and media while transition effects run.

Details
freezeDuringEffects: true

Adds the in and out effect durations to each slide. Default false.

from

in $.svgAnimation() # attribute jSignage In content

Start value of the animation. Ignored if values is set.

Details

A from-to animation equals a values array of [ from, to ].

ParameterTypeDefaultDescription
fromNumber | StringStart value of the animation. Ignored if values is set.

FULL_DATE, LONG_DATE, MEDIUM_DATE, SHORT_DATE, FULL_TIME, LONG_TIME, MEDIUM_TIME, SHORT_TIME, *_DATETIME

in $.DateTimeFormat() # attribute jSignage In content

Predefined date and time formats; they can be combined with a space.

Details
$.DateTimeFormat.Format.FULL_DATETIME

en_US output: FULL_DATE 'Tuesday, April 14, 2015'; LONG_DATE 'April 14, 2015'; MEDIUM_DATE 'Apr 14, 2015'; SHORT_DATE '4/14/15'; FULL_TIME and LONG_TIME '10:10:34 PM GMT-05:00'; MEDIUM_TIME '10:10:34 PM'; SHORT_TIME '10:10 PM'. FULL_DATETIME, LONG_DATETIME, MEDIUM_DATETIME, SHORT_DATETIME join the date and time of the same size.

new $.DateTimeFormat( 'LONG_DATE SHORT_TIME' )

Notes Combining as 'LONG_DATE SHORT_TIME' is documented for widget format strings on the Localization page.

gap (slideshow slide)

in $.slideshow() # attribute jSignage In content

Slide-specific delay from the previous slide. Set on the layer returned by renderToSVG.

Details
return $.g({ gap: 1 })

Overrides defaultGap for that slide.

gradientUnits

in $.linearGradient() # attribute jSignage In content

Coordinate system for x1, y1, x2, y2: 'userSpaceOnUse' or 'objectBoundingBox'.

Details

Type: String. Default: 'userSpaceOnUse'.

Notes With 'objectBoundingBox' the coordinates must be between 0 and 1 for the gradient to be visible.

href

in $.media() # attribute jSignage In content

URI of the content source. Required.

Details
$.media({ href: 'media/img.png' })

A local file such as 'media/img.png' or a resource on the remote web server.

$.media({ href: 'smile.jpg' }).addTo('svg');

id

in Common layer attributes # attribute jSignage In content

Unique string that identifies the layer for later selection with $('#id').

Details
id: 'back'

Strongly recommended.

$.image({ id: 'back', href: 'images/1.jpg' }).addTo('svg');
$('#back').hide();

iterating (playlist)

in $.playlist() # attribute jSignage In content

Callback to change playlist parameters before each new iteration starts.

Details
iterating: function( iter ) { ... }

Called once before the first iteration and before each repeat. this is the playlist parameters; data, defaultTransition, looping and loopCount can be changed. The return value is ignored.

$.playlist({ iterating: function() { this.data = $.shuffle(list); }, repeatCount: 'indefinite' }).addTo('svg');

iterating (slideshow)

in $.slideshow() # attribute jSignage In content

Callback to change slideshow parameters before each new iteration starts.

Details
iterating: function( iter ) { ... }

Called once before the first iteration and before each repeat, with the iteration count (0 first). this is the slideshow parameters; data, defaultTransition, looping, loopCount, renderToSVG and defaultGap can be changed. The return value is ignored.

jSignage Transition Object

# property jSignage In content

Plain object that defines a transition: durations and wrap callbacks for in, out and exit effects.

Details

A transition has up to three effects: in (starts with the new slide), out (runs when the slide finishes) and exit (applied to the finished slide as the next starts). wrapOut is ignored when the transition is interactive or the media duration is unknown; wrapExit has no such limit.

$.crossFade = function( args ) {
  var dur = $.durInSeconds( args && args.dur, 1 );
  return {
    durIn: dur, durExit: dur,
    wrapIn: function( trigger ) {
      $.svgAnimation( this, 'animate', { attributeName: 'opacity', from: '0', to: '1', begin: trigger, dur: dur });
    }
  };
};

Related $.durInSeconds(), $.svgAnimation()

jSignage() / $()

# function jSignage In content

Global jSignage function. $ is its alias. Called with no parameters it returns the jSignage object itself.

Details
jSignage() | $() | $( selector ) | $( handler )

Many member functions return the jSignage object, so calls can be chained. $( selector ) wraps matching elements, for example $('svg') or $('#id'). $( handler ) runs the handler once the document is ready.

$.media({ href: 'smile.jpg' }).addTo('svg');

Related .ready()

keepZooming

in $.zoom() # attribute jSignage In content

If true, the slide keeps zooming while displayed and factorOut is ignored (default false).

Details

keyPoints

in .animateMotion() # attribute jSignage In content

Maps keyTimes to relative distances (0 to 1) along the motion path.

Details

Array of numbers with exactly as many elements as keyTimes.

keySplines

in $.svgAnimation() # attribute jSignage In content

Bezier control points for 'spline' calcMode, one fewer set than keyTimes.

Details

Each control point is 'x1 y1 x2 y2'. Use an array of strings for animate functions and a string for svgAnimation().

ParameterTypeDefaultDescription
keySplinesArray | StringBezier control points for 'spline' calcMode, one fewer set than keyTimes.

keyTimes

in $.svgAnimation() # attribute jSignage In content

Times from 0 to 1 that set when each of the values is used.

Details

Use an array of numbers for animate functions and a string for svgAnimation(). Without keyTimes all values get the same duration.

ParameterTypeDefaultDescription
keyTimesArray | StringTimes from 0 to 1 that set when each of the values is used.

layerAlign

in $.media() # attribute jSignage In content

Alignment of a layer that was shrunk by layerFit inside its nominal viewport.

Details
layerAlign: 'center'

One of 'topLeft', 'topMid', 'topRight', 'midLeft', 'center', 'midRight', 'bottomLeft', 'bottomMid', 'bottomRight'. Default 'center'.

layerFit

in $.media() # attribute jSignage In content

Adapts the layer size to the aspect ratio of its media.

Details
layerFit: 'none' | 'horizontal' | 'vertical' | 'both'

'horizontal' narrows the width, 'vertical' shortens the height, 'both' does either, 'none' keeps the size. The layer never grows beyond the specified size. Default 'none'.

$.image({ href: 'portrait.jpg', layerFit: 'both', width: '50%', height: '50%' }).addTo('svg');

Since Firmware 3.0

left

in Common layer attributes # attribute jSignage In content

Position of the left side of the layer relative to the left side of its parent layer.

Details
left: '25%'

Absolute or relative value. Default 'auto'.

$.video({ href: 'clip.mp4', left: '25%', top: '25%', width: '50%', height: '50%' }).addTo('svg');

lineDur (scrollingTextArea)

in $.scrollingTextArea() # attribute jSignage In content

Duration of each line in seconds.

Details
lineDur: 1.5

Default 1.5, must be greater than 0. With n lines in the area, the text is static for n x lineDur seconds, then scrolls and shows each line for lineDur.

lineIncrement

in $.textArea() # attribute jSignage In content

Line spacing: offset between successive lines.

Details
lineIncrement: 'auto' | 60

'auto' or a number. Default 'auto'. Text area level only.

$.textArea({ fontSize: '50px', displayAlign: 'before', lineIncrement: 60 }).text('Hello').addTo('svg');

Locale tags

# property jSignage In content

Locale identifiers: language and region subtags plus an optional script subtag, e.g. en_US (default).

Details
en_US, zh_Hans_CN, es_MX

Firmware 4.1.0 and later support all CLDR 'modern' coverage locales (list: cldr-core 29.0.0 availableLocales.json). Firmware 3.x and 4.0.x support the table on the Locale codes page.

Related $.setLocale(), $.getLocale()

mediaAlign

in $.media() # attribute jSignage In content

Alignment of the media inside the layer when the aspect ratios differ.

Details
mediaAlign: 'center'

One of 'topLeft', 'topMid', 'topRight', 'midLeft', 'center', 'midRight', 'bottomLeft', 'bottomMid', 'bottomRight'. Default 'center'.

mediaFit

in $.media() # attribute jSignage In content

How the media is fitted inside the viewport of the layer.

Details
mediaFit: 'meet' | 'fill' | 'slice'

'fill' stretches width and height independently, possibly altering the aspect ratio. 'meet' scales uniformly to fit entirely inside, possibly leaving empty area. 'slice' scales uniformly to cover the viewport, possibly cropping. Default 'meet'.

$.image({ href: 'a.jpg', mediaFit: 'slice' }).addTo('svg');

Since Firmware 3.0 for 'slice'

mediaHeight (mediaCrawler)

in $.mediaCrawler() # attribute jSignage In content

Height of each media, used for its aspect ratio.

Details
mediaHeight: 90

The media is scaled to fit exactly one line. Default 90.

mediaWidth (mediaCrawler)

in $.mediaCrawler() # attribute jSignage In content

Width of each media, used for its aspect ratio.

Details
mediaWidth: 160

The media is scaled to fit exactly one line. Default 160.

mimetype

in $.media() # attribute jSignage In content

MIME type of the content, for when the server or the file extension does not give it correctly.

Details
mimetype: 'auto'

Default 'auto'.

minimumDur (playlist)

in $.playlist() # attribute jSignage In content

Minimum duration of any element; videos are extended by freezing the last frame.

Details
minimumDur: 3

Default: no minimum.

Number format pattern characters

in $.NumberFormat() # attribute jSignage In content

Unicode CLDR number pattern characters.

Details
$.NumberFormat( '#,###.00' )

Supported: 0 (zero padding), @ (significant digit), # (digit), . (decimal separator), , (grouping), - , + , E, %, per mille, currency sign, ; (sub-pattern). Not supported: 1-9 (rounding), * (padding). A pattern with @ is a significant-digits pattern: 12345 as @@ gives 12000. Patterns apply only to decimal numbering systems.

new $.NumberFormat( '#,###.00' )

numVisible (carousel)

in $.carousel() # attribute jSignage In content

Number of choices shown at the same time.

Details
numVisible: 3

Default 3. With the carousel size it sets the size of each choice; it should be more than 1 for most carousels.

opacity

in Common layer attributes # attribute jSignage In content

Global opacity of the layer, between 0 and 1.

Details
opacity: 0.5

Default 1. An opacity of 0 disables the layer.

$.image({ href: 'images/1.jpg', opacity: 0.5 }).addTo('svg');

pageDur (scrollingTextArea)

in $.scrollingTextArea() # attribute jSignage In content

Duration of each page; switches scrolling to page by page and ignores lineDur.

Details
pageDur: 3

Default 1.5 x lines.

Since Firmware 3.1

pageEnded (multiPage)

in $.multiPage() # attribute jSignage In content

Callback called when the current page ends.

Details
pageEnded: function() { ... }

Default null. this is the layer. Typically used to program the next page with a switch call.

path

in .animateMotion() # attribute jSignage In content

Defines the motion path with a $.pathData object instead of coordinate pairs.

Details

Supports the same features as path shapes, including Bezier curves and elliptical arcs.

$.media({ href: 'media/Fusion.jpg', left: 560, top: 205, width: 160, height: 90 }).animateMotion({ dur: 10, path: new $.pathData().moveTo( 0, 0 ).arcTo( 200, 200, 0, 1, 1, -1, 0 ) }).addTo('svg');

popoutDur (popup)

in $.popup() # attribute jSignage In content

Duration of the out-effect on the background opacity.

Details
popoutDur: '1s'

If greater than 0 the background opacity is animated when the popup disappears. Default 0s.

popupDur (popup)

in $.popup() # attribute jSignage In content

Duration of the in-effect on the background opacity.

Details
popupDur: '1s'

If greater than 0 the background opacity is animated when the popup appears. Default 0s.

primaryOrder (table)

in $.table() # attribute jSignage In content

Primary filling order of the table.

Details
primaryOrder: 'leftToRight'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'leftToRight', or 'topToBottom' when there is one column and several rows.

renderToSVG (carousel)

in $.carousel() # attribute jSignage In content

Callback that returns the SVG layer for each choice. Required.

Details
renderToSVG: function( index, item ) { ... }

Same as the slideshow renderToSVG callback: index and item.

renderToSVG (crawler)

in $.crawler() # attribute jSignage In content

Callback that builds the layer for one data item. Required.

Details
renderToSVG: function( index, item, width, height ) { ... }

Called once per item just before it becomes visible, with index, item (also this), width and height (pixels of the crawler area). Must return a jSignage layer with absolute pixel width and height.

renderToSVG (slideshow)

in $.slideshow() # attribute jSignage In content

Callback that builds the SVG layer for each slide. Required.

Details
renderToSVG: function( index, item ) { ... }

Called once per slide with index (0 to data.length-1) and item (data[index], may be undefined). Must return a jSignage layer or null to end the slideshow. The returned layer may carry gap and transition attributes that override the slideshow defaults.

renderToSVG: function() { return $.g().add([$.media({ href: this.img }), $.textArea().text(this.title)]); }

renderToSVG (table)

in $.table() # attribute jSignage In content

Callback that renders a data item as a layer, called once per cell.

Details
renderToSVG: function( primary, secondary, item ) { ... }

Receives primary and secondary (zero-based cell coordinates in scan order) and item (also this; null when data is null). Returns a jSignage layer, or null to skip the cell. Required if data is null. Default: function() { return this; }.

renderToSVG: function( primary, secondary ) { return $.textArea({ fontSize: 32 }).text(primary + 'x' + secondary); }

renderToText (textBar)

in $.textBar() # attribute jSignage In content

Callback that builds the text for a data item.

Details
renderToText: function( index, item ) { ... }

Receives index (0 to data.length-1) and item (data[index], also this). Returns a string or a $.tspan() formatted text object. Default: function( index, item ) { return this; }.

renderToText: function() { return $.tspan(this.title, { fontWeight: 'bold' }).tbreak().tspan(this.description); }

renderToText (textTicker)

in $.textTicker() # attribute jSignage In content

Callback that builds the text for each data item.

Details
renderToText: function( index, item ) { ... }

Called once per item just before it becomes visible, with index and item (also this). Returns a string or a $.tspan() formatted text object. Default: function() { return this; }.

renderToText: function() { return this.title; }

renderToURI (mediaCrawler)

in $.mediaCrawler() # attribute jSignage In content

Callback that returns the URI string for each data item.

Details
renderToURI: function() { return this.image; }

Default: function() { return this; }, which treats data items as URIs.

repeatCount

in Common layer attributes # attribute jSignage In content

Number of times the active interval repeats. 'indefinite' loops forever.

Details
repeatCount: 'indefinite' | 3

Default: no repeat. Media such as video plays once unless repeatCount or repeatDur is set.

$.video({ href: 'clip.avi', repeatCount: 'indefinite' }).addTo('svg');

repeatCount

in $.svgAnimation() # attribute jSignage In content

Number of iterations, or 'indefinite'.

Details
ParameterTypeDefaultDescription
repeatCountNumber | String1Number of iterations, or 'indefinite'.

repeatDur

in Common layer attributes # attribute jSignage In content

Time during which the active interval repeats. 'indefinite' loops forever.

Details
repeatDur: 'indefinite' | '60s'

Default: no repeat. The media layer page recommends repeatDur: 'indefinite' for a looping video.

$.video({ href: 'clip.avi', repeatDur: 'indefinite' }).addTo('svg');

repeatDur

in $.svgAnimation() # attribute jSignage In content

Total time to repeat the animation, or 'indefinite'.

Details
ParameterTypeDefaultDescription
repeatDurNumber | StringTotal time to repeat the animation, or 'indefinite'.

right

in Common layer attributes # attribute jSignage In content

Position of the right side of the layer relative to the right side of its parent layer.

Details
right: '0%'

Absolute or relative value. Default 'auto'.

$.image({ href: 'images/top.jpg', width: '20%', height: '20%', top: '5%', right: '0%' }).addTo('svg');

rowPadding (table)

in $.table() # attribute jSignage In content

Extra padding between rows, in pixels or percent of the table height.

Details
rowPadding: 10

Default 0.

rx

in $.rect() # attribute jSignage In content

X radius of the ellipse that rounds the corners; if only one radius is given, the other equals it.

Details

Type: Number. Default: 0.

ry

in $.rect() # attribute jSignage In content

Y radius of the ellipse that rounds the corners; if only one radius is given, the other equals it.

Details

Type: Number. Default: 0.

scaleMethod (headlineTextArea)

in $.headlineTextArea() # attribute jSignage In content

How a too-large text is reduced: 'squeeze' or 'uniform'.

Details
scaleMethod: 'squeeze' | 'uniform'

Default 'squeeze' squeezes the text horizontally. 'uniform' reduces the font size and centres the text vertically.

$.headlineTextArea({ scaleMethod: 'uniform' }).text('Fit this text.').addTo('svg');

scrollBack (pingPongTextArea)

in $.pingPongTextArea() # attribute jSignage In content

If true the text scrolls back to the start using backSpeed; if false it jumps back after backDelay.

Details
scrollBack: true

Default false.

secondaryDelay (table)

in $.table() # attribute jSignage In content

Extra delay between the start times of each secondary series.

Details
secondaryDelay: 0.5

Default 0.

secondaryOrder (table)

in $.table() # attribute jSignage In content

Secondary filling order of the table.

Details
secondaryOrder: 'topToBottom'

'leftToRight', 'rightToLeft', 'topToBottom' or 'bottomToTop'. Default 'topToBottom' if the primary order is horizontal, 'leftToRight' otherwise.

Shape fill and stroke attributes

# property jSignage In content

Fill and stroke attributes common to all shape constructors.

Details

Accepted by $.path(), $.rect(), $.circle(), $.ellipse(), $.line(), $.polyline() and $.polygon(). A line has no interior, so fill never applies to it.

$.rect({ x: 200, y: 100, width: 600, height: 400, fill: 'blue', stroke: 'red', strokeWidth: 5 }).addTo('svg');

Notes Effects, custom animations and frame decoration cannot be applied to a shape directly. Add the shape to a layer, typically a group, and apply them to that layer.

Related $.path(), $.rect(), $.circle(), $.ellipse(), $.line(), $.polyline(), $.polygon()

speed (crawler)

in $.crawler() # attribute jSignage In content

Crawling speed in percent.

Details
speed: 100

100 is one layer height per second (one half of the width for vertical crawlers). Default 100.

speed (mediaCrawler)

in $.mediaCrawler() # attribute jSignage In content

Crawling speed in percent.

Details
speed: 100

100 is one layer height per second (one half of the width for vertical crawlers). Default 100.

speed (pingPongTextArea)

in $.pingPongTextArea() # attribute jSignage In content

Scrolling speed in percent of the area height per second.

Details
speed: 100

Default 100: the text scrolls by the height of the area every second.

spx:effect-target-id

# attribute jSignage In content

SVG attribute that marks a g element as an effect wrapper and points to the wrapped layer id.

Details

Required for the jSignage API to recognize an effect. When several effects are applied they chain through this attribute.

<g xml:id='fadein' spx:effect-target-id='media'>
  <animate attributeName='opacity' from='0' to='1' dur='1' begin='media.begin'/>
  <video xml:id='media' href='clip.mp4' width='160' height='90' begin='0'/>
</g>

Related .effectIn(), .effectOut()

subType

in .wipeIn() # attribute jSignage In content

Wipe subtype; the allowed values depend on the wipe type.

Details

bar: leftToRight, rightToLeft, topToBottom, bottomToTop. box: topLeft, topRight, bottomRight, bottomLeft, topCenter, rightCenter, bottomCenter, leftCenter. barnDoor: vertical, horizontal. iris: rectangle. Default is random for bar, box and barnDoor.

textAlign

in $.textArea() # attribute jSignage In content

Horizontal alignment of the text inside a text area.

Details
textAlign: 'center' | 'start' | 'end' | 'justify'

'center', 'start', 'end' or 'justify'. Default 'center'. 'start' is left in left-to-right documents and right in right-to-left ones; 'end' is the opposite. Text area level only.

$.textArea({ textAlign: 'start' }).text('Left').addTo('svg');

textAlign (textTicker)

in $.textTicker() # attribute jSignage In content

Horizontal alignment of the text.

Details
textAlign: 'center'

'start' (default), 'center', 'end' or 'justify'. 'justify' is valid for 'topToBottom' and 'bottomToTop' only.

textBorderSize

in $.textArea() # attribute jSignage In content

Width of the text border, drawn along the outline of each character.

Details
textBorderSize: 2

Default 0.

Since Firmware 3.1

textFillGradient

in $.textArea() # attribute jSignage In content

Linear gradient paint for the text. Overrides fill.

Details
textFillGradient: 'linear-gradient(to bottom, yellow, blue)'

Value is a CSS3 linear-gradient() description.

$.textArea({ fontSize: 80, textFillGradient: 'linear-gradient(to bottom, yellow, blue)' }).text('Gradient').addTo('svg');

Since Firmware 3.1

textShadow

in $.textArea() # attribute jSignage In content

Text shadow in CSS3 syntax.

Details
textShadow: '2px 2px black'

Example value: '2px 2px black'.

$.textArea({ fontSize: 80, textShadow: '2px 2px black' }).text('Shadow').addTo('svg');

Since Firmware 3.1

to

in $.svgAnimation() # attribute jSignage In content

End value of the animation. Ignored if values is set.

Details
ParameterTypeDefaultDescription
toNumber | StringEnd value of the animation. Ignored if values is set.

top

in Common layer attributes # attribute jSignage In content

Position of the top of the layer relative to the top of its parent layer.

Details
top: '80%'

Absolute or relative value. Default 'auto'.

$.textArea({ top: '80%', height: '15%' }).text('Welcome').addTo('svg');

transform

in Common layer attributes # attribute jSignage In content

Rotates or flips the content of the layer with one or more named transforms.

Details
transform: 'flipHorizontal rotateRight'

Space-separated list of flipHorizontal, flipVertical, rotateLeft (90 degrees left) and rotateRight (90 degrees right). Each is applied in turn. After the layer is in the DOM, raw SVG transforms (matrix, translate, scale, rotate, skewX, skewY) can be appended to the existing transform value, which also holds the layer position as a translate. Default: none.

$.image({ id: 'img3', href: 'resto.png', transform: 'flipHorizontal rotateRight' }).addTo('svg');

Notes On HMP350, HMP300 or older, apply complex transforms to semi-static content (images, text) and avoid them on videos and SVG animations.

transition (slideshow slide)

in $.slideshow() # attribute jSignage In content

Slide-specific transition. Set on the layer returned by renderToSVG.

Details
return $.g({ transition: $.crossFade() })

Overrides defaultTransition for that slide.

transition (textBar)

in $.textBar() # attribute jSignage In content

Transition between items.

Details
transition: $.push({ direction: 'bottomToTop' })

Default $.push({ direction: 'bottomToTop' }).

type (carousel)

in $.carousel() # attribute jSignage In content

Carousel type.

Details
type: 'strip' | 'wheel' | 'roller' | 'squeeze' | 'electron'

'strip' (default), 'wheel', 'roller', 'squeeze' or 'electron'.

values

in $.svgAnimation() # attribute jSignage In content

Successive values of the animated target.

Details

Array for animate functions, semicolon-separated string for svgAnimation(). Type depends on the function: colors, opacity, x,y pairs, zoom factors. Give values, or from and to, or by, never a mix. With overlapping animations on one target, the one that started last wins; on a tie, the one specified last.

ParameterTypeDefaultDescription
valuesArray | StringSuccessive values of the animated target.

viewBox

in Common layer attributes # attribute jSignage In content

Defines a new coordinate space inside the layer area.

Details
viewBox: '0 0 100 100' | 'none'

Syntax 'x y width height' or 'none'. Default 'none': the layer inherits the parent coordinate space shifted so that (0,0) is its top left corner. Typically used on $.g() layers that hold geometric shapes.

$.g({ width: 400, height: 300, viewBox: '0 0 100 100' }).addTo('svg');

wrapExit

in jSignage Transition Object # property jSignage In content

Callback that builds extra SVG for the exit effect on the previous, frozen slide (default null).

Details

callback( trigger, inner, width, height, left, top, bbw, bbh ). this is the g element wrapping the slide. trigger is the begin event string; inner is the next element in the effect stack; width/height is the layer size; left/top its position in the parent; bbw/bbh the parent size, in pixels. It runs when the next slide is created.

wrapIn

in jSignage Transition Object # property jSignage In content

Callback that builds extra SVG for the in effect; the slide is wrapped in a g element (default null).

Details

callback( trigger, inner, width, height, left, top, bbw, bbh ). this is the g element wrapping the slide. trigger is the begin event string; inner is the next element in the effect stack; width/height is the layer size; left/top its position in the parent; bbw/bbh the parent size, in pixels.

wrapOut

in jSignage Transition Object # property jSignage In content

Callback that builds extra SVG for the out effect; the slide is wrapped in a g element (default null).

Details

callback( trigger, inner, width, height, left, top, bbw, bbh ). this is the g element wrapping the slide. trigger is the begin event string; inner is the next element in the effect stack; width/height is the layer size; left/top its position in the parent; bbw/bbh the parent size, in pixels. trigger is relative to the end of the current slide.

jSignage plugins 449

$.Astronomy.dailyEventsScheduler

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.dailyEventsScheduler

$.Astronomy.getSunPosition

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.getSunPosition

$.Astronomy.getTimeUnitsfromMs

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.getTimeUnitsfromMs

$.Astronomy.parseElevation

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.parseElevation

$.Astronomy.parseLongitude

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.parseLongitude

$.Astronomy.sunriseEquation

in jSignage.Astronomy # function jSignage plugins In content

Astronomy plugin function. The wiki lists it without a description or parameters.

Details
$.Astronomy.sunriseEquation

$.CustomEffects.KenBurns

in jSignage.CustomEffects # function jSignage plugins In content

Applies a Ken Burns pan and zoom effect to the layer given as input.

Details
$.CustomEffects.KenBurns

Pan and zoom over a still image, as used in video production. The wiki gives no parameter list.

Notes Multiscreen-safe from firmware 4.6.1.

Since Firmware 4.2.0

$.Graph.areaChart()

in jSignage.Graph # constructor jSignage plugins In content

Area chart layer. Line chart with the area down to the baseline filled; the line and markers are optional.

Details
$.Graph.areaChart( attributes )

Returns jSignage object

$.Graph.areaChart({ data: [0.4, 1, 4, 15.4, 62], width: 1280, height: 720, fillOpacity: 0.5 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.barChart()

in jSignage.Graph # constructor jSignage plugins In content

Bar chart layer. One bar per value, drawn from the baseline, all bars the same color.

Details
$.Graph.barChart( attributes )

Returns jSignage object

$.Graph.barChart({ data: [89, 78, 84, 86], width: 1280, height: 720, legend: null, yAxis: { categories: ['Jan', 'Feb', 'Mar', 'Apr'] } }).addTo('svg');

Since Firmware 3.1.0

$.Graph.baseColors

in jSignage.Graph # property jSignage plugins In content

Default color set used for chart series, slices and bars.

Details
$.Graph.baseColors

Referenced as the default of the colors attribute in line, area, scatter, bubble and pie charts and of the series color. The wiki does not list its values.

$.Graph.bubbleChart()

in jSignage.Graph # constructor jSignage plugins In content

Bubble chart layer. Scatter plot where a third array sets the size of each marker.

Details
$.Graph.bubbleChart( attributes )

Returns jSignage object

$.Graph.bubbleChart({ dataX: [8, 4, 11, 4, 3, 6], dataY: [12, 5.5, 14, 8, 3.5, 7], dataSize: [150, 50, 70, 100, 200, 300], width: 1280, height: 720, fillOpacity: 0.5 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.circularBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Circular bar gauge layer. A progress bar fills a circular path up to the current value.

Details
$.Graph.circularBarGauge( attributes )

Returns jSignage object

$.Graph.circularBarGauge({ data: 60, dataMax: 100, width: 1280, height: 1000, startAngle: -90, endAngle: 90, backColor: '#ccc' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.circularGauge()

in jSignage.Graph # constructor jSignage plugins In content

Basic circular gauge layer. An indicator rotates along a circular axis to the current value.

Details
$.Graph.circularGauge( attributes )

Returns jSignage object

$.Graph.circularGauge({ data: 75, dataMax: 100, width: 1280, height: 640, indicator: { shape: 'needle' } }).addTo('svg');

Since Firmware 3.1.0

$.Graph.columnChart()

in jSignage.Graph # constructor jSignage plugins In content

Column chart layer. One column per value, drawn from the baseline, all columns the same color.

Details
$.Graph.columnChart( attributes )

Returns jSignage object

$.Graph.columnChart({ data: [0.4, 1, 4, 15.4], width: 1280, height: 720, legend: null, textOutside: 'value' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.groupedBarChart()

in jSignage.Graph # constructor jSignage plugins In content

Grouped bar chart layer. A group of parallel bars for each row of a 2D data array.

Details
$.Graph.groupedBarChart( attributes )

Returns jSignage object

$.Graph.groupedBarChart({ data: [[18835.5, 8331], [9790, 3846]], width: 1280, height: 720, labels: ['Consumption', 'Production'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.groupedCircularBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Grouped circular bar gauges in one layer, one bar per value. No indicator.

Details
$.Graph.groupedCircularBarGauge( attributes )

Returns jSignage object

$.Graph.groupedCircularBarGauge({ data: [750, 600], dataMax: 1000, width: 1280, height: 740, labels: ['Left engine', 'Right engine'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.groupedColumnChart()

in jSignage.Graph # constructor jSignage plugins In content

Grouped column chart layer. A group of parallel columns for each row of a 2D data array.

Details
$.Graph.groupedColumnChart( attributes )

Returns jSignage object

$.Graph.groupedColumnChart({ data: [[18835.5, 8331], [9790, 3846]], width: 1280, height: 720, labels: ['Consumption', 'Production'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.groupedHorizontalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Grouped horizontal bar gauges in one layer. No indicator.

Details
$.Graph.groupedHorizontalBarGauge( attributes )

Returns jSignage object

$.Graph.groupedHorizontalBarGauge({ data: [75, 50], dataMax: 100, width: 1160, height: 400, labels: ['A', 'B'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.groupedVerticalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Grouped vertical bar gauges in one layer. No indicator.

Details
$.Graph.groupedVerticalBarGauge( attributes )

Returns jSignage object

$.Graph.groupedVerticalBarGauge({ data: [75, 50], dataMax: 100, width: 600, height: 720, labels: ['A', 'B'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.horizontalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Horizontal bar gauge layer. A progress bar fills from the baseline to the current value.

Details
$.Graph.horizontalBarGauge( attributes )

Returns jSignage object

$.Graph.horizontalBarGauge({ data: 75, dataMax: 100, width: 1160, height: 320, backColor: '#aaa' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.horizontalGauge()

in jSignage.Graph # constructor jSignage plugins In content

Basic horizontal gauge layer. An indicator moves along a horizontal axis to the current value.

Details
$.Graph.horizontalGauge( attributes )

Returns jSignage object

$.Graph.horizontalGauge({ data: 75, dataMax: 100, width: 1160, height: 720, indicator: { shape: 'triangle', position: 'bottom' } }).addTo('svg');

Since Firmware 3.1.0

$.Graph.lineChart()

in jSignage.Graph # constructor jSignage plugins In content

Line chart layer. One data series joined by a line; point markers are optional.

Details
$.Graph.lineChart( attributes )

Returns jSignage object

$.Graph.lineChart({ data: [0.4, 1, 4, 15.4, 62], width: 1280, height: 720, marker: { type: 'square', size: 10 }, pointText: 'value' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.multiAreaChart()

in jSignage.Graph # constructor jSignage plugins In content

Multi-area chart layer. Several filled series drawn over each other, each styled through series.

Details
$.Graph.multiAreaChart( attributes )

Returns jSignage object

$.Graph.multiAreaChart({ data: [[0.4, 1, 4], [50, 40, 35]], width: 1280, height: 720, series: [{ label: 'A' }, { label: 'B' }] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.multiBubbleChart()

in jSignage.Graph # constructor jSignage plugins In content

Bubble chart layer with several data series.

Details
$.Graph.multiBubbleChart( attributes )

Returns jSignage object

$.Graph.multiBubbleChart({ dataX: [[8, 4], [3, 6]], dataY: [[12, 5.5], [3.5, 7]], dataSize: [[150, 50], [200, 300]], width: 1280, height: 720 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.multiLineChart()

in jSignage.Graph # constructor jSignage plugins In content

Multi-line chart layer. Several data series drawn over each other, each styled through series.

Details
$.Graph.multiLineChart( attributes )

Returns jSignage object

$.Graph.multiLineChart({ data: [[0.4, 1, 4], [50, 40, 35]], width: 1280, height: 720, series: [{ label: 'Blue line' }, { label: 'Red line', strokeStyle: { lineDash: 'dashes' } }] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.multiScatterChart()

in jSignage.Graph # constructor jSignage plugins In content

Scatter plot layer with several data series.

Details
$.Graph.multiScatterChart( attributes )

Returns jSignage object

$.Graph.multiScatterChart({ dataX: [[8, 4, 11], [3, 6, 9]], dataY: [[12, 5.5, 14], [3.5, 7, 8]], width: 1280, height: 720 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.percentageAreaChart()

in jSignage.Graph # constructor jSignage plugins In content

Percentage area chart layer. Series areas show each value as a share of the sum at its position.

Details
$.Graph.percentageAreaChart( attributes )

Negative values are not allowed.

Returns jSignage object

$.Graph.percentageAreaChart({ data: [[10, 20, 30], [5, 15, 25]], width: 1280, height: 720, series: [{ label: 'A' }, { label: 'B' }] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.percentageBarChart()

in jSignage.Graph # constructor jSignage plugins In content

Percentage bar chart layer. Each stack fills the full length and shows each value as a share of its row.

Details
$.Graph.percentageBarChart( attributes )

Returns jSignage object

$.Graph.percentageBarChart({ data: [[2133, 969, 357, 838], [2733, 54, 598, 68]], width: 1280, height: 720, textInside: 'percentage' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.percentageColumnChart()

in jSignage.Graph # constructor jSignage plugins In content

Percentage column chart layer. Each stack fills the full height and shows each value as a share of its row.

Details
$.Graph.percentageColumnChart( attributes )

Returns jSignage object

$.Graph.percentageColumnChart({ data: [[2133, 969, 357, 838], [2733, 54, 598, 68]], width: 1280, height: 720, textInside: 'percentage' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.pieChart()

in jSignage.Graph # constructor jSignage plugins In content

Pie or donut chart layer. Slices sized by value; pieHole turns it into a donut.

Details
$.Graph.pieChart( attributes )

Returns jSignage object

$.Graph.pieChart({ data: [2133, 58, 911, 838], labels: ['Coal', 'Oil', 'Gas', 'Nuclear'], width: 1280, height: 720, pieHole: 0.4, textInside: 'percentage' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.scatterChart()

in jSignage.Graph # constructor jSignage plugins In content

Scatter plot layer. Points placed from separate X and Y arrays on continuous axes.

Details
$.Graph.scatterChart( attributes )

Returns jSignage object

$.Graph.scatterChart({ dataX: [8, 4, 11, 4, 3, 6], dataY: [12, 5.5, 14, 8, 3.5, 7], width: 1280, height: 720, marker: { size: 30 }, pointText: 'value' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAndGroupedBarChart()

in jSignage.Graph # constructor jSignage plugins In content

Stacked and grouped bar chart layer. Groups of stacked bars from a 3D data array.

Details
$.Graph.stackedAndGroupedBarChart( attributes )

Returns jSignage object

$.Graph.stackedAndGroupedBarChart({ data: [[[2133, 969], [357, 838]], [[2733, 54], [598, 68]]], width: 1280, height: 720, labels: ['Coal', 'Oil & Gas', 'Renewable', 'Nuclear'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAndGroupedCircularBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked and grouped circular bar gauges in one layer. No indicator.

Details
$.Graph.stackedAndGroupedCircularBarGauge( attributes )

Returns jSignage object

$.Graph.stackedAndGroupedCircularBarGauge({ data: [[100, 200], [150, 250]], dataMax: 1000, width: 1280, height: 740 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAndGroupedColumnChart()

in jSignage.Graph # constructor jSignage plugins In content

Stacked and grouped column chart layer. Groups of stacked columns from a 3D data array.

Details
$.Graph.stackedAndGroupedColumnChart( attributes )

Returns jSignage object

$.Graph.stackedAndGroupedColumnChart({ data: [[[2133, 969], [357, 838]], [[2733, 54], [598, 68]]], width: 1280, height: 720, labels: ['Coal', 'Oil & Gas', 'Renewable', 'Nuclear'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAndGroupedHorizontalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked and grouped horizontal bar gauges in one layer. No indicator.

Details
$.Graph.stackedAndGroupedHorizontalBarGauge( attributes )

Returns jSignage object

$.Graph.stackedAndGroupedHorizontalBarGauge({ data: [[10, 20], [15, 25]], dataMax: 100, width: 1160, height: 400 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAndGroupedVerticalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked and grouped vertical bar gauges in one layer. No indicator.

Details
$.Graph.stackedAndGroupedVerticalBarGauge( attributes )

Returns jSignage object

$.Graph.stackedAndGroupedVerticalBarGauge({ data: [[10, 20], [15, 25]], dataMax: 100, width: 600, height: 720 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedAreaChart()

in jSignage.Graph # constructor jSignage plugins In content

Stacked area chart layer. Series areas are stacked by summing the values at each position.

Details
$.Graph.stackedAreaChart( attributes )

Negative values are not allowed.

Returns jSignage object

$.Graph.stackedAreaChart({ data: [[10, 20, 30], [5, 15, 25]], width: 1280, height: 720, series: [{ label: 'A' }, { label: 'B' }] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedBarChart()

in jSignage.Graph # constructor jSignage plugins In content

Stacked bar chart layer. Each row of a 2D data array becomes one stack of bars.

Details
$.Graph.stackedBarChart( attributes )

Returns jSignage object

$.Graph.stackedBarChart({ data: [[3101, 838, 357], [2788, 68, 598]], width: 1280, height: 720, labels: ['Fossil Fuel', 'Nuclear', 'Renewable'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedCircularBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked circular bar gauges in one layer. No indicator.

Details
$.Graph.stackedCircularBarGauge( attributes )

Returns jSignage object

$.Graph.stackedCircularBarGauge({ data: [250, 150, 300, 200], dataMax: 1000, width: 1280, height: 740 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedColumnChart()

in jSignage.Graph # constructor jSignage plugins In content

Stacked column chart layer. Each row of a 2D data array becomes one stack of columns.

Details
$.Graph.stackedColumnChart( attributes )

Returns jSignage object

$.Graph.stackedColumnChart({ data: [[3101, 838, 357], [2788, 68, 598]], width: 1280, height: 720, labels: ['Fossil Fuel', 'Nuclear', 'Renewable'] }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedHorizontalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked horizontal bar gauges in one layer. No indicator.

Details
$.Graph.stackedHorizontalBarGauge( attributes )

Returns jSignage object

$.Graph.stackedHorizontalBarGauge({ data: [25, 15, 30], dataMax: 100, width: 1160, height: 300 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.stackedVerticalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Stacked vertical bar gauges in one layer. No indicator.

Details
$.Graph.stackedVerticalBarGauge( attributes )

Returns jSignage object

$.Graph.stackedVerticalBarGauge({ data: [25, 15, 30], dataMax: 100, width: 300, height: 720 }).addTo('svg');

Since Firmware 3.1.0

$.Graph.verticalBarGauge()

in jSignage.Graph # constructor jSignage plugins In content

Vertical bar gauge layer. A progress bar fills from the baseline to the current value.

Details
$.Graph.verticalBarGauge( attributes )

Returns jSignage object

$.Graph.verticalBarGauge({ data: 75, dataMax: 100, width: 340, height: 720, dynamic: true, animationDur: '500ms' }).addTo('svg');

Since Firmware 3.1.0

$.Graph.verticalGauge()

in jSignage.Graph # constructor jSignage plugins In content

Basic vertical gauge layer. An indicator moves along a vertical axis to the current value.

Details
$.Graph.verticalGauge( attributes )

Returns jSignage object

$.Graph.verticalGauge({ data: 75, dataMax: 100, indicator: { shape: 'triangle', position: 'right' } }).addTo('svg');

Since Firmware 3.1.0

$.Multiscreen.anchorTransform

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.anchorTransform

$.Multiscreen.edgeBlending

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.edgeBlending

See the plugin example: setup = $.Multiscreen.setupArray(config) builds the array setup; $.Multiscreen.uncan(setup, layers) and $.Multiscreen.edgeBlending(setup.blending) use it.

$.Multiscreen.parseAspectRatio

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.parseAspectRatio

$.Multiscreen.setAlternativeViewboxes

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.setAlternativeViewboxes

$.Multiscreen.setupArray

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.setupArray

See the plugin example: setup = $.Multiscreen.setupArray(config) builds the array setup; $.Multiscreen.uncan(setup, layers) and $.Multiscreen.edgeBlending(setup.blending) use it.

$.Multiscreen.uncan

in jSignage.Multiscreen # function jSignage plugins In content

Multiscreen plugin function. The wiki lists it without a description or parameters.

Details
$.Multiscreen.uncan

See the plugin example: setup = $.Multiscreen.setupArray(config) builds the array setup; $.Multiscreen.uncan(setup, layers) and $.Multiscreen.edgeBlending(setup.blending) use it.

$.QRCode.ErrorCorrectLevel.H

in errorCorrectLevel # property jSignage plugins In content

Error correction level H (high): 30% of codewords can be restored.

Details
$.QRCode.ErrorCorrectLevel.H

Numeric value 2.

$.QRCode.ErrorCorrectLevel.L

in errorCorrectLevel # property jSignage plugins In content

Error correction level L (low): 7% of codewords can be restored.

Details
$.QRCode.ErrorCorrectLevel.L

Numeric value 1.

$.QRCode.ErrorCorrectLevel.M

in errorCorrectLevel # property jSignage plugins In content

Error correction level M (medium): 15% of codewords can be restored.

Details
$.QRCode.ErrorCorrectLevel.M

Numeric value 0.

$.QRCode.ErrorCorrectLevel.Q

in errorCorrectLevel # property jSignage plugins In content

Error correction level Q (quartile): 25% of codewords can be restored.

Details
$.QRCode.ErrorCorrectLevel.Q

Numeric value 3.

$.QRCode()

# constructor jSignage plugins In content

Draws a QR code layer from a string or array of strings, using Byte encoding (UTF-8).

Details
$.QRCode( attributes )

Dedicated QR code widgets exist in Elementi 2017 and later; use this function for anything else. Versions: 1.0.0 in firmware 3.1.0, 1.0.1 in 3.2.0 (UTF-8 support), 1.1.1 in 4.2.0 and 3.4.0 (typeNumber 'auto'), 1.1.2 in 4.3.0 and 3.4.3.

Returns jSignage object

$.QRCode({ typeNumber: 2, errorCorrectLevel: $.QRCode.ErrorCorrectLevel.L, data: 'https://www.spinetix.com/' }).addTo('svg');

Notes Include jSignage.QRCode.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.QRCode.js"/>. Error 'code length overflow' means typeNumber is too small for the data; increase it.

Since Firmware 3.1.0

$.Social.fromJSON()

in jSignage.Social # method jSignage plugins In content

Converts JSON date strings in the feed data to Date objects.

Details
$.Social.fromJSON

The wiki lists the method without a parameter list.

$.Social.getFeed()

in jSignage.Social # method jSignage plugins In content

Gets the data associated with the provided feed.

Details
$.Social.getFeed

The wiki lists the method without a parameter list.

$.Social.minimumRefreshTime()

in jSignage.Social # method jSignage plugins In content

Returns the minimum refresh time for the provided feed.

Details
$.Social.minimumRefreshTime

The wiki lists the method without a parameter list.

$.UI.feedback()

in jSignage.UI # method jSignage plugins In content

Creates an interactive carousel of smileys to collect user feedback.

Details
$.UI.feedback

The wiki lists it without a parameter list.

$.UI.fingerTouch()

in jSignage.UI # method jSignage plugins In content

Adds a finger animation to show that the screen is interactive.

Details
$.UI.fingerTouch

The wiki lists it without a parameter list.

$.UI.fingerTouchClass

in jSignage.UI # property jSignage plugins In content

Internal class behind fingerTouch(). Not meant to be called directly.

Details
$.UI.fingerTouchClass

$.UI.getPointOnCircle()

in jSignage.UI # method jSignage plugins In content

Calculates a point on a circle from a center point and a radius; the angle can be given or random.

Details
$.UI.getPointOnCircle

The wiki lists it without a parameter list.

$.UI.getTextStyle()

in jSignage.UI # method jSignage plugins In content

Builds a text area style object from two style objects, falling back to default theme values.

Details
$.UI.getTextStyle

The wiki lists it without a parameter list.

$.UI.mergeStyle()

in jSignage.UI # method jSignage plugins In content

Copies attributes from one style object into another.

Details
$.UI.mergeStyle

The wiki lists it without a parameter list.

$.UI.setTheme()

in jSignage.UI # method jSignage plugins In content

Sets the global jSignage theme parameters.

Details
$.UI.setTheme

The wiki lists it without a parameter list.

$.UI.tabs()

in jSignage.UI # method jSignage plugins In content

Creates an interactive horizontal carousel.

Details
$.UI.tabs

The wiki lists it without a parameter list.

$.UI.theme()

in jSignage.UI # method jSignage plugins In content

Gets the global jSignage theme parameters.

Details
$.UI.theme

The wiki lists it without a parameter list.

alignment

in legend # attribute jSignage plugins In content

Alignment in the reserved space: left, center, right (horizontal) or top, center, bottom (vertical).

Details

Type: String.

altAxis

in Circular gauge common attributes # attribute jSignage plugins In content

Continuous axis object for an alternative axis showing the same values in other units.

Details

Type: Plain Object. Default: null. Default position: 'out' on circular gauges, 'top' on horizontal and 'right' on vertical gauges.

altAxis

in Linear gauge common attributes # attribute jSignage plugins In content

Continuous axis object for an alternative axis showing the same values in other units.

Details

Type: Plain Object. Default: null. Default position: 'out' on circular gauges, 'top' on horizontal and 'right' on vertical gauges.

axis

in Common axis styling attributes # attribute jSignage plugins In content

Draws the axis line. true uses axisStrokeStyle; false disables the line and tick marks.

Details

Type: Boolean or Plain Object. With false or null the axis line and tick marks are not drawn; text and gridlines remain.

axis

in Circular gauge common attributes # attribute jSignage plugins In content

Continuous axis object for the main axis; bar gauges do not draw the axis line unless axis.axis is true.

Details

Type: Plain Object. Besides the continuous axis attributes it takes offset and position, and reverse.

axis

in Linear gauge common attributes # attribute jSignage plugins In content

Continuous axis object for the main axis; bar gauges do not draw the axis line unless axis.axis is true.

Details

Type: Plain Object. Besides the continuous axis attributes it takes offset and position.

axis.offset

in axis # attribute jSignage plugins In content

Offset from the selected position in pixels or as a percentage of layer size.

Details

Type: Number or String. Default: 0.

axis.offset

in axis # attribute jSignage plugins In content

Offset from the selected position in pixels or as a percentage of layer size.

Details

Type: Number or String. Default: 0.

axis.position

in axis # attribute jSignage plugins In content

Side of the bar where the axis is drawn: 'in' or 'out'.

Details

Type: Number or String. Default: 'in'.

axis.position

in axis # attribute jSignage plugins In content

Side of the bar where the axis is drawn: top or bottom (horizontal), left or right (vertical).

Details

Type: Number or String. Default: 'bottom' for horizontal gauges, 'left' for vertical.

axis.reverse

in axis # attribute jSignage plugins In content

true draws the gauge anticlockwise, false clockwise.

Details

Type: Boolean. Default: false.

axis.strokeStyle

in axis # attribute jSignage plugins In content

Stroke styling object overriding the chart axisStrokeStyle.

Details

Type: Plain Object.

back.inversed

in back # attribute jSignage plugins In content

true makes the back tip extend inwards instead of outwards.

Details

Type: Boolean. Default: false.

back.length

in back # attribute jSignage plugins In content

Length of the back part, in pixels or as a percentage of the needle length.

Details

Type: String or Number. Default: '25%'.

back.shape

in back # attribute jSignage plugins In content

Back tip shape: 'sharp', 'round' or 'cut'.

Details

Type: String. Default: 'straight'.

back.size

in back # attribute jSignage plugins In content

Back tip size for non-straight tips.

Details

Type: Number. Default: Half of back width.

back.width

in back # attribute jSignage plugins In content

Width at the back, in pixels or as a percentage of indicator width.

Details

Type: String or Number. Default: Aligns back, tip and center.

Bar and column chart common attributes

in jSignage.Graph # property jSignage plugins In content

Attributes accepted by every bar, column, grouped, stacked and percentage chart constructor.

Details

chartArea

in jSignage.Graph # attribute jSignage plugins In content

Object with top, left, width and height placing the chart inside the layer. Valid on every graph layer.

Details

Type: Plain Object. Default: null. By default the chart takes as much space as possible without overlapping the legend box.

colors[].from

in colors # attribute jSignage plugins In content

Minimum value for which this color applies.

Details

Type: Number. Default: The to of the previous range or dataMin.

colors[].from

in colors # attribute jSignage plugins In content

Minimum value for which this color applies.

Details

Type: Number. Default: The to of the previous range or dataMin.

colors[].to

in colors # attribute jSignage plugins In content

Maximum value, not inclusive, for which this color applies.

Details

Type: Number. Default: The from of the next range or dataMax.

colors[].to

in colors # attribute jSignage plugins In content

Maximum value, not inclusive, for which this color applies.

Details

Type: Number. Default: The from of the next range or dataMax.

Common axis styling attributes

in jSignage.Graph # property jSignage plugins In content

Attributes shared by continuous and discrete axis styling objects.

Details

Used inside xAxis and yAxis (charts) and axis and altAxis (gauges).

$.Graph.columnChart({ data: [4, 8, 6], width: 1280, height: 720, xAxis: { axis: true, categories: ['A', 'B', 'C'] }, yAxis: { axis: true, tickMarks: true, minorGridlines: true } }).addTo('svg');

errorCorrectLevel

in $.QRCode() # attribute jSignage plugins In content

Error correction level: $.QRCode.ErrorCorrectLevel.L, M, Q or H.

Details

Type: Number. Default: $.QRCode.ErrorCorrectLevel.M.

frameStyle

in legend # attribute jSignage plugins In content

Stroke styling object for the legend frame; null draws no frame.

Details

Type: Plain Object. Default: null.

gaugeLayer.update()

in jSignage.Graph # method jSignage plugins In content

Sets new gauge data and redraws the gauge, animated or not. Available when dynamic is true.

Details
gauge_layer.update( data )

The data type must match the data attribute of the constructor used. Same for circular and linear gauges.

Returns undefined

var g = $.Graph.circularBarGauge({ data: 60, dataMax: 100, width: 1280, height: 1000, dynamic: true, animationDur: 1 }).addTo('svg');
$.setInterval(function () { g.update(Math.random() * 100); }, 2000);

Related Circular gauge common attributes, Linear gauge common attributes

Indicator styling object

in jSignage.Graph # property jSignage plugins In content

Plain object styling the pointer of a gauge: shape, size, position, color and needle parts.

Details

The indicator marks the current value on the main axis. Passed as the indicator attribute of gauge constructors.

$.Graph.horizontalGauge({ data: 75, dataMax: 100, width: 1160, height: 720, indicator: { color: '#000', position: 'bottom', shape: 'triangle', length: '10%', width: '20%' } }).addTo('svg');

jSignage.Astronomy

# property jSignage plugins In content

Astronomy plugin. Calculations for sun, moon and prayer times, used by the sun and moon and prayer times widgets.

Details
$.Astronomy

Versions: 1.0.0 in firmware 3.2.0, 1.0.1 in 4.0.0.

Notes Include jSignage.Astronomy.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.Astronomy.js"/>. Needs firmware 3.2.0 or later.

Since Firmware 3.2.0

jSignage.CustomEffects

# property jSignage plugins In content

Custom Effects plugin. Effects jSignage does not provide out of the box; used by animated playlist widgets.

Details
$.CustomEffects

Versions: 1.0.0 in firmware 4.2.0 (wiki text also says 4.3.0), 1.1.0 in 4.6.1.

Notes Include jSignage.CustomEffects.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.CustomEffects.js"/>. The wiki link text names jSignage.UI.js but the script tag uses jSignage.CustomEffects.js.

Since Firmware 4.2.0

jSignage.Graph

# property jSignage plugins In content

Graph plugin. Adds the $.Graph object with chart and gauge constructors.

Details
$.Graph

Elementi 3.1 and later ship chart and gauge widgets for basic needs; the methods on $.Graph cover anything else. Versions: 1.0.0 in firmware 3.1.0, 1.0.1 in 3.2.0, 1.0.2 in 4.4.3, 1.0.3 in 3.4.7 and 4.5.0, 1.0.4 in 4.6.1. The wiki API section calls the property jSignage.Graphs; the examples use $.Graph.

Notes Include jSignage.Graph.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.Graph.js"/>. Needs firmware 3.1.0 or later.

Since Firmware 3.1.0

jSignage.Multiscreen

# property jSignage plugins In content

Multiscreen plugin. Calculations for multiscreen projects; Elementi uses it for multiscreen arrays.

Details
$.Multiscreen

Versions: 1.0.0 in firmware 3.2.0, 1.0.1 in 4.0.0, 1.0.2 in 4.2.0 and 3.4.0.

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));
});

Notes Include jSignage.Multiscreen.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.Multiscreen.js"/>. Needs firmware 3.2.0 or later.

Since Firmware 3.2.0

jSignage.Social

# property jSignage plugins In content

Social plugin. Secure connection to third-party data providers and feed retrieval.

Details
$.Social

Providers named: Facebook, Google, Instagram, Microsoft Online, Twitter, Yahoo. Most data-driven widgets in Elementi are built on it. The methods below are called through the jSignage API. Versions run from 1.0.0 (firmware 4.1.0, 3.3.0) to 1.4.0 (firmware 4.7.5).

Notes Include jSignage.Social.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.Social.js"/>.

Since Firmware 3.3.0 / 4.1.0

jSignage.UI

# property jSignage plugins In content

UI plugin. Interactive elements and visual effects such as menus, tabs, cursor, feedback and finger touch hints.

Details
$.UI

Some interactive widgets in Elementi are built on it. Versions: 1.0.0 in firmware 4.3.0 and 3.4.0, 1.1.1 in 4.7.0.

Notes Include jSignage.UI.js after jSignage.js: <script xlink:href="http://download.spinetix.com/spxjslibs/jSignage.UI.js"/>.

Since Firmware 3.4.0 / 4.3.0

legend

in jSignage.Graph # attribute jSignage plugins In content

Legend styling object, or null to remove the legend box. The legend reduces the graph area.

Details

Type: Plain Object. Attributes of the object are listed as children.

$.Graph.pieChart({ data: [1, 2, 3], width: 1280, height: 720, legend: { position: { top: 20 }, orientation: 'horizontal', alignment: 'center', textStyle: { color: 'blue', fontSize: 18 } } }).addTo('svg');

Linear gauge common attributes

in jSignage.Graph # property jSignage plugins In content

Attributes accepted by every horizontal and vertical gauge constructor.

Details

lineDash

in Stroke styling object # attribute jSignage plugins In content

'dots', 'squareDots', 'dashes', 'alternated', or an array of dash and gap lengths in pixels.

Details

Type: String or Array.<Number>. An empty array disables dashing; an odd-length array is repeated twice.

locale

in jSignage.Graph # attribute jSignage plugins In content

Locale used for number formatting on continuous axes; falls back to the global jSignage locale.

Details

Type: String. Default: null. Applies to graphs that allow continuous axes. Accepted codes are the jSignage locale codes.

marker

in jSignage.Graph # attribute jSignage plugins In content

Point marker of a series: true, false or a marker styling object. Used by line, area, scatter and bubble charts.

Details

Type: Boolean or Plain Object. Default: a circle sized from the chart area. The marker styling object attributes are listed as children.

minorGridlines.strokeStyle

in minorGridlines # attribute jSignage plugins In content

Stroke styling object for minor gridlines.

Details

Type: Plain Object. Default: Major gridline style at half the line width.

minorTickMarks.length

in minorTickMarks # attribute jSignage plugins In content

Minor mark length in pixels; double when placement is across.

Details

Type: Number. Default: Half the major tick length.

orientation

in legend # attribute jSignage plugins In content

'vertical' or 'horizontal'.

Details

Type: String. Default: 'horizontal' for top or bottom position, otherwise 'vertical'.

pieResidueSliceColor

in $.Graph.pieChart() # attribute jSignage plugins In content

Color of the residual slice.

Details

Type: Color. Default: '#ccc'. A residual slice is added automatically when some values are too small for their own slice.

pieResidueSliceLabel

in $.Graph.pieChart() # attribute jSignage plugins In content

Label of the residual slice.

Details

Type: String. Default: 'Other'. A residual slice is added automatically when some values are too small for their own slice.

position

in legend # attribute jSignage plugins In content

'right', 'left', 'top', 'bottom', 'in', 'none', or an object with left, top, width and height.

Details

Type: String or Plain Object.

position

in Indicator styling object # attribute jSignage plugins In content

Reference position: 'in', 'out', 'center', 'left', 'right', 'top', 'bottom' or 'bar'.

Details

Type: String. in/out/center apply to circular gauges; left/right to vertical gauges; top/bottom to horizontal gauges; bar to all bar gauges.

quick

in $.QRCode() # attribute jSignage plugins In content

Skips the search for the optimal mask when true.

Details

Type: Boolean. Default: false.

Notes The SpinetiX page also says generation is much faster when quick is false, which contradicts its first sentence.

Series styling attributes

in jSignage.Graph # property jSignage plugins In content

Attributes styling one data series; valid on the layer as general styling or inside each series object.

Details

Used by line, area, scatter and bubble charts. A series styling object is a plain object holding one or more of these attributes.

slices[].offset

in slices # attribute jSignage plugins In content

Slice offset as a fraction of the pie radius; non-zero moves the slice away from the center.

Details

Type: Number. Default: 0.

slices[].strokeStyle

in slices # attribute jSignage plugins In content

Stroke styling object overriding the border of this slice.

Details

Type: Plain Object.

slices[].textInsideStyle

in slices # attribute jSignage plugins In content

Text styling object overriding the inner text style for this slice.

Details

Type: Plain Object.

slices[].textOutsideStyle

in slices # attribute jSignage plugins In content

Text styling object overriding the outer text style for this slice.

Details

Type: Plain Object.

sliceVisibilityThreshold

in $.Graph.pieChart() # attribute jSignage plugins In content

Smallest slice as a fraction of the total; smaller values go into the residue slice.

Details

Type: Number. Default: 0.02.

Stroke styling object

in jSignage.Graph # property jSignage plugins In content

Plain object describing a line: color, width, caps, joins and dashes. Used by every strokeStyle-type attribute.

Details
$.Graph.lineChart({ data: [1, 3, 2], width: 1280, height: 720, strokeStyle: { color: '#ccc', lineDash: 'dots', lineCap: 'round', lineWidth: 4 } }).addTo('svg');

strokeStyle

in legend # attribute jSignage plugins In content

Stroke styling object for the color patches in the legend.

Details

Type: Plain Object.

text

in Circular gauge common attributes # attribute jSignage plugins In content

One or more text description objects: static text or the current value, placed on the gauge.

Details

Type: Plain Object or Array.<Plain Object>. Number-formatted value text is available for single-value gauges only.

text

in Linear gauge common attributes # attribute jSignage plugins In content

One or more text description objects: static text or the current value, placed on the gauge.

Details

Type: Plain Object or Array.<Plain Object>. Number-formatted value text is available for single-value gauges only.

Text styling attributes

in jSignage.Graph # property jSignage plugins In content

Attributes of a text styling object, also valid directly on the graph layer as the top-level default.

Details

A text styling object is a plain object with one or more of these attributes. Lower levels inherit what they do not set.

$.Graph.columnChart({ data: [1, 2, 3], width: 1280, height: 720, textInside: 'value', textInsideStyle: { color: 'white', fontSize: 24, fontWeight: 800 } }).addTo('svg');

text.align

in text # attribute jSignage plugins In content

Horizontal alignment: 'left', 'right' or 'center'.

Details

Type: String. Default: 'center' except beside a bar.

text.angle

in text # attribute jSignage plugins In content

Angle at which the center of the text sits.

Details

Type: Number. Default: (startAngle + endAngle)/2.

text.baseline

in text # attribute jSignage plugins In content

Text baseline: 'top', 'bottom' or 'middle'.

Details

Type: String. Default: 'middle' except above or below a bar.

text.format

in text # attribute jSignage plugins In content

Number format string that shows the current value as text; overrides text.

Details

Type: String. Default: Locale number format.

text.format

in text # attribute jSignage plugins In content

Number format string that shows the current value as text; overrides text.

Details

Type: String. Default: Locale number format.

text.offset

in text # attribute jSignage plugins In content

Offset from the position in pixels or as a percentage of layer size.

Details

Type: Number or String.

text.placement

in text # attribute jSignage plugins In content

'inside' or 'outside' a virtual circle of the given radius, or 'center' at the position.

Details

Type: String. Default: 'inside'.

text.position

in text # attribute jSignage plugins In content

Position relative to the chart area: left, right, top, bottom or center.

Details

Type: String.

text.radius

in text # attribute jSignage plugins In content

Distance from the center to the text center, in pixels or as a percentage of the chart radius.

Details

Type: Number or String. Default: Chart radius.

text.where

in text # attribute jSignage plugins In content

Linear position on the main axis for text above or below a bar: a value, 'center' or 'indicator'.

Details

Type: Number or String.

Thresholds bar styling object

in jSignage.Graph # property jSignage plugins In content

Plain object describing a bar of colored value ranges drawn next to a gauge axis.

Details

Each zone maps a value range to a color and optional start and end sizes. Passed as thresholds, or as bar on linear bar gauges. Set step for a LED-style bar of separate patches.

$.Graph.circularGauge({ data: 75, dataMax: 100, width: 1280, height: 640, indicator: { shape: 'needle' }, thresholds: { position: 'out', size: '6%', zones: [{ to: 40, color: '#0e0' }, { to: 80, color: '#fe0' }, { to: 100, color: '#e00' }] } }).addTo('svg');

tickMarks.length

in tickMarks # attribute jSignage plugins In content

Mark length in pixels; double when placement is across.

Details

Type: Number. Default: Half the font size.

ticks[].f

in ticks # attribute jSignage plugins In content

Text attached to the tick; format is used when omitted.

Details

Type: String.

Since Release 3.2.0

tip.shape

in tip # attribute jSignage plugins In content

Tip shape: 'sharp', 'round' or 'cut'.

Details

Type: String. Default: 'sharp'.

tip.size

in tip # attribute jSignage plugins In content

Tip size for non-straight tips.

Details

Type: Number. Default: Half of tip width.

tip.width

in tip # attribute jSignage plugins In content

Width at the tip, in pixels or as a percentage of indicator width.

Details

Type: String or Number. Default: 0.

type

in marker # attribute jSignage plugins In content

Shape: 'none', 'circle', 'square', 'diamond', 'triangle' or 'star'.

Details

Type: String. Default: 'none' for line and area charts, 'circle' for scatter and bubble charts.

typeNumber

in $.QRCode() # attribute jSignage plugins In content

QR code version, which sets the dot count and capacity; 'auto' calculates it from the data.

Details

Type: Number or String. Default: 2 (maximum 10). 2 is 25 x 25 dots. 'auto' needs 4.2.0 or 3.4.0.

Since Firmware 3.4.0 / 4.2.0 for 'auto'

width

in Indicator styling object # attribute jSignage plugins In content

Indicator width in pixels or as a percentage of the default width.

Details

Type: Number. The default is the indicator length, 10% of length for needles and central indicators on circular gauges, 20% for needles on linear gauges.

zones[].color

in zones # attribute jSignage plugins In content

Fill color of the segment; ignored when both startColor and endColor are set.

Details

Type: Color. Default: 'red'.

zones[].endColor

in zones # attribute jSignage plugins In content

Color at the end of the segment when fill is 'gradient'.

Details

Type: Color. Default: Start color of the next segment.

zones[].endSize

in zones # attribute jSignage plugins In content

Width at the end of the segment.

Details

Type: Number. Default: From the bar startSize and endSize.

zones[].from

in zones # attribute jSignage plugins In content

Start of the value range.

Details

Type: Number. Default: The to value of the previous zone.

zones[].startColor

in zones # attribute jSignage plugins In content

Color at the start of the segment when fill is 'gradient'.

Details

Type: Color. Default: color.

zones[].startSize

in zones # attribute jSignage plugins In content

Width at the start of the segment.

Details

Type: Number. Default: From the bar startSize and endSize.

zones[].to

in zones # attribute jSignage plugins In content

End of the value range.

Details

Type: Number. Default: The from value of the next zone.

uDOM / SVG / SMIL 111

.attr()

in jSignage / $ (jQuery port) # method uDOM / SVG / SMIL In content

Reads or sets raw XML attributes.

Details
.attr(name) | .attr(name, value) | .attr({ ... })

.attr(name) returns the value on the first selected element, or undefined. .attr(name, value) and .attr({ ... }) set on every selected element. Names must be lowercase.

$('#circle').attr( 'r', 50 );
$('#ellipse').attr( { rx: 10, ry: 20 } );

.each()

in jSignage / $ (jQuery port) # method uDOM / SVG / SMIL In content

Runs a function for each selected element; this is the element.

Details
.each(function(index) { ... })
$('#table').children().each( function(index) {
  alert( index + ':' + $(this).text() );
} );

.text()

in jSignage / $ (jQuery port) # method uDOM / SVG / SMIL In content

Reads or sets the text content of selected elements.

Details
.text() | .text(val)

.text() returns the combined unformatted text. .text(val) replaces all text and child elements; on <text> or <textArea> it accepts formatted text from $.tspan() or $.tbreak().

$('#title').text( "Breaking News" );

<auxCmd>

# element uDOM / SVG / SMIL In content

Runs a named command from the serial protocol file on a target device.

Details
<auxCmd target="monitor" command="PowerOn" [param1="..." ... param9="..."] [begin="0"]/>
ParameterTypeDefaultDescription
targetstringMandatory. Must match the target of the protocol file.
commandstringMandatory. Must match the command attribute of an <onStart> in the protocol file.
param1..param9stringOptional. String, number or regular expression; stored in $PARAM1..$PARAM9 in the protocol file.
beginbegin-value-list0When the element becomes active.
<auxCmd command="PowerOn" target="monitor"/>

Notes Also usable inside SMIL playlists as a media object with zero duration. JavaScript equivalent: sendComPort().

Related sendComPort(), <onStart>, <auxCmd> (SMIL)

<auxCmd> (SMIL)

in <body> # element uDOM / SVG / SMIL In content

Media object with zero duration that sends an RS232 command; same syntax as in SVG.

Details
<auxCmd> (SMIL)

Related <auxCmd>

<body>

in <smil> # element uDOM / SVG / SMIL In content

Required. Plays its children in sequence (<seq> semantics).

Details
<body>
<smil>
  <body>
    <seq repeatCount="indefinite">
      <img xml:id="frown" src="frown.jpg" dur="2s"/>
      <img xml:id="smile" src="smile.jpg" dur="2s"/>
    </seq>
  </body>
</smil>

<clipPath>

# element uDOM / SVG / SMIL In content

Clipping path; may contain a single rect, userSpaceOnUse coordinates only.

Details

<excl>

in <body> # element uDOM / SVG / SMIL In content

Exclusive time container (BasicExclTimeContainers module).

Details

<feColorMatrix>

in <filter> # element uDOM / SVG / SMIL In content

Filter primitive. Limited: the matrix does no transfer between alpha and color components.

Details
<feColorMatrix>

Since 3.1.0

<feComposite>

in <filter> # element uDOM / SVG / SMIL In content

Filter primitive. Limited: over, in and out operators only.

Details
<feComposite>

Since 3.1.0

<feImage>

in <filter> # element uDOM / SVG / SMIL In content

Filter primitive. Limited: only with an SVG fragment source.

Details
<feImage>

Since 3.1.0

<filter>

# element uDOM / SVG / SMIL In content

SVG filter element; limited primitive support.

Details
<filter>

Supported with the filter property. Fully supported primitives: feFlood, feGaussianBlur, feMerge, feOffset. Limited: feBlend, feColorMatrix, feComposite, feImage.

Since 3.1.0

<handler>

# element uDOM / SVG / SMIL In content

Holds JavaScript for interactive projects, inline or via xlink:href.

Details
<handler>

Notes SVG Tiny 1.2 has no onload/onclick attributes; use XML Events (listener and handler elements).

Related <script>

<iframe>

# element uDOM / SVG / SMIL In content

Embeds a web page in the SVG document.

Details
<iframe src="..." [sandbox="..."] [frameWidth="..."] .../>

All players except DiVA, firmware 4.0 and above. Zoom is computed from the layer size; use frameWidth to force the page layout width (frameHeight is derived from the layer). Rendering at frameWidth=1024 looks like a 1024 px browser window scaled to the layer.

Since 4.0.0

<layout>

in <smil> # element uDOM / SVG / SMIL In content

Layout section in <head>; must be type text/smil-basic-layout.

Details
<layout>

<region> elements are recognised only if a <root-layout> is present. Alternative: <topLayout>, at most one. OverrideLayout is supported except for z-index.

<layout type="text/smil-basic-layout">
  <root-layout width="640" height="240"/>
  <region id="left" top="0%" left="0%" height="100%" width="50%"/>
  <region id="right" top="0%" left="50%" height="100%" width="50%"/>
</layout>

<par>

in <body> # element uDOM / SVG / SMIL In content

Plays children in parallel; used for multi-zone pages.

Details
<par>
<par dur="5s">
  <img region="left" src="frown.jpg"/>
  <img region="right" src="smile.jpg"/>
</par>

<ref> and synonyms

in <body> # element uDOM / SVG / SMIL In content

Media object; synonyms are animation, audio, img, text, textstream, video.

Details
<ref> and synonyms

The spx attributes cacheMaxAge, buffering, audioDelay, transport, accounting and accounting-tag, and audioPan, are added to it. sensitivity supports only opaque and transparent; mediaOpacity and mediaBackgroundOpacity are supported; chromaKey, chromaKeyOpacity, chromaKeyTolerance are not.

<region>

in <layout> # element uDOM / SVG / SMIL In content

Rectangular zone; media elements refer to it with the region attribute.

Details

<root-layout>

in <layout> # element uDOM / SVG / SMIL In content

Defines the presentation size; needed for <region> to be recognised.

Details
<root-layout>

<script>

# element uDOM / SVG / SMIL In content

Includes JavaScript inline (CDATA) or from xlink:href.

Details
<script xlink:href="..."/> | <script><![CDATA[ ... ]]></script>
<script xlink:href="https://download.spinetix.com/spxjslibs/jSignage.js" />
<script>
  <![CDATA[
    // your code
  ]]>
</script>

Notes text/javascript and application/javascript are accepted as synonyms for text/ecmascript. Inside a SMIL <head> the script runs before the presentation starts.

Related <handler>

<script> (SMIL)

in <smil> # element uDOM / SVG / SMIL In content

In <head>: script run before the presentation starts. As a media object: script run in the time sequence.

Details
<script> (SMIL)

In <head> it runs when the element is added to the rendering tree, so later elements do not exist yet; install a load event handler to run after the whole document loads. As a media object it has zero duration and runs once each time it begins, not on repeat.

<smil>

# element uDOM / SVG / SMIL In content

Root element of a SMIL playlist (index.smil or referenced by <animation>).

Details
<smil>

No namespace or http://www.w3.org/ns/SMIL. MIME type application/smil+xml; extension .smil (application/smil also accepted). Reference it from SVG with <animation>, from SMIL with <ref> or <animation>. <body> is required; a missing <body> is a parse error. SMIL 3.0 modules: Structure, Layout, Media Object, Timing and Synchronization, Animation.

<animation xlink:href='playlist.smil' width='1280' height='720' begin='0' dur='media' repeatDur='indefinite' />

Notes <body> has <seq> semantics; <svg> has <par> semantics.

<spx:multiScreen>

# element uDOM / SVG / SMIL In content

Declares the screens of a multiscreen design space.

Details
<spx:multiScreen><spx:screen viewBox="x y w h" xml:id="..."/>...</spx:multiScreen>

At most one, directly under the top <svg> element. Contains <spx:screen> elements.

<spx:multiScreen>
  <spx:screen viewBox="0 0 1280 720" xml:id="top"/>
  <spx:screen viewBox="0 720 1280 720" xml:id="bottom"/>
</spx:multiScreen>

<spx:screen>

in <spx:multiScreen> # element uDOM / SVG / SMIL In content

One rectangular screen inside <spx:multiScreen>.

Details
<spx:screen viewBox="x y w h" xml:id="id"/>
ParameterTypeDefaultDescription
viewBoxx y w hTop-left point and size of this screen in the design space.
xml:idstringScreen identification name.

<topLayout>

in <layout> # element uDOM / SVG / SMIL In content

Alternative to <root-layout>; at most one.

Details
<topLayout>
<topLayout width="640" height="480">
  <region id="whole" top="0" left="0" width="640" height="480" />
</topLayout>

$.createElement()

in jSignage / $ (jQuery port) # function uDOM / SVG / SMIL In content

Creates an element with attributes in one call; returns a jSignage object.

Details
$.createElement(name, { ... })
ParameterTypeDefaultDescription
namestringElement name.
attributesobjectAttributes to set.

Returns jSignage object

var r = $.createElement( 'rect', { x: 0, y: 0, width: 1280, height: 720, fill: '#ffbbbb' } );

Related $('<...>')

allow

# attribute uDOM / SVG / SMIL In content

allow="spx-api" on a web page layer enables the Shared Variables and COM JavaScript APIs there.

Details
allow

Disabled by default. Release 4.7.0.

Since 4.7.0

Related spx (HTML5 global object)

animation referencing SVG

# element uDOM / SVG / SMIL In content

<animation> can reference SVG files besides video and image files.

Details
animation referencing SVG

audio-pan

# attribute uDOM / SVG / SMIL In content

Spatial position of the media in degrees, -180 to 180; 180 swaps stereo channels.

Details

Elliptical arc path commands

# attribute uDOM / SVG / SMIL In content

Arcs are supported in <path> data and in animation paths.

Details
Elliptical arc path commands

filter (property)

in <filter> # attribute uDOM / SVG / SMIL In content

Applies a <filter> to an element.

Details
filter (property)

Since 3.1.0

getElementsByTagName()

# function uDOM / SVG / SMIL In content

Returns all descendant elements with a given tag name.

Details
getElementsByTagName(name)

For tree traversal you can also use getElementById(), ElementTraversal (firstElementChild, lastElementChild, previousElementSibling, nextElementSibling) and localName.

Returns Collection of Elements

Since 3.1.0

iframe@frameWidth

in <iframe> # attribute uDOM / SVG / SMIL In content

Width used to render the page; may differ from the display width.

Details
iframe@frameWidth

Default: the display width. Prefer frameWidth alone; frameHeight follows the layer size.

iframe@sandbox

in <iframe> # attribute uDOM / SVG / SMIL In content

Space-separated options: allow-top-navigation, allow-scripts, allow-same-origin.

Details
iframe@sandbox

allow-top-navigation lets the user change the top-level page. allow-scripts lets the page run JavaScript. allow-same-origin lets a local file open a remote URI and disables CORS.

iframe@scrollX, scrollY

in <iframe> # attribute uDOM / SVG / SMIL In content

Scroll position of pages larger than the display.

Details
iframe@scrollX, scrollY

Notes Applies to HMP300 and HMP350.

iframe@spx:scrollbar

in <iframe> # attribute uDOM / SVG / SMIL In content

auto, hidden (wheel still scrolls) or disabled (no bar, no scrolling).

Details
iframe@spx:scrollbar

iframe@spx:userAgent

in <iframe> # attribute uDOM / SVG / SMIL In content

Custom user agent for fetching the page.

Details
iframe@spx:userAgent

iframe@zoom

in <iframe> # attribute uDOM / SVG / SMIL In content

Zoom factor. Removed in 4.5.0; zoom is now computed from the layer size.

Details
iframe@zoom

Notes Use frameWidth instead.

image referencing SVG

# element uDOM / SVG / SMIL In content

<image> can reference an SVG file; animated files show at document time 0 or the snapshot time.

Details
image referencing SVG

jSignage / $ (jQuery port)

# function uDOM / SVG / SMIL In content

jSignage(selector) wraps SVG elements; $ is the shortcut. Port of jQuery 1.5.1 and 1.11.0 to the SVG Tiny 1.2 uDOM.

Details
jSignage(selector) | $(selector)

Only DOM manipulation, interactive events and AJAX are ported. Attribute names must be lowercase (they are case-sensitive).

$('#swan').attr( 'fill', 'black' );

KeyboardEvent

# event uDOM / SVG / SMIL In content

uDOM KeyboardEvent extended with modifier keys.

Details
interface KeyboardEvent : UIEvent { keyIdentifier; ctrlKey; shiftKey; altKey; metaKey }

KeyboardEvent.ctrlKey

in KeyboardEvent # property uDOM / SVG / SMIL In content

Read-only boolean; true when the modifier is pressed.

Details
KeyboardEvent.ctrlKey

KeyboardEvent.keyIdentifier

in KeyboardEvent # property uDOM / SVG / SMIL In content

Read-only DOMString; the key identifier (SVG Tiny 1.2 key identifiers set).

Details
KeyboardEvent.keyIdentifier

KeyboardEvent.metaKey

in KeyboardEvent # property uDOM / SVG / SMIL In content

Read-only boolean; true when the modifier is pressed.

Details
KeyboardEvent.metaKey

KeyboardEvent.shiftKey

in KeyboardEvent # property uDOM / SVG / SMIL In content

Read-only boolean; true when the modifier is pressed.

Details
KeyboardEvent.shiftKey

linearGradient@href, radialGradient@href

# attribute uDOM / SVG / SMIL In content

Reuses the stop list of an earlier gradient.

Details
linearGradient@href, radialGradient@href

Not supported jQuery methods

in jSignage / $ (jQuery port) # property uDOM / SVG / SMIL In content

jQuery CSS, effects, forms, data and .prop() methods are not ported (list not exhaustive).

Details
Not supported jQuery methods

Use jSignage layers for styling, animation events for animation, interactive layers for forms. The jQuery .data() family and .prop() are not available.

opacity

# attribute uDOM / SVG / SMIL In content

Opacity attribute; may be applied to any element, including <g>.

Details

smil@playbackOrder

in <smil> # attribute uDOM / SVG / SMIL In content

Value 'all' allows seeking backward into a scripted document without reloading it.

Details
smil@playbackOrder

Effective only if the SMIL playlist is the root document.

smil@preserveAspectRatio

in <smil> # attribute uDOM / SVG / SMIL In content

Scales the SMIL viewport inside a parent media element viewport.

Details
smil@preserveAspectRatio

Effective only if the SMIL playlist is the root document.

smil@snapshotTime

in <smil> # attribute uDOM / SVG / SMIL In content

Document time used when taking a snapshot of the presentation.

Details
smil@snapshotTime

Effective only if the SMIL playlist is the root document.

spx:accounting

# attribute uDOM / SVG / SMIL In content

Value "open,close" adds a resource to the accounting log.

Details
spx:accounting

Example: spx:accounting="open,close".

spx:accounting-tag

# attribute uDOM / SVG / SMIL In content

Text put in the last column of the accounting log for this media.

Details
spx:accounting-tag

Eases parsing of the accounting log by user applications.

spx:audio

# attribute uDOM / SVG / SMIL In content

Selects an audio track by language code (ENG, FRA, SPA), QAA (original), QAD (audio description) or #n.

Details
spx:audio

4.0.1 for MPEG-TS streams; 4.8.0 for files with several audio tracks; #n syntax from 4.8.4.

Since 4.0.1

spx:audioDelay

# attribute uDOM / SVG / SMIL In content

Audio/video delay on animation and video elements; positive delays audio, negative advances it.

Details
spx:audioDelay

Meaningful values are between -200ms and 500ms.

spx:audioPID

# attribute uDOM / SVG / SMIL In content

Selects an audio track of a streaming video by PID.

Details
spx:audioPID

Since 4.0.1

spx:buffering

# attribute uDOM / SVG / SMIL In content

Overrides the stream buffering duration on streaming media (seconds by default).

Details
spx:buffering

On animation, video and audio. Negative values (4.0.2) reduce latency; watch for buffer underflow. No effect on files.

spx:cacheMaxAge

# attribute uDOM / SVG / SMIL In content

Overrides the caching instructions of a remote file.

Details
spx:cacheMaxAge

Values: 0 (no cache, downloads on every request), seconds such as 3600s (revalidate after that time), indefinite (use the server's time), disable (3.0.6; for progressive-download media only, other use may freeze and reboot the player). On image, video, audio, animation.

spx:customHeaders

# attribute uDOM / SVG / SMIL In content

Extra HTTP headers sent when fetching media or a web page.

Details
spx:customHeaders

Added for iframe in 4.0.0; on all media elements from 4.3.0, for example for servers using header-based authentication.

Since 4.0.0

spx:mask-href

# attribute uDOM / SVG / SMIL In content

Mask video for video with transparency: black is transparent, white opaque.

Details
spx:mask-href

Put it on the video element. Black and white video only.

Since 4.1.0

spx:maxDemuxingBufferSize

# attribute uDOM / SVG / SMIL In content

Maximum audio/video demuxing buffer in bytes.

Details
spx:maxDemuxingBufferSize

Default 3145728 for streams and 1048576 for files. Use only against "Stream demuxing failed" errors in player.log.

spx:multiScreenId

# attribute uDOM / SVG / SMIL In content

Conditional attribute: switches parts of the document on or off by screen ID.

Details
spx:multiScreenId

spx:overrideFPS

# attribute uDOM / SVG / SMIL In content

Overrides the frame rate reported by a stream or file header.

Details
spx:overrideFPS

Integer such as 24, or a fraction such as 30000/1001.

Since 3.1.0

spx:packetization

# attribute uDOM / SVG / SMIL In content

Packet type for RTP/RTSP streaming: any (default) or compliant.

Details
spx:packetization

compliant skips some processing and gains up to 1 frame of latency for MPEG2/MPEG4 and 2 for H.264; no effect on MPEG transport streams.

Since 4.1.0

spx:program

# attribute uDOM / SVG / SMIL In content

Selects a program of a streaming video by PID.

Details
spx:program

Since 4.0.1

spx:rangeRequests

# attribute uDOM / SVG / SMIL In content

spx:rangeRequests="off" disables HTTP byte range requests on media layers.

Details
spx:rangeRequests

For servers that do not support them properly.

Since 4.8.4

spx:recipes-href

# attribute uDOM / SVG / SMIL In content

Recipe file for the Web Robot on a web page layer.

Details
spx:recipes-href

Since 4.5.0

spx:secureContext

# attribute uDOM / SVG / SMIL In content

spx:secureContext="on" renders a web page layer in a secure context.

Details
spx:secureContext

Default off. Gives access to restricted HTML APIs such as audio and video capture, but blocks loading of HTTP content.

Since 4.8.3

spx:silent

# attribute uDOM / SVG / SMIL In content

spx:silent="true" hides the rotating-dots animation while connecting to a stream.

Details
spx:silent

On video elements.

spx:start-at-random-time

# attribute uDOM / SVG / SMIL In content

On <svg>: prevents scripts running from the scheduled start time of the document.

Details
spx:start-at-random-time

Avoids player reboots (and Safe mode) and lets Shared Variable set() calls work in scheduled content. Needs xmlns:spx="http://www.spinetix.com/namespace/1.0/spx".

spx:subtitles

# attribute uDOM / SVG / SMIL In content

Enables and selects a subtitle track: ON, a language code, CC, CC1..CC4.

Details
spx:subtitles

Video files or streams. HMP400/W, iBX410/W, iBX440, third-party DSOS players. Formats: EIA-708, Teletext, DVB, DVD, Blu-ray, SRT, ASS/SSA.

Since 4.8.0

spx:subtitlesFormat

# attribute uDOM / SVG / SMIL In content

Subtitle appearance as ASS V4 style key-value pairs.

Details
spx:subtitlesFormat

Fields: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, TertiaryColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding. Colours are &HBBGGRR& or &HAABBGGRR&; booleans -1 and 0. Does not apply to bitmap (DVB) or hybrid (Teletext) subtitles.

<video xlink:href="..." spx:subtitles="on" spx:subtitlesFormat="Fontname=Arial,Fontsize=18,PrimaryColour=&Hff0000&"/>

Since 4.8.0

spx:subtitlesPID

# attribute uDOM / SVG / SMIL In content

Selects a subtitle track of a streaming video by PID.

Details
spx:subtitlesPID

Since 4.8.0

spx:syncVar

# attribute uDOM / SVG / SMIL In content

Shared Variable used to sync a streaming video across a multiscreen.

Details
spx:syncVar

For MPEG2-TS multicast over RTP or UDP only. Value like sync@spx-hmp-001d50200015.local, located on one of the players of the multiscreen.

Since 4.1.0

Related createSharedVariable()

spx:transport

# attribute uDOM / SVG / SMIL In content

Transport for RTP packets with RTSP streaming: tcp, unicast or multicast.

Details
spx:transport

tcp interleaves RTP in the RTSP connection (works through NAT and firewalls, but head-of-line blocking can add delay). No value: server default.

spx:videoPID

# attribute uDOM / SVG / SMIL In content

Selects a video track of a streaming video by PID.

Details
spx:videoPID

Since 4.0.1

style

# attribute uDOM / SVG / SMIL In content

Style attribute on any element; may hold any supported SVG property.

Details

svg@dur

# attribute uDOM / SVG / SMIL In content

Time kept as the media duration of the document.

Details
<svg dur="...">

video / audio streaming sources

# element uDOM / SVG / SMIL In content

<video> and <audio> accept live streaming sources.

Details
video / audio streaming sources

Player JavaScript 98

%c{decimal}

in <write> # function Player JavaScript In content

Escape for a non-printable character in a protocol string.

Details
%c{decimal_number}

Required for the C0 control range (&#x00; to &#x1F;) except tab (%c{9}), LF (%c{10}) and CR (%c{13}), which also accept character references. Example: %c{2} is STX.

%s{$n}

in <onInput> # function Player JavaScript In content

Inserts a captured group or parameter into a protocol string.

Details
%s{$1}

Used in update and write attributes after an onInput match with capture groups.

<complete>

in <state> # element Player JavaScript In content

Action: reports the result of the command.

Details
<complete status='success'/>

Used in the send-and-receive example after <write>. The wiki shows only status='success'.

<fire>

in <state> # element Player JavaScript In content

Action: fires an interactive event from received serial data.

Details
<fire>

Named in the wiki as the alternative to <update> inside onInput. Its attributes are documented only in the Serial Port Technical Guide, not in the wiki.

Related fireSharedEvent()

<onInput>

in <state> # element Player JavaScript In content

Transition run when characters received on the serial port match a pattern.

Details
<onInput match="..." goto="...">

Matching uses either the data attribute or the match attribute (regular expression with capture groups, available as %s{$1}, %s{$2}). Inside it use <update> to set a Shared Variable or <fire> to fire an interactive event.

<onInput match="(var_[a-z]*)=([a-zA-Z0-9]*)&#x0D;&#x0A;" >
  <update name='%s{$1}' value='%s{$2}' />
  <write data='OK %s{$1} set to %s{$2}&#x0D;&#x0A;' />
  <complete status='success' />
</onInput>

<onStart>

in <state> # element Player JavaScript In content

Transition run when a named command is requested (auxCmd, sendComPort or a screen control widget).

Details
<onStart command='PowerOn' goto='start'>

command must match the command attribute of auxCmd or the second argument of sendComPort. goto names the next state. Child actions such as <write> run on entry.

<onStart command='PowerOn' goto='start'>
  <write data='&#xAA;%c{17}&#xFF;%c{1}%c{1}%c{18}'/>
</onStart>

Related <auxCmd>, sendComPort()

<onTest>

in <state> # element Player JavaScript In content

Transition taken when a variable (such as a command parameter) equals a string.

Details
<onTest var='$PARAM1' stringEqualTo='HDMI1' goto='start'>

Used after an onStart command that passes parameters, to branch on $PARAM1...$PARAM9.

<onTest var='$PARAM1' stringEqualTo='HDMI1' goto='start'>
  <write data='%c{1}&#x30;&#x41;%c{3}&#x72;&#x0d;'/>
</onTest>

<protocol>

# element Player JavaScript In content

Root element of a serial port protocol (.fsm) file; a finite state machine.

Details
<protocol>

The .fsm file describes how actions to or from the player map to strings on the serial cable. Inputs: control action requests, characters received, timer expiry. Outputs: characters sent, interactive events for JavaScript, Shared Variable updates, logs. Namespace: http://www.spinetix.com/namespace/1.0/spx. Upload via Control Center, Peripherals, Serial Port Automation (Advanced), then set it Active and restart.

<protocol xmlns='http://www.spinetix.com/namespace/1.0/spx' desc='protocol' startup='start' target='monitor'>
  <state xml:id='start'>
    <onStart command='PowerOn' goto='start'>
      <write data='%c{2}%c{1}'/>
    </onStart>
  </state>
</protocol>

Notes Debug the file in SPP Studio (deprecated). Built-in files: LG LF65, Panasonic plasma, Sharp Aquos, NMEA-GPS.

<state>

in <protocol> # element Player JavaScript In content

A state of the machine; holds transitions.

Details
<state xml:id='start'>

xml:id is the name used by startup and goto.

<update>

in <state> # element Player JavaScript In content

Action: updates a Shared Variable.

Details
<update name='menu' value='L1'/>

name and value accept %s{$n} references to captured groups.

<onInput match="1" >
  <update name='menu' value='L1' />
</onInput>

Related createSharedVariable()

<write>

in <state> # element Player JavaScript In content

Action: sends characters on the serial port.

Details
<write data='...'/>

Non-printable characters: %c{decimal} for C0 control codes (%c{0} is NUL), or &#xHH; / &#NN; numeric character references for other XML-allowed characters. Tab, LF and CR may use either form. Captured text: %s{$1}.

Notes Firmware 3.0.0 and 3.0.1 do not send NUL (known issue). Before 2.2.2 NUL had to be written &#xFF00;.

Buffer (Node.js)

# constructor Player JavaScript In content

Node.js Buffer: binary data for serial packets and sockets.

Details
new Buffer(size)

Supported Node.js modules: Buffer, Events, Net, Stream and dgram (UDP). Used with writeCOMPort() and as the data attribute of the com event.

var buf = new Buffer( 256 );
buf.writeUInt32LE( 0xbadcaffe, 0 );
buf.write( "Hello", 4, 32, "utf8" );
writeCOMPort( buf );

Since 3.0.0

Related writeCOMPort(), com event

com event

# event Player JavaScript In content

Fires on document when data arrives on the serial port.

Details
document.addEventListener("com", function(ev) { ... })

The listener receives a COMEvent with bytes, data and portNumber.

document.addEventListener( "com", function( ev ) {
  alert( 'received: ' + ev.data.toString() );
  alert( 'first byte is: ' + ev.bytes[0] );
});

Since 3.0.0

Related writeCOMPort()

COMEvent.bytes

in com event # property Player JavaScript In content

Uint8Array with the content read from the serial port.

Details
COMEvent.bytes

COMEvent.data

in com event # property Player JavaScript In content

Node.js Buffer with the content read from the serial port.

Details
COMEvent.data

Date.localTime()

# function Player JavaScript In content

Timezone conversion helper added to Date.

Details
Date.localTime() | Date.timeLocal()

The release notes name Date.localTime() and Date.timeLocal() as functions supporting timezone conversion. Signature and semantics are not documented in the wiki.

Since 3.1.0

Related Date.timeLocal()

Date.timeLocal()

# function Player JavaScript In content

Timezone conversion helper added to Date.

Details
Date.timeLocal()

Named in the 3.1.0 release notes together with Date.localTime(). Signature is not documented in the wiki.

Since 3.1.0

Related Date.localTime()

DEVICE_NAME

# property Player JavaScript In content

Global variable with the player device name.

Details
DEVICE_NAME

Set to "[not defined]" in Elementi.

var uri = document.getElementById( "rss_uri" ).textContent + DEVICE_NAME;

deviceInfo

# property Player JavaScript In content

Global object with extended information about the player or the PC running Elementi.

Details
deviceInfo

Properties: deviceName, deviceType, multiScreenId, serialNumber, userSerialNumber, boardSerialNumber, systemSerialNumber, chassisSerialNumber, firmwareVersion, hostName. Function: getNetworkInterfaces().

Since 3.0.0

deviceInfo.boardSerialNumber

in deviceInfo # property Player JavaScript In content

Board serial number or "null".

Details
deviceInfo.boardSerialNumber

deviceInfo.chassisSerialNumber

in deviceInfo # property Player JavaScript In content

Chassis serial number or "null".

Details
deviceInfo.chassisSerialNumber

deviceInfo.deviceName

in deviceInfo # property Player JavaScript In content

Device name, or "[not defined]" in Elementi. Same as DEVICE_NAME.

Details
deviceInfo.deviceName

deviceInfo.deviceType

in deviceInfo # property Player JavaScript In content

Hardware type code: utsubaki, ume, fukiran, ikebana, Sakura, Bonsai or windows.

Details
deviceInfo.deviceType

Hardware type: utsubaki (iBX440), ume (iBX410, iBX410W), fukiran (HMP400, HMP400W), ikebana (HMP300, HMP350), Sakura (HMP200), Bonsai (HMP130, HMP100), windows (Elementi).

deviceInfo.firmwareVersion

in deviceInfo # property Player JavaScript In content

Firmware or Elementi version string.

Details
deviceInfo.firmwareVersion

Firmware or Elementi version, formatted major.minor.update-releaseBuild.number.internalBuild. releaseBuild is 0 for betas and 1, 2, 3... for stable releases.

deviceInfo.getNetworkInterfaces()

in deviceInfo # method Player JavaScript In content

Returns the network interfaces and their addresses.

Details
deviceInfo.getNetworkInterfaces()

Each interface has running (boolean link state), type (ethernet, modem, wlan or wwan), physicalAddress (usually a MAC), IPv4Addresses (array of address, netmask, optional broadcast, destination for modems) and IPv6Addresses (array of address, netmask).

Returns Object with one property per interface (eth0, eth1, ...)

deviceInfo.hostName

in deviceInfo # property Player JavaScript In content

Hostname of the player, or the PC name in Elementi.

Details
deviceInfo.hostName

deviceInfo.multiScreenId

in deviceInfo # property Player JavaScript In content

Multiscreen ID, or "fullscreen" in Elementi. Same as MULTI_SCREEN_ID.

Details
deviceInfo.multiScreenId

deviceInfo.serialNumber

in deviceInfo # property Player JavaScript In content

Player serial number, or "[not defined]" in Elementi. Same as SERIAL_NUMBER.

Details
deviceInfo.serialNumber

deviceInfo.systemSerialNumber

in deviceInfo # property Player JavaScript In content

System serial number or "null".

Details
deviceInfo.systemSerialNumber

deviceInfo.userSerialNumber

in deviceInfo # property Player JavaScript In content

User player serial number of HMP400 and HMP400W; "null" otherwise.

Details
deviceInfo.userSerialNumber

dgram (Node.js)

# function Player JavaScript In content

Node.js UDP / Datagram Sockets module.

Details
dgram (Node.js)

Lets content create UDP sockets and servers. Node.js docs for v7.x apply.

Since 3.0.0

events (Node.js)

# constructor Player JavaScript In content

Node.js Events module (EventEmitter).

Details
events (Node.js)

Supported with Net, Stream, Buffer and dgram. Node.js docs for v7.x apply.

Since 3.0.0

GETURL_ALWAYS_CHECK

in getURL() # property Player JavaScript In content

getURL flag (4): forces a very short caching time so every request checks the server.

Details
GETURL_ALWAYS_CHECK = 4

Ignores the headers the server returns. Increases network traffic. The release notes state it limits caching time to 10 s.

Since 3.0.1

GETURL_CACHE_CONTENT

in getURL() # property Player JavaScript In content

getURL flag (1): saves the resource in the player cache.

Details
GETURL_CACHE_CONTENT = 1

GETURL_TRACK_CHANGES

in getURL() # property Player JavaScript In content

getURL flag (2): detects server-side changes and calls the callback again.

Details
GETURL_TRACK_CHANGES = 2

getURL()

# function Player JavaScript In content

Fetches a remote (http, https) or local (file) resource; the player adds a flags argument.

Details
getURL(iri, callback, flags)

Without flags there is no caching and no change tracking. Recommended value: GETURL_CACHE_CONTENT|GETURL_TRACK_CHANGES. Extended from the SVG Tiny 1.2 SVGGlobal definition.

ParameterTypeDefaultDescription
iriDOMStringResource to fetch. http(s) for remote, file for local.
callbackAsyncStatusCallbackCalled with the status object; always asynchronous.
flagsunsigned shortOptional bit flags: GETURL_CACHE_CONTENT, GETURL_TRACK_CHANGES, GETURL_ALWAYS_CHECK.

Returns void

getURL( 'http://example.com/data.xml', function( status ) {
  if ( status.success ) { alert( status.content ); }
}, GETURL_CACHE_CONTENT | GETURL_TRACK_CHANGES );

Related GETURL_CACHE_CONTENT, GETURL_TRACK_CHANGES, GETURL_ALWAYS_CHECK

HTML Canvas 2D Context

# property Player JavaScript In content

Canvas 2D context API for drawing on a canvas surface.

Details
canvas.getContext('2d')

Implements the W3C HTML Canvas 2D Context (CR 2012-12-17). The <canvas> element is supported in SVG since firmware 3.1.0.

Since 3.1.0

Related <canvas>

iCalendar.getScheduleAsJSON()

in parseICAL() # method Player JavaScript In content

Returns the event instances of a period as an array of objects.

Details
Array getScheduleAsJSON(startDate, endDate, maxCount)

A recurring event gives one object per instance.

ParameterTypeDefaultDescription
startDateDateStart of the period.
endDateDateEnd of the period.
maxCountlong100Maximum number of events to return.

Returns Array of objects: title, description, startDate (Date), endDate (Date), enclosure (event URL), location

Since 3.0.0

iCalendar.getScheduleAsRSS()

in parseICAL() # method Player JavaScript In content

Builds an RSS-shaped XML tree with one item per event instance.

Details
Node getScheduleAsRSS(startDate, endDate, contextDoc, dateFormat)

Summary maps to <title>, Description to <description>, start and end to <startDate> and <endDate>. A recurring event gives several items.

ParameterTypeDefaultDescription
startDateDateStart of the period.
endDateDateEnd of the period.
contextDocDocumentContext document.
dateFormatDOMStringOptional strftime format for dates. Default is RFC822.

Returns Node

Image

# constructor Player JavaScript In content

HTMLImageElement: read the pixel size of a local or remote image.

Details
new Image()

Asynchronous. Create the object, install onload, then set src. onload runs when the size is known; onerror runs when it cannot be determined.

var img = new Image();
img.onload = function() {
  alert( this.width + 'x' + this.height );
};
img.onerror = function() {
  alert( 'size unknown' );
};
img.src = 'http://example.com/logo.png';

Notes Experimental in 3.0.0, stable in 3.1.0.

Since 3.0.0

Image.onerror

in Image # event Player JavaScript In content

Callback run when the size cannot be determined.

Details
img.onerror = function() { ... }

Image.onload

in Image # event Player JavaScript In content

Callback run when the resource size is known.

Details
img.onload = function() { this.width; this.height; }

Image.src

in Image # attribute Player JavaScript In content

URI of the local or remote graphic resource to measure.

Details
img.src = uri

Set it after installing onload.

Image.width / Image.height

in Image # property Player JavaScript In content

Pixel size of the resource, read inside onload.

Details
this.width | this.height

JavaScript engine

# property Player JavaScript In content

Players run the SpiderMonkey 17 JavaScript engine.

Details
JavaScript engine

Firmware 2.2.x: SpiderMonkey 1.8.0 (ECMAScript 3). Firmware 3.0.0: SpiderMonkey 1.8.5 (ECMAScript 5). Firmware 3.1.0: SpiderMonkey 17. Release 3.1.0 adds typed arrays and JSON.parse().

Notes Debug with the Developer Console in Elementi X, or alert(); alert output goes to player.log on the player.

Since 3.1.0

logAtLevel()

# function Player JavaScript In content

Writes a message to the player log at a chosen level.

Details
logAtLevel(logLevel, logText)
ParameterTypeDefaultDescription
logLevelDOMStringLOG_LEVEL_TRACE, LOG_LEVEL_DEBUG, LOG_LEVEL_INFO, LOG_LEVEL_WARN or LOG_LEVEL_ERROR.
logTextDOMStringMessage text.

Returns void

logAtLevel( LOG_LEVEL_ERROR, "Houston, we have a problem." );

MULTI_SCREEN_ID

# property Player JavaScript In content

Global variable with the multiscreen ID of the player.

Details
MULTI_SCREEN_ID

Set to "fullscreen" in Elementi.

if ( MULTI_SCREEN_ID == 'Tokio' ) {
  // content for this screen
}

navigator

# property Player JavaScript In content

Global navigator object with SpinetiX-specific clock, cloud and license data.

Details
navigator

userAgent is "SpinetiX". The spx* properties are listed as separate entries.

navigator.spxAudioPlayer

in navigator # property Player JavaScript In content

Object describing the embedded audio player.

Details
navigator.spxAudioPlayer

Object with details about the embedded audio player.

navigator.spxCloudStage

in navigator # property Player JavaScript In content

Cloud stage the player or Elementi belongs to.

Details
navigator.spxCloudStage

The cloud stage, for example "prod", for the player or Elementi.

navigator.spxDocumentTime

in navigator # property Player JavaScript In content

Document rendering time.

Details
navigator.spxDocumentTime

The document rendering time.

navigator.spxLicenseFeatures

in navigator # property Player JavaScript In content

Object listing the features activated by the license.

Details
navigator.spxLicenseFeatures

Object with details about the software features activated by the current license or Feature Set.

navigator.spxNetworkClock

in navigator # property Player JavaScript In content

Date and time of the device or PC.

Details
navigator.spxNetworkClock

The date and time of the device or PC.

navigator.spxWallClock

in navigator # property Player JavaScript In content

Date and time of the content.

Details
navigator.spxWallClock

The date and time of the content.

navigator.userAgent

in navigator # property Player JavaScript In content

User agent string, always "SpinetiX".

Details
navigator.userAgent

Set to "SpinetiX".

net (Node.js)

# function Player JavaScript In content

Node.js Net module: create TCP sockets and servers.

Details
net (Node.js)

Lets content open TCP sockets and servers, for example to talk to a controller. Node.js docs for v7.x apply.

Since 3.0.0

onInput@data

in <onInput> # attribute Player JavaScript In content

Alternative to match for matching the received characters.

Details

onInput@match

in <onInput> # attribute Player JavaScript In content

Pattern for the received characters; capture groups are $1, $2...

Details

parseCSV()

# function Player JavaScript In content

Parses CSV text into an XML node tree.

Details
Node parseCSV(data, contextDoc, ...)
ParameterTypeDefaultDescription
dataDOMStringCSV text.
contextDocDocumentContext document; pass null.
...DOMStringOptional column names. Without them, column names come from the first line.

Returns Node, or null on error

parseCSV( data );
parseCSV( data, null, "title", "description", "price" );

Notes The wiki recommends parseCSV2().

Related parseCSV2()

parseCSV2()

# function Player JavaScript In content

Parses CSV text into an array of JavaScript objects.

Details
Array parseCSV2(data, separator, columnNames, keepNSWSP, keepQuotes)
ParameterTypeDefaultDescription
dataDOMStringCSV text.
separatorDOMString','Value separator character.
columnNamesArrayProperty names of the returned objects. If undefined, the first line of the CSV is used.
keepNSWSPbooleanfalseKeep white space at the left and right of values.
keepQuotesbooleanfalseSkip quote processing and return the quotes.

Returns Array of objects

var rows = parseCSV2( data, ",", [ "title", "description", "price" ] );

Notes CSV saved by Excel normally has the column names on the first line.

Since 3.0.0

Related parseCSV()

parseICAL()

# function Player JavaScript In content

Parses an iCalendar (RFC 2445) stream into an iCalendar object.

Details
iCalendar parseICAL(data)

The returned object has getScheduleAsRSS() and getScheduleAsJSON().

ParameterTypeDefaultDescription
dataDOMStringiCalendar text.

Returns iCalendar object, or null if the data is not valid

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 );

Related iCalendar.getScheduleAsRSS(), iCalendar.getScheduleAsJSON()

parseRSS()

# function Player JavaScript In content

Parses RSS or Atom (including malformed feeds) into a clean XML tree.

Details
Node parseRSS(data, contextDoc, baseURI)

Recognised elements: title, description, enclosure, pubDate. The wiki recommends parseRSS2().

ParameterTypeDefaultDescription
dataDOMStringFeed text.
contextDocDocumentContext document.
baseURIDOMStringOptional, seldom needed.

Returns Node with an <rss> root and <item> children

Related parseRSS2()

parseRSS2()

# function Player JavaScript In content

Parses RSS or Atom (including malformed feeds) into an array of item objects.

Details
Array parseRSS2(data, baseURI, channel, multilineTitles)

enclosure is the enclosure or url field, or the src of an <img> tag in the description.

ParameterTypeDefaultDescription
dataDOMStringFeed content.
baseURIDOMStringBase URI for RSS URIs; leave blank.
channelDOMStringReturn only the items of this channel. Default: all channels.
multilineTitlesbooleanfalsefalse returns only the first line of the title.

Returns Array of objects: channel, channelTitle, channelDescription, image, item, enclosure, title, description, pubDate

Since 3.0.0

Related parseRSS()

parseXML()

# function Player JavaScript In content

Parses a string as an XML document.

Details
Node parseXML(data, contextDoc)
ParameterTypeDefaultDescription
dataDOMStringXML text.
contextDocDocumentContext document.

Returns Node, or null if the XML is not well-formed

var doc = parseXML( '<top><child/></top>' );
alert( doc.documentElement.firstElementChild.localName );

propFindURL()

# function Player JavaScript In content

WebDAV PROPFIND on a remote or local URL; lists directories.

Details
propFindURL(url, callback, depth)

Remote servers need WebDAV enabled. If status.success is true, status.contentType is "application/json" and status.content is an array of objects with the properties filename, href, creationdate, getcontentlength, getetag, getlastmodified, resourcetype. Useful for building automatic playlists from a folder.

ParameterTypeDefaultDescription
urlDOMStringTarget URL. A relative or absolute local path lists local content.
callbackAsyncStatusCallbackCalled on success or error with an AsyncURLStatus argument.
depthunsigned short10: properties of the target only. 1: target and its immediate children.

Returns void

propFindURL( 'media/', function( status ) {
  if ( status.success ) {
    for ( var i = 0; i < status.content.length; i++ ) { alert( status.content[i].filename ); }
  }
}, 1 );

protocol@target

in <protocol> # attribute Player JavaScript In content

Target name that auxCmd and sendComPort commands must match.

Details
target='monitor'

Examples in the wiki: monitor, switch.

sendComPort()

# function Player JavaScript In content

Runs a named command from the active serial protocol file.

Details
sendComPort(target, command, [arg1, arg2, ...])
ParameterTypeDefaultDescription
targetDOMStringTarget type; must match the target of the protocol file.
commandDOMStringCommand name; must match an onStart command in the protocol file.
arg1, arg2, ...DOMStringOptional arguments; meaning depends on the command. Available as $PARAM1, $PARAM2...

Returns void

sendComPort( "monitor", "PowerOn" );

Notes SVG equivalent: the auxCmd element. Differs from writeCOMPort(), which bypasses protocol files.

Related <auxCmd>, <onStart>

SERIAL_NUMBER

# property Player JavaScript In content

Global variable with the player serial number (MAC without colons).

Details
SERIAL_NUMBER

Set to "[not defined]" in Elementi.

document.getElementById("MySerialNumberTextBox").textContent = SERIAL_NUMBER;

spx (HTML5 global object)

# property Player JavaScript In content

Exposes writeCOMPort() and createSharedVariable() inside web page layers.

Details
spx.createSharedVariable(name) | spx.writeCOMPort(data)

Available in HTML5 code of a web page layer only when the layer has allow="spx-api". Disabled by default. Needs DSOS 4.7.0 and Elementi 2021 Update 5.

document.addEventListener("DOMContentLoaded", () => {
  let v = spx.createSharedVariable("toto");
  v.addUpdateListener((sv) => { console.log(sv.value); });
  spx.writeCOMPort("Hello\r\n");
});

Since DSOS 4.7.0

Related allow, createSharedVariable(), writeCOMPort()

status.content[].creationdate

in propFindURL() # property Player JavaScript In content

DAV:creationdate as a Date object, or null if the server did not return it.

Details
status.content[].creationdate

status.content[].getcontentlength

in propFindURL() # property Player JavaScript In content

DAV:getcontentlength, or null.

Details
status.content[].getcontentlength

status.content[].getlastmodified

in propFindURL() # property Player JavaScript In content

DAV:getlastmodified as a Date object, or null.

Details
status.content[].getlastmodified

status.content[].href

in propFindURL() # property Player JavaScript In content

Absolute path for local resources, full URL for remote ones.

Details
status.content[].href

status.content[].resourcetype

in propFindURL() # property Player JavaScript In content

DAV:resourcetype: always "collection" for directories, null otherwise.

Details
status.content[].resourcetype

stream (Node.js)

# function Player JavaScript In content

Node.js Stream module.

Details
stream (Node.js)

Node.js docs for v7.x apply.

Since 3.0.0

writeCOMPort()

# function Player JavaScript In content

Writes characters or bytes directly to the serial port.

Details
writeCOMPort(text) | writeCOMPort(bytes) | writeCOMPort(typedArray) | writeCOMPort(buffer)
ParameterTypeDefaultDescription
textDOMStringSent as characters. Cannot contain a zero byte; each code is truncated to 8 bits.
bytesArrayByte values, cast to integer then truncated to 8 bits.
typedArrayArrayBuffer typed arrayFor example Uint8Array; sent verbatim.
bufferBufferNode.js Buffer; use it for non-ASCII text or packet structures.

Returns void

writeCOMPort( "Hello World !\r\n" );
writeCOMPort( [ 0, 1, 2, 3 ] );

Notes Does not go through a protocol file (unlike sendComPort). Needs the SYSTEMS Feature Set; not on HMP300 or DiVA. Experimental in 3.0.0, stable in 3.1.0. In web page layers use spx.writeCOMPort() with allow="spx-api".

Since 3.0.0

Related sendComPort(), com event, spx (HTML5 global object)

XMLHttpRequest

# constructor Player JavaScript In content

XMLHttpRequest Level 1 with FormData and Blob.

Details
new XMLHttpRequest()

W3C XMLHttpRequest Level 1, including the FormData and Blob APIs.

Since 3.1.0

Shared Variables 33

%EVENTS%

# property Shared Variables In content

Special Shared Variable that carries UI events.

Details
%EVENTS%

EVENT commands and fireSharedEvent() update it. SUBSCRIBE "%EVENTS%" to receive events from a server.

Related fireSharedEvent(), EVENT, SUBSCRIBE

createSharedVariable()

# function Shared Variables In content

Returns a SharedVariable linked to a local or remote Shared Variable.

Details
createSharedVariable(name)

Sends a SUBSCRIBE to the local or remote server. An implicit listener updates the object properties asynchronously, so register your own listener to run code on update.

ParameterTypeDefaultDescription
nameStringVariable name. Add @player_address (and :port if it differs) for a remote variable, for example var@remotehost:4567.

Returns SharedVariable object

var v1 = createSharedVariable( 'var1' );
v1.addUpdateListener( function( sv ) { alert( sv.name + ' : ' + sv.value ); }, false );
v1.set( 'value1' );

var v2 = createSharedVariable( 'var2@spx-hmp-001d50100033' );

Related SharedVariable, fireSharedEvent()

EVENT

# message Shared Variables Remote to player

TCP command: sends a UI event by updating %EVENTS%.

Details
EVENT [timestamp] "name" "parameters"

Format: COMMAND [timestamp] "name" ["value"] followed by \r\n. Escape newline as \n, carriage return as \r, double quote as \", null as \0, backslash as \\. Legacy unprotected server, raw TCP, default port 1234. Enable it in Control Center, Advanced Applications, Network API. All players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
timestampintegerOptional Unix time in microseconds.
namestringEvent name: keydown, keyup, textInput, mousemove, mousedown, mouseup, mousewheel, focusin, focusout.
parametersstringEvent parameters; format depends on the event.
EVENT "mouseup" "x=33,y=44,button=0"

fireSharedEvent()

# function Shared Variables In content

Generates a UI event as if an interactive device were used.

Details
fireSharedEvent(eventName, eventParams)

Works by updating the special Shared Variable %EVENTS%.

ParameterTypeDefaultDescription
eventNameStringEvent name, as for the EVENT command (keydown, mousedown, ...).
eventParamsStringEvent parameters, as for the EVENT command.

Returns undefined

fireSharedEvent( "mousedown", "x=250,y=20,button=0" );
fireSharedEvent( "mouseup",   "x=250,y=20,button=0" );

Related EVENT, %EVENTS%

GET /event

# endpoint Shared Variables Remote to player

HTTP GET that fires one or more UI events on the player.

Details
GET http://{player}:{port}/event?name1=value1&name2=value2

Legacy unprotected HTTP (no HTTPS), default port 1234; the response is 204 No Content. Name and value must be URL-encoded (%3D for =). Multiple pairs can be chained with &. There is no endpoint to read a value.

ParameterTypeDefaultDescription
namestringEvent name.
valuestringEvent parameters.
portinteger1234Network API port from Control Center.
http://172.3.21.21:1234/event?mousedown=x%3D45,y%3D20,button%3D0&mouseup=x%3D45,y%3D20,button%3D0

Related EVENT

GET /uievents

# endpoint Shared Variables Remote to player

Returns an empty 205 payload; with Observe, streams UI events.

Details
GET coaps+tcp://{player}/uievents

With the observe flag set, later notifications use the same payload format as the POST. Secure server (CoAP over TLS-PSK, firmware 4.3.0+, port 5684). Needs the Network API enabled; DSOS players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

Since 4.3.0

GET /update

# endpoint Shared Variables Remote to player

HTTP GET that sets one or more Shared Variables.

Details
GET http://{player}:{port}/update?name1=value1&name2=value2

Legacy unprotected HTTP (no HTTPS), default port 1234; the response is 204 No Content. Name and value must be URL-encoded (%3D for =). Multiple pairs can be chained with &. There is no endpoint to read a value.

ParameterTypeDefaultDescription
namestringShared Variable name.
valuestringNew value.
portinteger1234Network API port from Control Center.
http://192.168.1.10:1234/update?var1=new value 1&var2=value2

Related UPDATE

GET /webstorage

# endpoint Shared Variables Remote to player

Reads a Shared Variable over the secure CoAP server.

Details
GET coaps+tcp://{player}/webstorage?v={key}[&Observe={0|1}]

Returns 203 if an ETag was sent and the variable is unchanged, otherwise 205 with the current value. The 8-byte ETag is the last modification time in microseconds since the UNIX epoch (little-endian 64-bit). Observe responses always use 205. Secure server (CoAP over TLS-PSK, firmware 4.3.0+, port 5684). Needs the Network API enabled; DSOS players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
vstringVariable key.
Observe0 | 10 registers for change notifications, 1 deregisters.

Since 4.3.0

gps_gga

# property Shared Variables In content

Shared Variable filled by the built-in nmea-gps protocol file with GGA position data.

Details
gps_gga

CSV-like fields: talker, type, time_h, time_m, time_s, lat_d, lat_m, lat_ns, long_d, long_m, long_ew, fix, nr_sats, hdop, alt, alt_unit, geoid_sep, geoid_sep_unit, dgps_age, dgps_ref_id, mode, mode_present, csum. The parser does not verify checksums; malformed sentences are ignored.

Notes Needs the [sys] nmea-gps protocol file activated. Usable as a data source in data feed widgets.

gps_vtg

# property Shared Variables In content

Shared Variable filled by the built-in nmea-gps protocol file with VTG course and speed data.

Details
gps_vtg

Fields: talker, type, true_course, true_course_ref, mag_course, mag_course_ref, speed_knots, speed_knots_unit, speed_kph, speed_kph_unit, mode, mode_present, csum.

Notes Needs the [sys] nmea-gps protocol file activated.

keydown (event name)

in EVENT # message Shared Variables Remote to player

Key pressed.

Details
keydown (event name)

Key pressed. Value: an SVG key identifier (Enter, PageUp, F5), a character (A..Z, a..z) or a Unicode code (U+0041). May carry the prefixes Ctrl+, Shift+, Alt+, Meta+, AltGr+.

EVENT "keydown" "Ctrl+V"

Related fireSharedEvent(), GET /event

mousedown (event name)

in EVENT # message Shared Variables Remote to player

Button pressed. Value: x, y and button (0 left, 1 middle, 2 right; reversed for left-handed mice), for example "x=45,y=20,button=0".

Details
mousedown (event name)
EVENT "mousedown" "x=45,y=20,button=0"

Related fireSharedEvent(), GET /event

mousewheel (event name)

in EVENT # message Shared Variables Remote to player

Wheel turned. Value: x, y and delta, for example "x=45,y=20,delta=8". Positive delta is up or left.

Details
mousewheel (event name)
EVENT "mousewheel" "x=45,y=20,delta=8"

Related fireSharedEvent(), GET /event

POST /uievents

# endpoint Shared Variables Remote to player

Sends a UI event to the player over the secure CoAP server.

Details
POST coaps+tcp://{player}/uievents

Payload: one or more ASCII lines of three space-separated fields: timestamp, event name, event parameters. Secure server (CoAP over TLS-PSK, firmware 4.3.0+, port 5684). Needs the Network API enabled; DSOS players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

Since 4.3.0

POST /webstorage

# endpoint Shared Variables Remote to player

Sets a Shared Variable with optional timestamp and precondition.

Details
POST coaps+tcp://{player}/webstorage?v={key}[&t={timestamp}][&x={expected}]

The payload is the new value. Returns 204 on success, 412 if the precondition fails. Secure server (CoAP over TLS-PSK, firmware 4.3.0+, port 5684). Needs the Network API enabled; DSOS players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
vstringVariable key.
tintegerOptional timestamp, microseconds since the UNIX epoch.
xstringOptional precondition: modify only if the current value equals this string.

Since 4.3.0

PUT /webstorage

# endpoint Shared Variables Remote to player

Sets a Shared Variable with the server timestamp.

Details
PUT coaps+tcp://{player}/webstorage?v={key}

The request body is the new value. Always 204 on success. Secure server (CoAP over TLS-PSK, firmware 4.3.0+, port 5684). Needs the Network API enabled; DSOS players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
vstringVariable key.

Since 4.3.0

SharedVariable

# property Shared Variables In content

Object with name, value, lastUpdateTime and four methods.

Details
SharedVariable

Read-only properties: name, value, lastUpdateTime. Methods: addUpdateListener, removeUpdateListener, set, testAndSet. Properties are refreshed asynchronously, so read them inside an update listener or from localStorage (3.1.0 or later). The object has no setValue() method.

Related createSharedVariable()

SharedVariable.addUpdateListener()

in SharedVariable # method Shared Variables In content

Registers a callback run whenever the variable is updated.

Details
addUpdateListener(callback) | addUpdateListener(callback, timeSync)
ParameterTypeDefaultDescription
callbackCallbackReceives the SharedVariable as argument.
timeSyncBooleantruetrue: callback time is synchronized with lastUpdateTime. false: current time is used. Use false except for synchronized content.

Returns undefined

function onUpdate( sv ) { alert( sv.name + ' : ' + sv.value ); }
createSharedVariable( 'var1' ).addUpdateListener( onUpdate, false );

Notes timeSync was added in 3.0.0; earlier releases always synchronized.

Since 3.0.0 (timeSync)

SharedVariable.lastUpdateTime

in SharedVariable # property Shared Variables In content

Time of the last update, ms since 1 January 1970 UTC (Number); 0 initially.

Details
SharedVariable.lastUpdateTime

Notes A set() is ignored when this value is greater than the timestamp of the update. Scheduled or synchronized content runs in the past; add spx:start-at-random-time="on" to the svg element.

Related spx:start-at-random-time

SharedVariable.removeUpdateListener()

in SharedVariable # method Shared Variables In content

Removes a registered listener.

Details
removeUpdateListener(callback)
ParameterTypeDefaultDescription
callbackCallbackThe function passed to addUpdateListener.

Returns undefined

SharedVariable.set()

in SharedVariable # method Shared Variables In content

Sets the value to a string and triggers registered listeners.

Details
set(value)
ParameterTypeDefaultDescription
valueDOMStringNew value.

Returns undefined

Notes Ignored if lastUpdateTime is later than the update timestamp (see lastUpdateTime).

SharedVariable.testAndSet()

in SharedVariable # method Shared Variables In content

Sets the value only if the current value equals test.

Details
testAndSet(test, value)

Triggers listeners when it sets.

ParameterTypeDefaultDescription
testDOMStringExpected current value.
valueDOMStringNew value.

Returns undefined

Since 3.2.0

SharedVariable.value

in SharedVariable # property Shared Variables In content

Current value (String), or null before the first update.

Details
SharedVariable.value

Notes Read-only. Filled asynchronously.

SUBSCRIBE

# message Shared Variables Remote to player

TCP command: receive notifications when a variable changes or an event fires.

Details
SUBSCRIBE "name"

The server answers with UPDATE (variables) or EVENT (%EVENTS%), always with an absolute UTC timestamp. If the variable already has a value, the client gets the latest value at once. After a server reboot clients are not told of the reset, and notifications resume because clients send keep-alives and the TCP connection is restored. Legacy unprotected server, raw TCP, default port 1234. Enable it in Control Center, Advanced Applications, Network API. All players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
namestringVariable name, or %EVENTS% for events.
SUBSCRIBE "var2"

UNSUBSCRIBE

# message Shared Variables Remote to player

TCP command: stop notifications for a variable or for %EVENTS%.

Details
UNSUBSCRIBE "name"

Legacy unprotected server, raw TCP, default port 1234. Enable it in Control Center, Advanced Applications, Network API. All players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
namestringVariable name, or %EVENTS%.
UNSUBSCRIBE "var1"

UPDATE

# message Shared Variables Remote to player

TCP command: sets a Shared Variable; creates it if missing.

Details
UPDATE [timestamp] "name" "value"

Format: COMMAND [timestamp] "name" ["value"] followed by \r\n. Escape newline as \n, carriage return as \r, double quote as \", null as \0, backslash as \\. Legacy unprotected server, raw TCP, default port 1234. Enable it in Control Center, Advanced Applications, Network API. All players except HMP300 and DiVA; SYSTEMS Feature Set on compatible players.

ParameterTypeDefaultDescription
timestampintegerOptional Unix time in microseconds. Default: time the command is received.
namestringVariable name.
valuestringNew value.
UPDATE "var1" "some value"
UPDATE 1391763640616399 "var2" "some value"

Web Storage API 19

DELETE /webstorage/{key}

# endpoint Web Storage API Remote to player

Deletes one variable.

Details
DELETE http(s)://[player_address]/webstorage/{key}

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

GET /webstorage

# endpoint Web Storage API Remote to player

Lists the web storage variables on the player.

Details
GET http(s)://[player_address]/webstorage

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

GET /webstorage/{key}

# endpoint Web Storage API Remote to player

Returns the value of one variable. Also /webstorage?name={key}.

Details
GET http(s)://[player_address]/webstorage/{key}

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

localStorage

# property Web Storage API In content

Key/value store (strings only), up to 4 MB. Permanent: survives player restart and publishing new content.

Details
localStorage

Items are also readable as properties (localStorage.key). Non-strings are converted to strings; use JSON.stringify for objects. Methods other than the getter fire a storage event. localStorage can be cleared in Control Center under Operations > Reset.

Notes Shared Variables are saved into localStorage automatically from firmware 3.1.0, so changing one changes the stored item.

Since 3.0.0

Related GET /webstorage

localStorage.clear()

in localStorage # method Web Storage API In content

Removes all items.

Details
localStorage.clear()
localStorage.clear();

Notes Fires a storage event.

Since 3.0.0

localStorage.getItem()

in localStorage # method Web Storage API In content

Returns the stored value for a key.

Details
localStorage.getItem(key)
localStorage.getItem('key');

Since 3.0.0

localStorage.removeItem()

in localStorage # method Web Storage API In content

Removes one item.

Details
localStorage.removeItem(key)
localStorage.removeItem('key');

Notes Fires a storage event.

Since 3.0.0

localStorage.setItem()

in localStorage # method Web Storage API In content

Stores a value under a key.

Details
localStorage.setItem(key, value)
localStorage.setItem('key', 'value');

Notes Fires a storage event.

Since 3.0.0

POST /webstorage

# endpoint Web Storage API Remote to player

Updates one or more variables from a form body.

Details
POST http(s)://[player_address]/webstorage

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

POST /webstorage/{key}

# endpoint Web Storage API Remote to player

Sets the variable to the POST body. Also /webstorage?name={key}.

Details
POST http(s)://[player_address]/webstorage/{key}

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

POST /webstorage/{key}?expect={value}

# endpoint Web Storage API Remote to player

Sets the variable only if its current value equals {value}.

Details
POST http(s)://[player_address]/webstorage/{key}?expect={value}
ParameterTypeDefaultDescription
expectstringExpected current value.

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0.

Since 4.3.0

Related Web Storage REST authentication, localStorage

PURGE /webstorage/

# endpoint Web Storage API Remote to player

Deletes all variables.

Details
PURGE http(s)://[player_address]/webstorage/

Notes REST API. Applies to all DSOS players except HMP300 and DiVA. Needs the SYSTEMS Feature Set. Firmware 4.3.0. PURGE added in firmware 4.6.1.

Since 4.6.1

Related Web Storage REST authentication, localStorage

sessionStorage

# property Web Storage API In content

Key/value store (strings only), up to 4 MB. Semi-permanent: reset on content restart, player reboot or publish.

Details
sessionStorage

Same interface as localStorage. Items are also readable as properties. Limit 4 MB per object. Non-strings are converted to strings.

Since 3.0.0

sessionStorage.clear()

in sessionStorage # method Web Storage API In content

Removes all items.

Details
sessionStorage.clear()
sessionStorage.clear();

Notes Fires a storage event.

Since 3.0.0

sessionStorage.getItem()

in sessionStorage # method Web Storage API In content

Returns the stored value for a key.

Details
sessionStorage.getItem(key)
sessionStorage.getItem('key');

Since 3.0.0

sessionStorage.removeItem()

in sessionStorage # method Web Storage API In content

Removes one item.

Details
sessionStorage.removeItem(key)
sessionStorage.removeItem('key');

Notes Fires a storage event.

Since 3.0.0

sessionStorage.setItem()

in sessionStorage # method Web Storage API In content

Stores a value under a key.

Details
sessionStorage.setItem(key, value)
sessionStorage.setItem('key', 'value');

Notes Fires a storage event.

Since 3.0.0

Web Storage REST authentication

# property Web Storage API Remote to player

Security token sent as a Bearer header or access_token query parameter; or credentials of a user with content authoring or admin rights.

Details
Authorization: Bearer <token> | ?access_token=<token>

The REST API is off by default. Enable 'Enable security token access to the Webstorage API' in Control Center > Advanced Applications > API Security; enable 'Enable CORS requests' if calls come from another host. TLS-SRP and HTTP Basic are supported. For CORS add spx-api-key={rpcApiKey} to the URL. Over plain HTTP a token or password can be sniffed; use HTTPS. Documentation and examples: api.docs.spinetix.com.

Notes The webstorage-token config tag sets or clears the token.

Since 4.3.0

Related <webstorage-token>, POST /rpc?spx-api-key=

RPC API 32

add_pull_action

# rpc-method RPC API Remote to player

Sends a Pull Mode action (publish, upload, ...) for the player to run.

Details
POST /rpc  {"method":"add_pull_action","params":[...],"id":1}

Triggers a content update in a pseudo-push scenario. The Pull Mode page recommends it over the dummy-ICS 'dynamic pull' method.

ParameterTypeDefaultDescription
action objectobjectFor example {"type": "publish", "uri": "..."}.
{"method":"add_pull_action","params":[{"type":"publish","uri":"http://demo.spinetix.com/sample_projects/Office/spx-listing.xml"}],"id":"get office content"}

Since 2.2.3

Related POST /rpc, publish

firmware_update

# rpc-method RPC API Remote to player

Starts a firmware update from the SpinetiX server in the background and returns a handle.

Details
POST /rpc  {"method":"firmware_update","params":[...],"id":1}

The handle can be used with firmware_update_status.

Since 2.2.0

Related firmware_update_status

firmware_update_status

# rpc-method RPC API Remote to player

Returns the status of a firmware update started earlier.

Details
POST /rpc  {"method":"firmware_update_status","params":[...],"id":1}

Notes Modified in 4.7.1.

Since 2.2.0

Related firmware_update

get_config

# rpc-method RPC API Remote to player

Returns the full device configuration, like a configuration backup.

Details
POST /rpc  {"method":"get_config","params":[...],"id":1}

The xmlconfig string follows the Configuration API rules.

Returns Plain object with an "xmlconfig" string.

Since 2.2.3

Related set_config, <configuration>

get_info

# rpc-method RPC API Remote to player

Returns device info: serial, name, model, mode, firmware version and status, uptime, temperature, storage and more.

Details
POST /rpc  {"method":"get_info","params":[...],"id":1}

The info notification returns the same data at set intervals. Flags such as {"all": true} select what is returned.

{"method":"get_info","params":[{"all":true}],"id":1}

Notes Observed on players: with params [{"all":true}] one call (about 60 ms) already carries safe mode, firmware status, temperature, video connector status, display power save, storage, stats, file errors and network. The flags are named on the Pull Mode page, which refers to the RPC PDF for the full list. Modified in 4.8.2.

Since 2.2.0

Related info, GET /status/info

Indirect RPC (via ready notification)

# message RPC API Player to server

The concentrator puts an RPC command in the HTTP reply to a ready notification; the player runs it and returns the result in the next ready.

Details
player -> POST ready -> concentrator replies with a command

The player starts the connection, so no inbound access is needed. The concentrator may chain another command in each reply.

Related ready, RPC Concentrator

info

# message RPC API Player to server

Sends the get_info data to the concentrator at set intervals.

Details
{"method":"info","params":[{...}],"id":null}

Interval and flags are set with the -info option of the Pull Mode rpc action.

Since 3.1.0

Related RPC Concentrator, RPC notification (body)

Inline RPC

# message RPC API Player to server

Runs an RPC command from an event in the ICS file that controls Pull Mode, for example a nightly restart.

Details
SUMMARY:inline-rpc in a Pull Mode ICS event

See the inline-rpc action in Pull Mode.

Related inline-rpc

POST /rpc

# endpoint RPC API Remote to player

Direct RPC endpoint. One JSON-RPC 1.0 command per HTTP POST, content type application/json, UTF-8.

Details
POST http(s)://[player_address]/rpc

Request body: {"method": string, "params": array, "id": string or number}. Response: {"result", "error", "id", "errorDetails"}. Auth: HTTP Basic or TLS-SRP. Most methods need admin rights.

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

Notes RPC API added in firmware 2.2.1. Observed on players: /rpc accepts only application/json (text/plain gives 400), so a browser always sends a preflight. RPC and Status API work over both HTTP and HTTPS; the real limit is mixed content (an HTTPS page can call only https players, and each self-signed certificate must be accepted first).

Since 2.2.1

Related POST /rpc?spx-api-key=, RPC command (request body), RPC response (body), RPC HTTP errors (400, 401)

POST /rpc?spx-api-key=

# endpoint RPC API Remote to player

RPC endpoint for scripts on another host (CORS). The API key query parameter protects against CSRF.

Details
POST http(s)://[player_address]/rpc?spx-api-key={rpcApiKey}

The key is set in Control Center (Advanced Applications > APIs Security) or with the rpc-api-key config tag. The same key can be set on many players so one AJAX call works on all. Credentials go in the Authorization header (Basic) with xhr.withCredentials = true.

const rpcApiKey = 'sample-ff5b-46c8-acdc-d356b71f5f0f',
      rpcObject = { method: 'restart', params: [], id: 1 },
      authorization = 'Basic ' + btoa(login + ':' + password),
      url = 'http://172.21.1.137/rpc?spx-api-key=' + rpcApiKey;
$.ajax({
  type: 'POST', url: url, contentType: 'application/json',
  beforeSend: function (xhr) {
    xhr.setRequestHeader('Authorization', authorization);
    xhr.withCredentials = true;
  },
  data: JSON.stringify(rpcObject)
}).done(function (data) { if (!data.error) { alert('The player is restarting.'); } });

Notes CORS enabled in firmware 3.0.5. CSRF protection added in 4.2.0 / 3.4.0. Authorization header supported from 4.5.0. Observed on players: a foreign Origin with a missing or wrong key gets 403 at the preflight with no CORS headers, so the page sees only a network error; a wrong password with a valid key gets 401 with CORS headers.

Since 3.0.5

Related POST /rpc, <rpc-api-key>

pull_status

# message RPC API Player to server

Sent when a Pull Mode action completes.

Details
{"method":"pull_status","params":[{...}],"id":null}

With -statusinterval, -statusnrfiles or -statussize in a publish action it is also sent during the download, once all given conditions are reached.

Notes Modified in 3.1.0.

Since 3.0.0

Related RPC Concentrator, RPC notification (body)

ready

# message RPC API Player to server

Heartbeat sent each time the player contacts the concentrator. Carries the results of earlier RPC calls.

Details
{"method":"ready","params":[{...}],"id":null}

The concentrator can reply with an RPC command (indirect RPC). Polling interval is set with -polling in the Pull Mode rpc action; default one hour.

Since 2.2.0

Related RPC Concentrator, RPC notification (body)

reset

# rpc-method RPC API Remote to player

Resets the player to factory defaults, or only user content, network cache, web storage, clock calibration or logs.

Details
POST /rpc  {"method":"reset","params":[...],"id":1}

Notes Modified in 4.7.2.

Since 4.4.0

Related <reset-content>, <reset-webstorage>

restart

# rpc-method RPC API Remote to player

Clean restart, one minute after the call is received.

Details
POST /rpc  {"method":"restart","params":[...],"id":1}
{"method":"restart","params":[],"id":1}

Notes Modified in 2.2.6.

Since 2.2.0

Related shutdown, inline-rpc

restarted

# message RPC API Player to server

Sent after a player restart, with the time of the restart.

Details
{"method":"restarted","params":[{...}],"id":null}

Content follows the -restarted flags in the Pull Mode rpc action; default flags are reason and status.

Since 2.2.0

Related RPC Concentrator, RPC notification (body)

RPC command (request body)

# message RPC API Remote to player

JSON object sent to the player: method name, params array and an id echoed in the response.

Details
{ "method": "<name>", "params": [], "id": 1 }

The same format is used when the command arrives in the response to a ready notification (indirect RPC) or inside a Pull Mode inline-rpc event.

ParameterTypeDefaultDescription
methodstringName of the RPC command.
paramsarrayArguments, or [] when none.
idstring | numberEchoed in the response for matching.
{"method":"restart","params":[],"id":1}

Related RPC response (body), POST /rpc, ready, inline-rpc

RPC Concentrator

# message RPC API Player to server

Server the player contacts. It collects notifications and can reply with an RPC command, which reaches players behind NAT.

Details
Server receiving HTTP POST notifications from the player

Configured in Control Center (Advanced Applications > RPC Concentrator on HMP400/400W with WIDGETS Feature Set or higher, HMP350, HMP300; Content Settings > Pull Mode tab on HMP200/130/100) or with an rpc event in a Pull Mode ICS file. Every notification carries the player serial number. SpinetiX provides sample PHP servers: RPC server, HMP monitoring server, HMP management server.

Related ready, rpc, Indirect RPC (via ready notification)

RPC HTTP errors (400, 401)

# message RPC API Remote to player

400 for GET, wrong content type, empty or invalid JSON, or an OPTIONS request; 401 when authentication is missing or wrong.

Details
HTTP 400 | HTTP 401 on /rpc

400 cases: GET on /rpc (for example opening it in a browser); Content-Type not application/json; empty or invalid JSON body; a script run locally (not CORS-configured) whose browser sends OPTIONS first. 401: the endpoint is protected and needs credentials of a user with appropriate rights. Indirect RPC avoids both.

Related POST /rpc, POST /rpc?spx-api-key=

RPC notification (body)

# message RPC API Player to server

HTTP POST from the player to the concentrator. id is always null; params holds one or more objects including the serial number.

Details
{ "method": "<name>", "params": [ {...} ], "id": null }

The server need not answer, but it may add an RPC command to the response.

Related RPC Concentrator, ready

RPC response (body)

# message RPC API Remote to player

JSON object returned by the player: result, error text, id, and from 4.7.1 errorDetails.

Details
{ "result": {}, "error": null, "id": 1 }
ParameterTypeDefaultDescription
resultobject | nullValue returned by the method; null on error.
errorstring | nullError summary, for example "No such method (reboot)"; null on success.
idstring | numberId of the request.
errorDetailsobject | nullHolds code and data about the error. Added in firmware 4.7.1.
{"result":{},"error":null,"id":1}

Since 2.2.1

Related RPC command (request body), RPC HTTP errors (400, 401)

set_config

# rpc-method RPC API Remote to player

Applies a configuration XML string (partial or complete) to the player.

Details
POST /rpc  {"method":"set_config","params":[...],"id":1}
ParameterTypeDefaultDescription
xmlconfigstringXML configuration string; encode quotes properly inside JSON.
{"method":"set_config","params":[{"xmlconfig":"<?xml version=\"1.0\"?><configuration version=\"2.0\"><screen-aspect-ratio>16:9</screen-aspect-ratio><display-orientation>rotateRight</display-orientation><enable-audio>yes</enable-audio><device-name>office-screen</device-name><reboot/></configuration>"}],"id":2}

Since 2.2.3

Related get_config, <configuration>

set_password

# rpc-method RPC API Remote to player

Sets or removes the password of a user on the player.

Details
POST /rpc  {"method":"set_password","params":[...],"id":1}

Use it to change passwords on many players from one place, for example a new admin password every 30 days.

Notes Modified in 4.0.0.

Since 2.2.0

Related <user>

shutdown

# rpc-method RPC API Remote to player

Clean shutdown, one minute after the call is received.

Details
POST /rpc  {"method":"shutdown","params":[...],"id":1}

Since 2.2.6

Related restart

webstorage_cmpxchg

# rpc-method RPC API Remote to player

Sets one or more web storage items; with an expected value the item changes only if its current value matches.

Details
POST /rpc  {"method":"webstorage_cmpxchg","params":[...],"id":1}

Notes Do not apply to HMP300 and DiVA. Works through the player, so it suits players behind NAT (indirect RPC). Compare and swap.

Since 3.1.0

Related localStorage

webstorage_get

# rpc-method RPC API Remote to player

Gets the value of one or more web storage items.

Details
POST /rpc  {"method":"webstorage_get","params":[...],"id":1}

Notes Do not apply to HMP300 and DiVA. Works through the player, so it suits players behind NAT (indirect RPC).

Since 3.1.0

Related localStorage

webstorage_list

# rpc-method RPC API Remote to player

Lists the items currently in the web storage.

Details
POST /rpc  {"method":"webstorage_list","params":[...],"id":1}

Notes Do not apply to HMP300 and DiVA. Works through the player, so it suits players behind NAT (indirect RPC).

Since 3.1.0

Related localStorage

webstorage_remove

# rpc-method RPC API Remote to player

Removes one or more items from the web storage.

Details
POST /rpc  {"method":"webstorage_remove","params":[...],"id":1}

Notes Do not apply to HMP300 and DiVA. Works through the player, so it suits players behind NAT (indirect RPC).

Since 3.1.0

Related localStorage

webstorage_set

# rpc-method RPC API Remote to player

Sets the value of one or more web storage items.

Details
POST /rpc  {"method":"webstorage_set","params":[...],"id":1}

Observed on players: params is an array holding one array of pairs ([[...]]), not a flat array. Writes to localStorage and so also to the matching Shared Variable.

ParameterTypeDefaultDescription
pairsarrayArray of {name, value} objects.
{"method":"webstorage_set","params":[[{"name":"switch","value":"loop"}]],"id":"webstorage_set_from_webpage"}

Notes Do not apply to HMP300 and DiVA. Works through the player, so it suits players behind NAT (indirect RPC).

Since 3.1.0

Related localStorage

wifi_connect

# rpc-method RPC API Remote to player

Tells the player to connect to the given Wi-Fi network.

Details
POST /rpc  {"method":"wifi_connect","params":[...],"id":1}

Since 4.6.0

Related <wifi-ap-add>

wifi_disconnect

# rpc-method RPC API Remote to player

Tells the player to disconnect from the Wi-Fi network.

Details
POST /rpc  {"method":"wifi_disconnect","params":[...],"id":1}

Since 4.6.0

Related <wifi-ap-add>

wifi_get_info

# rpc-method RPC API Remote to player

Returns information about the Wi-Fi networks configured on the player.

Details
POST /rpc  {"method":"wifi_get_info","params":[...],"id":1}

Since 4.6.0

Related <wifi-ap-add>

wifi_scan

# rpc-method RPC API Remote to player

Starts a scan for Wi-Fi networks.

Details
POST /rpc  {"method":"wifi_scan","params":[...],"id":1}

Since 4.6.0

Related <wifi-ap-add>

Status API 16

<license>

in GET /status/info # property Status API Remote to player

Feature Set license data: check date and active features.

Details
<license>

Children: checkDate, features. Applies to HMP400, HMP400W and third-party players. Added in firmware 4.7.6.

<network>

in GET /status/info # property Status API Remote to player

Network configuration: device name, hostname, IPv4/IPv6, interface type, DHCP or static.

Details
<network>

Children: deviceName, hostname, ip, prefixLength, interface (Ethernet, WLAN, 3G), ipv6/ipv6addr, secondaryAddresses/address (Ethernet details when on Wi-Fi), configuration/interface, configuration/method (dhcp, static).

<screen>

in GET /status/info # property Status API Remote to player

Screen setup: screen id, snapshot URI, resolution, refresh, aspect ratio, overscan, orientation, power save, audio mute, connected displays.

Details
<screen>

Children: screenID, snapshotURI, resolutionWidth/Height, verticalRefresh, aspectRatio, overscanPercent, orientation, powerSave, audio/mute, display. Each display holds id (for example card0-DP-1), type (HDMI, DVI, DisplayPort Alt Mod), power_save, mode (colorspace, width, height, refresh, region, hdr), powered (on, off, unknown), pm_supported (0/1), cec_capable (0/1, added in firmware 4.6.0). hdr applies only to iBX440.

<stats>

in GET /status/info # property Status API Remote to player

Rendering stats samples (usually one per minute).

Details
<stats>

sample children: time, render, pictures, usage, peak, buffers, dropFPS, dropPeak. See player.log for details.

<status>

in GET /status/info # property Status API Remote to player

Operating status: safe mode, firmware update state, boot id, uptime, boot reason, temperature.

Details
<status>

Children: safemode (on/off), firmware (complete, available, pending), bootid, uptime, bootReason, temp. temp is not available on HMP130 / HMP100.

<storagedevices>

in GET /status/info # property Status API Remote to player

Attached storage devices with location, size and unit.

Details
<storagedevices>

Children: storagedevice/location, size, unit.

<tempHistory>

in GET /status/info?offset= # property Status API Remote to player

Temperature history, only in the extended response (offset parameter).

Details
<tempHistory><sample>

sample children: time, C (Celsius), F (Fahrenheit). Capped at 100 entries.

<uploader>

in GET /status/info # property Status API Remote to player

Content pull scheduling: mode, project source and time, calendar URI.

Details
<uploader>

mode is Disabled, Manual (web server), Automatic (ICS uploaded to the device) or Server (remote ICS). projectSource and projectTime apply to manual mode; calendar to server mode.

GET /status/info

# endpoint Status API Remote to player

Returns the current player status as XML: device, status, stats, errors, time, network, screen, storage, version, uploader, license.

Details
GET http(s)://[player_address]/status/info

Auth: users with monitoring or admin rights; HTTP Basic or TLS-SRP (HTTPS is not available on legacy players). Cross-origin use needs the spx-api-key query parameter. Root element: status in namespace http://www.spinetix.com/namespace/1.0/spxstatus, attribute spxs:version="5".

$.get('http://player/status/info', function (data) {
  var doc = $.parseXML(data);
  var temp = $(doc.documentElement).find('temp').text();
}, 'text');

Notes CORS and CSRF support from DSOS 4.5.3. Full status XML consumes CPU, so for frequent polling prefer the RPC get_info call. The snapshot and info generation may disturb rendering if requested too often.

Since 4.5.3

Related GET /status/info?offset=, GET /status/snapshot, get_info

GET /status/info?offset=

# endpoint Status API Remote to player

Same as /status/info plus history of rendering stats and temperature.

Details
GET http(s)://[player_address]/status/info?offset=-HH:mm:ss | ?offset=date

offset is a negative period (-HH:mm:ss) or a date. At most 24 hours and no more than 100 entries, whichever comes first. Adds up to 100 <sample> entries under <stats> and a <tempHistory> block.

ParameterTypeDefaultDescription
offsetstring-HH:mm:ss or a date.

Related GET /status/info, <tempHistory>

GET /status/snapshot

# endpoint Status API Remote to player

Returns a JPEG snapshot of the content being rendered.

Details
GET http(s)://[player_address]/status/snapshot

Returns JPEG image

Notes Can be generated as often as every 10 seconds, but it uses CPU and may affect smooth rendering. Wiki advises at least 60 seconds between requests. The Pull Mode upload action can fetch it with -snapshot.

Related GET /status/info, -snapshot

Configuration API 131

<accepts-events>

# config-key Configuration API Remote to player

Set whether the player accepts interactive events from the USB connector.

Details
<accepts-events>...</accepts-events>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<active-certificate>

# config-key Configuration API Remote to player

Activate one of the previously uploaded server certificate.

Details
<active-certificate>...</active-certificate>

Since 4.2.0

Related <configuration>

<allow-usb-sources>

# config-key Configuration API Remote to player

Use external USB drives to store content.

Details
<allow-usb-sources>...</allow-usb-sources>

Notes Modified in 4.7.4. It doesn't apply to DiVA.

Since 2.2.5

Related <configuration>

<audio-output>

# config-key Configuration API Remote to player

Set the audio output to either HMDI or line-out.

Details
<audio-output>...</audio-output>

Since 4.3.0

Related <configuration>

<audio-power-save>

# config-key Configuration API Remote to player

Set whether the player shall output audio when the screen is in power save.

Details
<audio-power-save>...</audio-power-save>

Since 3.1.0

Related <configuration>

<bonjour-discovery-enabled>

# config-key Configuration API Remote to player

Set whether Bonjour discovery is enabled in the player.

Details
<bonjour-discovery-enabled>...</bonjour-discovery-enabled>

Since 4.2.2

Related <configuration>

<bonjour-enabled>

# config-key Configuration API Remote to player

Set whether Bonjour service (discovery and name resolution) is enabled on the player.

Details
<bonjour-enabled>...</bonjour-enabled>

Since 4.2.3

Related <configuration>

<canvas>

# config-key Configuration API Remote to player

Set the canvas size, in pixels, for video output on multiple screens.

Details
<canvas>...</canvas>

Notes Applies to iBX440.

Since 4.8.0

Related <configuration>

<capture>

# config-key Configuration API Remote to player

Configure one or more audio/video capture devices connected to the player through USB.

Details
<capture>...</capture>

Notes Applies to HMP400/W.

Since 4.7.1

Related <configuration>

<certificate>

# config-key Configuration API Remote to player

Add SSL/TLS certificate to the device.

Details
<certificate>...</certificate>

Notes Last modified in 4.2.0 firmware.

Since 3.0.0

Related <configuration>

<certificates-reset>

# config-key Configuration API Remote to player

Remove all SSL/TLS certificates that are present on the device.

Details
<certificates-reset>...</certificates-reset>

Since 3.0.3

Related <configuration>

<clear-captures>

# config-key Configuration API Remote to player

Clear any capture files, both for stream and HTTP packets, present on the player.

Details
<clear-captures>...</clear-captures>

Notes It doesn't apply to DiVA.

Since 4.5.0

Related <configuration>

<cockpit-disabled>

# config-key Configuration API Remote to player

Disable Cockpit monitoring on the device.

Details
<cockpit-disabled>...</cockpit-disabled>

Since 3.2.0

Related <configuration>

<com-port-settings>

# config-key Configuration API Remote to player

Set the serial port settings or reset them to their default values.

Details
<com-port-settings>...</com-port-settings>

Notes Modified in 4.9.0. It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<configuration>

# element Configuration API Remote to player

Required root element of a configuration string. Holds the config tags and an optional reboot.

Details
<configuration version="n.n" compatible="n.n">...</configuration>

version: 2.3 for firmware 4.8.6-4.9.2; 2.2 for 4.8.0-4.8.5; 2.1 for 4.2.0-4.7.x; 2.0 for 4.0.0-4.1.2; 1.2 for 3.2.0-3.4.5; 1.1 for 3.0.0-3.1.1; 1.0 below 3.0.0. Missing tags keep their current value. Send it as the xmlconfig value of set_config, or as a file (xml, cfg or spx).

ParameterTypeDefaultDescription
versionstringRequired. Depends on the firmware.
compatiblestringOptional. Lets one string work across firmware versions.
<?xml version="1.0"?>
<configuration version="2.1">
  <timezone>Europe/Zurich</timezone>
  <reboot/>
</configuration>

Notes The wiki examples use version 2.4 for display-hotplug (4.9.7) although the version list stops at 2.3.

Since 2.2.1

Related <reboot/>, set_config, get_config, Configuration file

<credential-reset>

# config-key Configuration API Remote to player

Remove all previous credentials on the device.

Details
<credential-reset>...</credential-reset>

Since 2.2.1

Related <configuration>

<debug-enroll>

# config-key Configuration API Remote to player

Enable/disable debug logging of enrolment with the cloud.

Details
<debug-enroll>...</debug-enroll>

Since 4.6.0

Related <configuration>

<debug-iot>

# config-key Configuration API Remote to player

Enable/disable debug logging of IOT service.

Details
<debug-iot>...</debug-iot>

Since 4.6.0

Related <configuration>

<debug-log>

# config-key Configuration API Remote to player

Enable/disable debug logging for one or more loggers.

Details
<debug-log>...</debug-log>

Since 4.7.2

Related <configuration>

<device-name>

# config-key Configuration API Remote to player

Set the device name to be used by the network discovery protocols.

Details
<device-name>...</device-name>
<device-name>office-screen</device-name>

Since 2.2.1

Related <configuration>

<disable-cloud>

# config-key Configuration API Remote to player

Disable all communications with the SpinetiX cloud.

Details
<disable-cloud>...</disable-cloud>

Since 4.5.0

Related <configuration>

<disable-secondary-network-port>

# config-key Configuration API Remote to player

Set whether the secondary network port on the HMP350 is disabled.

Details
<disable-secondary-network-port>...</disable-secondary-network-port>

Since 4.2.0

Related <configuration>

<display-custom-video-mode>

# config-key Configuration API Remote to player

Set a custom video mode for the display.

Details
<display-custom-video-mode>...</display-custom-video-mode>

Notes Modified in 4.8.0. It doesn't apply to HMP300 and DiVA. Deprecated in 4.8.0.

Since 2.2.1

Related <configuration>

<display-hotplug>

# config-key Configuration API Remote to player

Control whether the display hot-plug feature is activated.

Details
<display-hotplug>...</display-hotplug>
<display-hotplug>no</display-hotplug>

Since 4.9.7

Related <configuration>

<display-orientation>

# config-key Configuration API Remote to player

Set the orientation of the display.

Details
<display-orientation>...</display-orientation>
<display-orientation>rotateRight</display-orientation>

Notes Wiki examples use horizontal and rotateRight.

Since 2.2.1

Related <configuration>

<display-power-save>

# config-key Configuration API Remote to player

Enable display power saving.

Details
<display-power-save>...</display-power-save>

Since 2.2.1

Related <configuration>

<display-power-schedule>

# config-key Configuration API Remote to player

Set or remove a fixed display power saving schedule.

Details
<display-power-schedule>...</display-power-schedule>

Notes Modified in 4.6.1.

Since 2.2.1

Related <configuration>

<display-video-mode>

# config-key Configuration API Remote to player

Set a standard or custom video mode for the display.

Details
<display-video-mode>...</display-video-mode>

Notes Modified in 4.9.0.

Since 2.2.1

Related <configuration>

<dns-automatic>

# config-key Configuration API Remote to player

Set a DHCP assigned DNS server address on the player.

Details
<dns-automatic>...</dns-automatic>

Since 4.2.3

Related <configuration>

<dns-manual>

# config-key Configuration API Remote to player

Set a fixed set of DNS servers on the player.

Details
<dns-manual>...</dns-manual>

Since 4.2.3

Related <configuration>

<echo-cancellation>

# config-key Configuration API Remote to player

Enable or disable the WebRTC audio processing (echo cancelation) in HTML content.

Details
<echo-cancellation>...</echo-cancellation>

Notes Applies to HMP400/W.

Since 4.5.0

Related <configuration>

<enable-audio>

# config-key Configuration API Remote to player

Enables or disables the player audio output.

Details
<enable-audio>...</enable-audio>
<enable-audio>yes</enable-audio>

Since 2.2.1

Related <configuration>

<enable-cloud>

# config-key Configuration API Remote to player

Enable communications with the SpinetiX cloud.

Details
<enable-cloud>...</enable-cloud>

Since 4.5.0

Related <configuration>

<enable-USB-IO-API>

# config-key Configuration API Remote to player

Enable or disable the USB I/O API.

Details
<enable-USB-IO-API>...</enable-USB-IO-API>

Notes It doesn't apply to DiVA. Also set in Control Center under Peripherals > USB.

Since 3.0.0

Related <configuration>, HID

<encrypted-network-api-psk>

# config-key Configuration API Remote to player

The encrypted pre-shared key generated by Control Center during backup.

Details
<encrypted-network-api-psk>...</encrypted-network-api-psk>

Notes It doesn't apply to HMP300 and DiVA.

Since 4.3.0

Related <configuration>

<encrypted-webstorage-token>

# config-key Configuration API Remote to player

The encrypted webstorage token generated by Control Center during backup.

Details
<encrypted-webstorage-token>...</encrypted-webstorage-token>

Notes It doesn't apply to HMP300 and DiVA.

Since 4.6.3

Related <configuration>

<enroll-base-url>

# config-key Configuration API Remote to player

Set the enrolment server URL.

Details
<enroll-base-url>...</enroll-base-url>

Since 4.7.2

Related <configuration>

<ethernet-dhcp>

# config-key Configuration API Remote to player

Configure the player to use Ethernet for its network connection with a DHCP assigned address for its IPv4 configuration.

Details
<ethernet-dhcp/>
<ethernet-dhcp/>

Since 2.2.1

Related <configuration>

<ethernet-static>

# config-key Configuration API Remote to player

Configure the player to use Ethernet for its network connection with a fixed IPv4 address.

Details
<ethernet-static>...</ethernet-static>
ParameterTypeDefaultDescription
addressstringIPv4 address
netmaskstringNetmask
gatewaystringGateway
dnsstringDNS server
<ethernet-static>
  <address>192.168.1.10</address>
  <netmask>255.255.255.0</netmask>
  <gateway>192.168.1.1</gateway>
  <dns>192.168.1.1</dns>
</ethernet-static>

Notes Modified in 4.2.3.

Since 2.2.1

Related <configuration>

<ethernet-v6-none>

# config-key Configuration API Remote to player

Stop the player adding IPv6 addresses to the Ethernet interface other than the SLAAC-assigned ones.

Details
<ethernet-v6-none>...</ethernet-v6-none>

Since 4.2.3

Related <configuration>

<ethernet-v6-static>

# config-key Configuration API Remote to player

Configure the player to add a fixed IPv6 address to the Ethernet interface.

Details
<ethernet-v6-static>...</ethernet-v6-static>

Since 4.2.3

Related <configuration>

<features-check>

# config-key Configuration API Remote to player

Check the Feature Set.

Details
<features-check>...</features-check>

Notes Applies to HMP400/W and iBX players.

Since 4.6.0

Related <configuration>

<firmware-update-auto>

# config-key Configuration API Remote to player

Set the hour for daily firmware update check or disable this feature.

Details
<firmware-update-auto>...</firmware-update-auto>
<firmware-update-auto>3</firmware-update-auto>

Notes Modified in 4.4.2. It doesn't apply to DiVA. The value is the hour of the daily check (3 = 3 AM). If a new version is found, the player updates itself.

Since 2.2.1

Related <configuration>

<firmware-update-uri>

# config-key Configuration API Remote to player

Set the URI of the firmware update repository.

Details
<firmware-update-uri>...</firmware-update-uri>
<firmware-update-uri>http://download.spinetix.com/hmp400-next/updates/</firmware-update-uri>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<http-capture-log>

# config-key Configuration API Remote to player

Enable capturing the HTTP traffic for the player.

Details
<http-capture-log>...</http-capture-log>

Notes Applies to HMP350, HMP400/W, and iBX players.

Since 4.4.0

Related <configuration>

<http-publish-secure-only>

# config-key Configuration API Remote to player

Enables or disables allowing connections to the publish server over HTTPS only.

Details
<http-publish-secure-only>...</http-publish-secure-only>

Since 4.3.0

Related <configuration>

<http-server-security-access>

# config-key Configuration API Remote to player

Set whether the player web server shall accept unsecure HTTP connection.

Details
<http-server-security-access>...</http-server-security-access>

Since 4.2.0

Related <configuration>

<https-validate-certificates>

# config-key Configuration API Remote to player

Set whether the player shall accept only trusted HTTPS certificates.

Details
<https-validate-certificates>...</https-validate-certificates>

Since 2.2.5

Related <configuration>

<license-file>

# config-key Configuration API Remote to player

Add/remove a Feature Set of the player.

Details
<license-file>...</license-file>

Notes Applies to HMP400/W and iBX players.

Since 4.6.0

Related <configuration>

<live-source-add>

# config-key Configuration API Remote to player

Add a live source onto the player.

Details
<live-source-add>...</live-source-add>

Notes Applies only to HMP350 and HMP300.

Since 4.0.0

Related <configuration>

<live-source-reset>

# config-key Configuration API Remote to player

Remove all live sources from the player.

Details
<live-source-reset>...</live-source-reset>

Notes Applies only to HMP350 and HMP300.

Since 4.0.0

Related <configuration>

<llmnr-enabled>

# config-key Configuration API Remote to player

Control whether Windows compatible name resolution (LLMNR) is enabled on the player.

Details
<llmnr-enabled>...</llmnr-enabled>

Since 4.7.0

Related <configuration>

<maximum-latency>

# config-key Configuration API Remote to player

Set the rendering latency of the player.

Details
<maximum-latency>...</maximum-latency>

Notes Modified in 4.7.2. It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<modem-3g-advanced>

# config-key Configuration API Remote to player

Set the player to use 3G modem as network connection using advanced settings.

Details
<modem-3g-advanced>...</modem-3g-advanced>

Notes It doesn't apply to HMP300 and DiVA.

Since 2.2.1

Related <configuration>

<modem-3g-simple>

# config-key Configuration API Remote to player

Set the player to use 3G modem as network connection using simplified settings.

Details
<modem-3g-simple>...</modem-3g-simple>

Notes It doesn't apply to HMP300 and DiVA.

Since 2.2.1

Related <configuration>

<network-api-enabled-secure>

# config-key Configuration API Remote to player

Enable or disable the secure access (CoAP REST API over TLS-PSK) to the Shared Variables Network API.

Details
<network-api-enabled-secure>...</network-api-enabled-secure>

Notes It doesn't apply to HMP300 and DiVA.

Since 4.3.0

Related <configuration>

<network-api-enabled>

# config-key Configuration API Remote to player

Set whether the Network API is enabled.

Details
<network-api-enabled>...</network-api-enabled>

Notes It doesn't apply to HMP300 and DiVA.

Since 2.2.1

Related <configuration>

<network-api-port>

# config-key Configuration API Remote to player

Set the port used by the Shared Variables Network API to listen to incoming connections.

Details
<network-api-port>...</network-api-port>

Notes It doesn't apply to HMP300 and DiVA.

Since 2.2.1

Related <configuration>

<network-api-psk>

# config-key Configuration API Remote to player

Set a pre-shared key to be used by the Shared Variable Network API server to encrypt communications.

Details
<network-api-psk>...</network-api-psk>

Notes It doesn't apply to HMP300 and DiVA.

Since 4.3.0

Related <configuration>

<network-api-server>

# config-key Configuration API Remote to player

Set the default Shared Variables Network API server, used when a Shared Variable gives no server with the @ notation.

Details
<network-api-server>...</network-api-server>

Notes It doesn't apply to HMP300 and DiVA.

Since 4.3.0

Related <configuration>

<network-watchdog>

# config-key Configuration API Remote to player

Set the network watchdog parameters.

Details
<network-watchdog>...</network-watchdog>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<overlay>

# config-key Configuration API Remote to player

Configure the player-level overlay content.

Details
<overlay>...</overlay>

Notes It doesn't apply to DiVA.

Since 4.8.6

Related <configuration>

<overscan-percentage>

# config-key Configuration API Remote to player

Set the percentage of overscan done by the screen attached to the player.

Details
<overscan-percentage>...</overscan-percentage>

Since 2.2.1

Related <configuration>

<passphrase>

# config-key Configuration API Remote to player

Set or clear the passphrase to be used to encode the passwords and other secrets present in the backup.

Details
<passphrase>...</passphrase>

Since 4.2.0

Related <configuration>

<protocol-disabled>

# config-key Configuration API Remote to player

Disable the usage of FSM protocol file.

Details
<protocol-disabled>...</protocol-disabled>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<protocol-file-reset>

# config-key Configuration API Remote to player

Remove all FSM files that are present on the device.

Details
<protocol-file-reset>...</protocol-file-reset>

Notes It doesn't apply to DiVA.

Since 3.1.0

Related <configuration>

<protocol-file>

# config-key Configuration API Remote to player

Select a custom FSM file as the active protocol file of the device.

Details
<protocol-file>...</protocol-file>

Notes Modified in 3.0.0. Last modified in 3.0.0 firmware. It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<protocol-simple>

# config-key Configuration API Remote to player

Configure one or more (simple) commands for screen control, to be sent over the serial port.

Details
<protocol-simple>...</protocol-simple>

Notes It doesn't apply to DiVA.

Since 4.0.1

Related <configuration>

<protocol-system>

# config-key Configuration API Remote to player

Enable the usage of one of the internal protocol files available in the device.

Details
<protocol-system>...</protocol-system>

Notes Modified in 3.0.0. Last modified in 3.0.0 firmware. It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<pullmode-http-capture-log>

# config-key Configuration API Remote to player

Enable capturing the HTTP traffic for Pull Mode.

Details
<pullmode-http-capture-log>...</pullmode-http-capture-log>

Notes Applies to HMP350, HMP400/W, and iBX players.

Since 4.4.0

Related <configuration>

<pullmode-logs-level>

# config-key Configuration API Remote to player

Set the logging level for the uploader.log (used by Pull Mode).

Details
<pullmode-logs-level>...</pullmode-logs-level>
<pullmode-logs-level>trace</pullmode-logs-level>

Notes To be used only for debugging purpose. Values used on the wiki: trace, info. Enable trace only when SpinetiX Support asks.

Since 4.1.0

Related <configuration>

<reboot/>

in <configuration> # config-key Configuration API Remote to player

Reboots the player after all other tags have run, when a tag needs it or a reboot is pending.

Details
<reboot/>

Can appear anywhere in the string but runs last. If any tag has an error, the player does not reboot. Without it, settings that need a reboot wait for a manual reboot or another configuration containing the tag.

<reboot/>

<reduce-interactive-latency>

# config-key Configuration API Remote to player

Configure the player to reduce the rendering latency to 60 ms when interactive events are received.

Details
<reduce-interactive-latency>...</reduce-interactive-latency>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<regenerate-secret-key>

# config-key Configuration API Remote to player

Force the player to re-generate a new secret key and clear all previously set passphrase.

Details
<regenerate-secret-key>...</regenerate-secret-key>

Since 4.2.0

Related <configuration>

<reset-arya>

# config-key Configuration API Remote to player

Reset the ARYA mode, allowing the user to (re)select between DiVA built-in interface or ARYA cloud interface for content managing.

Details
<reset-arya>...</reset-arya>

Notes Applies to DiVA.

Since 4.4.0

Related <configuration>

<reset-cache>

# config-key Configuration API Remote to player

Reset the network cache.

Details
<reset-cache>...</reset-cache>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>

<reset-content>

# config-key Configuration API Remote to player

Reset all the content on the player: the published content, the content created within the web interface and the web storage data.

Details
<reset-content>...</reset-content>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>

<reset-log>

# config-key Configuration API Remote to player

Reset the player logs.

Details
<reset-log>...</reset-log>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>

<reset-ntp>

# config-key Configuration API Remote to player

Reset the internal clock calibration data.

Details
<reset-ntp>...</reset-ntp>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>

<reset-published-content>

# config-key Configuration API Remote to player

Reset the content published on the player.

Details
<reset-published-content>...</reset-published-content>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>

<reset-webstorage>

# config-key Configuration API Remote to player

Reset the web storage data.

Details
<reset-webstorage>...</reset-webstorage>

Notes It doesn't apply to DiVA.

Since 4.4.0

Related <configuration>, reset

<rpc-api-key>

# config-key Configuration API Remote to player

Set or clear the RPC API key.

Details
<rpc-api-key>...</rpc-api-key>

Notes It doesn't apply to HMP300 and DiVA. This is the key used as spx-api-key in RPC, Status API and Web Storage REST calls.

Since 4.0.0

Related <configuration>, POST /rpc?spx-api-key=

<scheduled-download-add>

# config-key Configuration API Remote to player

Add a scheduled download onto the player.

Details
<scheduled-download-add>...</scheduled-download-add>
ParameterTypeDefaultDescription
uristringProject location
updatestringFor example daily
timestringFor example 3:10
<scheduled-download-add>
  <uri>http://demo.spinetix.com/sample_projects/School/spx-listing.xml</uri>
  <update>daily</update>
  <time>3:10</time>
</scheduled-download-add>

Notes It doesn't apply to DiVA.

Since 4.0.0

Related <configuration>

<scheduled-download-reset>

# config-key Configuration API Remote to player

Remove all scheduled downloads from the player.

Details
<scheduled-download-reset/>
<scheduled-download-reset/>

Notes It doesn't apply to DiVA.

Since 4.0.0

Related <configuration>

<screen-aspect-ratio>

# config-key Configuration API Remote to player

Set the aspect ratio of the screen.

Details
<screen-aspect-ratio>...</screen-aspect-ratio>
<screen-aspect-ratio>16:9</screen-aspect-ratio>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<screen-id>

# config-key Configuration API Remote to player

Set the screen ID for multiscreen content.

Details
<screen-id>...</screen-id>

Notes It doesn't apply to HMP300 and DiVA.

Since 2.2.1

Related <configuration>

<secure-admin>

# config-key Configuration API Remote to player

Set whether remote actions assigned to the admin role, such as executing RPC commands, require credentials (user and password).

Details
<secure-admin>...</secure-admin>

Notes It doesn't apply to DiVA. Deprecated in 4.9.0.

Since 4.0.0

Related <configuration>

<secure-content>

# config-key Configuration API Remote to player

Set whether remote actions assigned to the content authoring role require credentials (user and password).

Details
<secure-content>...</secure-content>

Notes It doesn't apply to DiVA. Deprecated in 4.9.0.

Since 4.0.0

Related <configuration>

<secure-monitoring>

# config-key Configuration API Remote to player

Set whether remote actions assigned to the monitoring role require credentials (user and password).

Details
<secure-monitoring>...</secure-monitoring>

Notes It doesn't apply to DiVA. Deprecated in 4.9.0.

Since 4.0.0

Related <configuration>

<server-certificate>

# config-key Configuration API Remote to player

Add an HTTP server certificate to the device.

Details
<server-certificate>...</server-certificate>

Notes Modified in 4.2.2. Last modified in 4.2.2 firmware.

Since 4.2.0

Related <configuration>

<server-certificates-reset>

# config-key Configuration API Remote to player

Remove all server certificates that are present on the device.

Details
<server-certificates-reset>...</server-certificates-reset>

Since 4.2.0

Related <configuration>

<shutdown-temperature>

# config-key Configuration API Remote to player

Set the automatic shutdown temperature.

Details
<shutdown-temperature>...</shutdown-temperature>

Notes Applies to HMP350, HMP300, and DiVA.

Since 2.2.1

Related <configuration>

<snmp-all>

# config-key Configuration API Remote to player

Enable access to the SNMP service from any host.

Details
<snmp-all>...</snmp-all>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<snmp-limited>

# config-key Configuration API Remote to player

Enable connections to the SNMP service from remote hosts if they are within the given address range.

Details
<snmp-limited>...</snmp-limited>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<snmp-local>

# config-key Configuration API Remote to player

Disable SNMP connections outside the player.

Details
<snmp-local>...</snmp-local>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<snmp-rocommunity>

# config-key Configuration API Remote to player

Configure the name of the SNMP read-only community.

Details
<snmp-rocommunity>...</snmp-rocommunity>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<splash>

# config-key Configuration API Remote to player

Set the splash images used by the device when booting, restarting or updating the firmware.

Details
<splash>...</splash>

Since 3.0.0

Related <configuration>

<ssdp-upnp-enabled>

# config-key Configuration API Remote to player

Set whether SSDP / UPnP discovery is enabled in the player.

Details
<ssdp-upnp-enabled>...</ssdp-upnp-enabled>

Since 4.1.0

Related <configuration>

<streaming>

# config-key Configuration API Remote to player

Enable/disable the streaming of the player’s video output.

Details
<streaming>...</streaming>

Notes Applies to HMP400/W and iBX players.

Since 4.7.0

Related <configuration>

<time-ntp-restore>

# config-key Configuration API Remote to player

Restore the default NTP configuration.

Details
<time-ntp-restore>...</time-ntp-restore>

Since 4.0.0

Related <configuration>

<time-ntp>

# config-key Configuration API Remote to player

Configure one or more NTP servers as time source.

Details
<time-ntp>...</time-ntp>

Since 2.2.1

Related <configuration>

<timezone>

# config-key Configuration API Remote to player

Set the player time zone. Accepted values are tz database names, e.g. Europe/Zurich.

Details
<timezone>...</timezone>
<timezone>Europe/Zurich</timezone>

Since 2.2.1

Related <configuration>

<touchscreen>

# config-key Configuration API Remote to player

Set the calibration parameters of the connected touchscreen.

Details
<touchscreen>...</touchscreen>

Notes It doesn't apply to DiVA.

Since 2.2.1

Related <configuration>

<underscan-supported>

# config-key Configuration API Remote to player

Set whether the information returned by the TV screen concerning underscan should be used.

Details
<underscan-supported>...</underscan-supported>

Since 2.2.1

Related <configuration>

<user-reset>

# config-key Configuration API Remote to player

Remove all configured users (except the admin user).

Details
<user-reset>...</user-reset>

Since 4.0.0

Related <configuration>

<user>

# config-key Configuration API Remote to player

Create a new user, update an existing user or remove an existing user.

Details
<user>...</user>
ParameterTypeDefaultDescription
usernamestringUser name
passwordstringAt least 8 characters with 1 uppercase, 1 lowercase and 1 punctuation mark
adminstringyes for administrator rights
<user>
  <username>admin2</username>
  <password>Your_38_characters_STRONG_PASSWORD! ;)</password>
  <admin>yes</admin>
</user>

Notes Modified in 4.3.0. Last modified in 4.0.0 firmware. user-reset removes all users except admin.

Since 2.2.1

Related <configuration>

<vga-dc-offset>

# config-key Configuration API Remote to player

Indicate that the VGA display connected to the player supports a DC voltage offset in the RGB signals.

Details
<vga-dc-offset>...</vga-dc-offset>

Notes Applies to HMP200, HMP130, HMP100.

Since 2.2.4

Related <configuration>

<vga-power-mode>

# config-key Configuration API Remote to player

Set whether the VGA output is on.

Details
<vga-power-mode>...</vga-power-mode>

Notes Applies to HMP200, HMP130, HMP100.

Since 2.2.1

Related <configuration>

<video-output-selector>

# config-key Configuration API Remote to player

Select the video output of the player.

Details
<video-output-selector>...</video-output-selector>

Notes Modified in 4.8.0. Applies to HMP400/W and iBX players.

Since 4.5.0

Related <configuration>

<wifi-ap-add>

# config-key Configuration API Remote to player

Add a new entry to the Wi-Fi access point list.

Details
<wifi-ap-add>...</wifi-ap-add>

Notes Applies to HMP400W and iBX410W.

Since 4.5.1

Related <configuration>

<wifi-ap-reset>

# config-key Configuration API Remote to player

Clear the Wi-Fi access point list.

Details
<wifi-ap-reset>...</wifi-ap-reset>

Notes Applies to HMP400W and iBX410W.

Since 4.5.1

Related <configuration>

<wifi-dhcp>

# config-key Configuration API Remote to player

Configure the player to use Wi-Fi for its network connection with a DHCP assigned address for its IPv4 configuration.

Details
<wifi-dhcp>...</wifi-dhcp>

Notes Applies to HMP400W and iBX410W.

Since 2.2.1

Related <configuration>

<wifi-static>

# config-key Configuration API Remote to player

Configure the player to use Wi-Fi for its network connection with a fixed IPv4 address.

Details
<wifi-static>...</wifi-static>

Notes Applies to HMP400W and iBX410W.

Since 2.2.1

Related <configuration>

<wifi-v6-none>

# config-key Configuration API Remote to player

Stop the player adding IPv6 addresses to the Wi-Fi interface other than the SLAAC-assigned ones.

Details
<wifi-v6-none>...</wifi-v6-none>

Notes Applies to HMP400W and iBX410W.

Since 4.2.3

Related <configuration>

<wifi-v6-static>

# config-key Configuration API Remote to player

Configure the player to add a fixed IPv6 address to the Wi-Fi interface.

Details
<wifi-v6-static>...</wifi-v6-static>

Notes Applies to HMP400W and iBX410W.

Since 4.2.3

Related <configuration>

<wired-auth-add>

# config-key Configuration API Remote to player

Set the 802.1x authentication parameters for Ethernet.

Details
<wired-auth-add>...</wired-auth-add>

Notes Applies to HMP400/W and iBX players.

Since 4.5.1

Related <configuration>

<wired-auth-reset>

# config-key Configuration API Remote to player

Clear the 802.1x authentication parameters on Ethernet.

Details
<wired-auth-reset>...</wired-auth-reset>

Notes Applies to HMP400/W and iBX players.

Since 4.5.1

Related <configuration>

Configuration file

in <configuration> # property Configuration API Remote to player

A configuration string saved as a file with extension xml, cfg or spx and applied to the player.

Details
*.xml | *.cfg | *.spx

Apply it by dragging onto the player thumbnail in ARYA (Players > Setup), with Restore Config or drag and drop in Control Center, or from a USB stick (DSOS 4.5.1 or later). The config.xml in a configuration backup is a full file to start from.

Related <configuration>

Execution order

in <configuration> # property Configuration API Remote to player

Tags are applied in document order; if two tags set the same thing, the last one wins. Only reboot is deferred.

Details
Tags run in the order given

Example: with both <ethernet-dhcp/> and <ethernet-static>, the later one counts.

Automation API 4

Automation API key

# property Automation API Cloud

Every call needs the ARYA API key secret and the account ID.

Details
API key: secret key value + account ID

Keys are generated in ARYA (see the ARYA support article on API keys). The wiki does not show the header names.

Related PUT /alerts/{id}/state

GET /alerts

# endpoint Automation API Cloud

Lists the alert media of the account group with their on/off state.

Details
GET /alerts?max={n}&nextToken={token}
ParameterTypeDefaultDescription
maxintegerMaximum number of entries to return, 1 to 50.
nextTokenstringPagination token from a previous response.

Returns JSON { alerts: [{ alertId, name, state: { enabled } }], nextToken }

Notes Defined in File:Automation-api-schema_v0.1.yml (OpenAPI 3.0, API version 0.1). Auth: apiKey and accountId query parameters. Errors: 400, 401, 403, 404. Response header cache-control: no-cache, private.

Related PUT /alerts/{id}/state, Automation API key

GET /alerts/{id}

# endpoint Automation API Cloud

Returns one alert with its state and the players and groups it targets.

Details
GET /alerts/{id}
ParameterTypeDefaultDescription
idstringThe ID of the alert.

Returns JSON { alertId, name, state: { enabled }, targets: { players: [{ serial, name }], groups: [{ name }] } }

Notes Defined in File:Automation-api-schema_v0.1.yml (OpenAPI 3.0, API version 0.1). Auth: apiKey and accountId query parameters. Errors: 400, 401, 403, 404. Response header cache-control: no-cache, private.

Related PUT /alerts/{id}/state, Automation API key

PUT /alerts/{id}/state

# endpoint Automation API Cloud

Switches an ARYA alert on or off. The alert state on screen is updated on all assigned targets.

Details
PUT /alerts/{id}/state
ParameterTypeDefaultDescription
idstringPath parameter: ID of the alert.
enabledbooleanBody (application/json): true or false.

Returns 200: {"enabled": true}

PUT /alerts/{id}/state
{ "enabled": true }

Notes Available to ARYA Enterprise accounts. The overview says the API can also retrieve alert information (GET), but gives no path; the OpenAPI schema (Automation-api-schema_v0.1.yml) holds the full list. The target players of an alert are set in ARYA and cannot be changed through the API.

Related Automation API key

USB I/O API 37

action

in HIDEvent # attribute USB I/O API In content

One of HID_DEVICE_PLUGGED, HID_DEVICE_REMOVED, HID_REPORT_IN, HID_REPORT_FEATURE.

Details
ev.action

Returns unsigned short

collectionUsagePage

in HIDReportField # attribute USB I/O API In content

Usage page of the application collection that holds the main item.

Details
field.collectionUsagePage

Returns unsigned short

getFeatureReport()

in HumanInterfaceDevice # method USB I/O API In content

Asks the device for a feature report. The result arrives as an HID event.

Details
device.getFeatureReport(reportID)
ParameterTypeDefaultDescription
reportIDunsigned shortReport to request.

Related HIDEvent

getUsage()

in HIDReport # method USB I/O API In content

Gets a field from the report by usage code instead of by index.

Details
report.getUsage(usagePage, usage)
ParameterTypeDefaultDescription
usagePageunsigned shortUsage page.
usageunsigned shortUsage.

Returns long

HID

# property USB I/O API In content

Global array of HumanInterfaceDevice objects for all connected USB HID devices.

Details
HID

Find a device by comparing vendorID and productID. Hot-plug works on the player only, not in Elementi. Applies to legacy players, HMP350 and HMP400/400W with the SYSTEMS Feature Set. Off by default since firmware 3.1.0; enable in Control Center (Peripherals > USB) or with the enable-USB-IO-API config tag.

for (var i = 0; i < HID.length; i++) {
  alert(HID[i].vendorID.toString(16) + ':' + HID[i].productID.toString(16));
}

Since 3.0.0

Related <enable-USB-IO-API>

hid event

# event USB I/O API In content

Fired when a device is plugged or removed, or a report arrives.

Details
window.addEventListener('hid', function (ev) {...})
window.addEventListener('hid', function (ev) {
  if (ev.action == HIDEvent.HID_REPORT_IN && ev.device == dev) {
    for (var n = 0; n < ev.report.length; n++) {
      if (ev.report[n] !== null) { alert('Got ev.report[' + n + '] = ' + ev.report[n]); }
    }
  }
});

Notes Fields not present in a report are null.

Related HIDEvent

HIDEvent

# property USB I/O API In content

Event object for HID plug, removal and report events.

Details
interface HIDEvent : Event

Related hid event

HIDReport

# property USB I/O API In content

Array of integer values, one per report field.

Details
interface HIDReport : Array of long

Related getUsage()

HIDReportFields

# property USB I/O API In content

Array of HIDReportField objects for one report, with a reportID.

Details
interface HIDReportFields : Array of HIDReportField

reportID is the id from the HID report descriptor; 0 means a single report with no id. All fields of all main items are listed in a flat array.

HumanInterfaceDevice

# property USB I/O API In content

One I/O interface of a USB HID device, with identification attributes and report methods.

Details
interface HumanInterfaceDevice

Multifunction devices expose several interfaces with different usage codes.

Related HID

index

in HIDReportField # attribute USB I/O API In content

Position of the field in the report; the same index is used when reading and sending. Not the same in Elementi and on the player.

Details
field.index

Returns short

report

in HIDEvent # attribute USB I/O API In content

HIDReport object; only present for report-in and report-feature events.

Details
ev.report

Returns HIDReport

sendFeatureReport()

in HumanInterfaceDevice # method USB I/O API In content

Sends a feature report. Works exactly like sendOutputReport.

Details
device.sendFeatureReport([reportID,] values)
ParameterTypeDefaultDescription
reportIDunsigned shortOptional.
valuesArray | ObjectAs for sendOutputReport.

Related sendOutputReport()

sendOutputReport()

in HumanInterfaceDevice # method USB I/O API In content

Sends an output report. Values is an array for all fields, or an object keyed by field index for selected fields.

Details
device.sendOutputReport([reportID,] values)
ParameterTypeDefaultDescription
reportIDunsigned shortOptional.
valuesArray | ObjectAll values, or {index: value} for selected fields.
dev.sendOutputReport([0xBA, 0xDC, 0xAF, 0xFE, 0xFE, 0xED]);
dev.sendOutputReport({ 0: 0xFA, 5: 0xCE });

Related sendFeatureReport()

Pull Mode 39

-buffer true

in upload # attribute Pull Mode Player to server

Buffers uploads so the Content-Length header is valid; needed for Amazon S3 or mydrive.ch.

Details
-buffer true

Notes Options apply to the batch of files that follows them.

Since 3.0.6

-content

in upload # attribute Pull Mode Player to server

Uploads an XML repository descriptor listing the files on the player content server.

Details

-data <key> <value>

in upload # attribute Pull Mode Player to server

Adds a key=value pair to the POST request. Repeat for more pairs.

Details
-data <key> <value>

-data reset removes all pairs set before.

Notes Options apply to the batch of files that follows them.

Since 3.0.6

-deletelast

in publish # attribute Pull Mode Player to server

Deletes removable files after the new files are downloaded instead of at the start.

Details
-deletelast

-dest <folder>

in publish # attribute Pull Mode Player to server

Publishes into an inner folder instead of the content root; index.svg is not reloaded.

Details
-dest <folder>

Folder path must be URI encoded and not start with a slash or backslash; created if missing.

-feedback <uri> [fulllisting]

in publish # attribute Pull Mode Player to server

Without an RPC concentrator, sends an HTTP POST to the URI at the end of the publish.

Details
-feedback <uri> [fulllisting]

Form-encoded fields: starttime, uploadedfiles, nberrors, statustype (always "final"). With the fulllisting flag the XML repository descriptor is added as multipart/form-data (PHP: $_FILES).

print_r($_POST, true);

Notes The timestamp was always 0 (Unix epoch) before DSOS 4.9.5.

-format <destination_name_syntax>

in upload # attribute Pull Mode Player to server

Sets a global file naming format for files given as URIs; not for shortcuts.

Details
-format <destination_name_syntax>

Notes Options apply to the batch of files that follows them.

-header <name> <value>

in upload # attribute Pull Mode Player to server

Adds an HTTP header to the PUT or POST request. Repeat for more headers.

Details
-header <name> <value>

-header reset removes all headers set before.

Notes Options apply to the batch of files that follows them.

Since 3.0.6

-info <n_seconds> <flags_object>

in rpc # attribute Pull Mode Player to server

Sends an info notification every n seconds, rounded up to a multiple of the polling time.

Details
-info <n_seconds> <flags_object>

flags_object is JSON, for example { "all": true }; default is the all flag.

Since 3.0.0

-log <name>

in upload # attribute Pull Mode Player to server

Uploads one log by name (for example accounting.log, uploader.log), the info status file (-log info) or the system log (-log syslog).

Details
-log <name>

Since 3.0.0

-logs

in upload # attribute Pull Mode Player to server

Uploads archived logs of earlier days, checking that all past logs are uploaded. The player keeps at most 7 days.

Details

-method post

in upload # attribute Pull Mode Player to server

Uploads with POST instead of the default PUT (for plain HTTP servers).

Details
-method post

Notes Options apply to the batch of files that follows them.

-norecurs

in publish # attribute Pull Mode Player to server

No recursion: only the root (or the -dest folder) changes; no sub-folders are created or deleted.

Details

-notification

in rpc # attribute Pull Mode Player to server

No RPC commands are accepted in the server's response to ready.

Details
-notification

Since 3.0.0

-pastlogs

in upload # attribute Pull Mode Player to server

Uploads archived logs without checking which are already on the server.

Details

-polling <n_seconds>

in rpc # attribute Pull Mode Player to server

How often the ready notification is sent; typical 10-120 s, default one hour.

Details
-polling <n_seconds>

Since 3.0.0

-restarted <flags_object>

in rpc # attribute Pull Mode Player to server

Sets the flags of the restarted notification.

Details
-restarted <flags_object>

Default flags: reason and status. Flags are listed under get_info in the RPC API PDF.

Since 3.0.0

-statusinterval <n_seconds>

in publish # attribute Pull Mode Player to server

Sends a status update to the RPC concentrator every n seconds.

Details
-statusinterval <n_seconds>

If combined with -statusnrfiles or -statussize, pull_status is sent when all conditions are reached.

Since 3.0.3

Related pull_status

DESCRIPTION

in Pull Mode event (ICS VEVENT) # attribute Pull Mode Player to server

Extra options for the publish, upload and rpc actions; for inline-rpc, the RPC command itself.

Details
DESCRIPTION

Several options are separated by \n. UID, VTIMEZONE and PRIORITY may also appear in the file.

Destination name placeholders

in upload # attribute Pull Mode Player to server

Placeholders for naming the uploaded file.

Details
%D %H %d %h %n %s %x

%D modification date of the file; %H modification time; %d date of upload; %h time of upload; %n source file name; %s player serial number; %x source extension. Default: %n-%s-%d-%h.%x.

-snapshot %s-%n.jpg

inline-rpc

# message Pull Mode Player to server

Runs an RPC command from the ICS file on a schedule. DESCRIPTION holds the command as JSON.

Details
SUMMARY:inline-rpc
DTSTART:<datetime>
DTEND:<datetime>
RRULE:<rule>
DESCRIPTION:<RPC command JSON>
BEGIN:VEVENT
UID:14d64d53-a926-4a71-848d-c78452b345fe
DTSTART:20220801T010000
DTEND:20220801T013000
SUMMARY:inline-rpc
DESCRIPTION: {"method":"restart","params":[],"id":1}
RRULE:FREQ=DAILY;WKST=SU
END:VEVENT

Notes Unlike other ICS events, an inline RPC command runs only if the player is on at the start time of the event.

Since 3.0.0

Related Inline RPC, restart

publish

# message Pull Mode Player to server

Downloads a project (or some files) from a server so the player content becomes an exact copy; index.svg is then reloaded.

Details
SUMMARY:publish
URL:<server_location>
DESCRIPTION:<options>

URL is a WebDAV folder, or an XML repository descriptor (spx-listing.xml) on a plain HTTP server. Unchanged files are skipped (ETag / Last-Modified). Initial connection timeout 10 minutes, then 10 minutes during transfer. Port: the one in the URL, else 80 (http) or 443 (https). Avoid spaces in paths; use underscores.

Notes On legacy players with Fusion enabled use -dest publish or nothing is published.

Related add_pull_action, -deletelast, spx-listing.xml, WebDAV PROPFIND (content server)

Pull Mode event (ICS VEVENT)

# message Pull Mode Player to server

Each Pull Mode action is one iCalendar event in the ICS file the player is set to read.

Details
BEGIN:VEVENT ... SUMMARY / URL / DTSTART / DTEND / RRULE / DESCRIPTION ... END:VEVENT

The ICS file can be uploaded in Control Center (Advanced Applications > Pull Mode), referenced on a remote web server, or placed in a custom configuration file (pull-mode-file, pull-mode-remote). On restart the file is reprocessed and past events whose end is still ahead may run again.

BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VEVENT
UID:14d64d53-a926-4a71-848d-c78452b195fe
DTSTART:20190101T060000
DTEND:20190101T070000
RRULE:FREQ=DAILY;WKST=SU
SUMMARY:publish
URL: http://demo.spinetix.com/project/default/publish.xml
DESCRIPTION:-deletelast
END:VEVENT
END:VCALENDAR

Notes Not for DiVA. Event duration is a validity window: the player retries until DTEND, and drops the event when the action succeeds. After a restart, events whose end time is still in the future run again.

Related <pull-mode-file>, <pull-mode-remote>

rpc

# message Pull Mode Player to server

Sets up an RPC concentrator from the ICS file: URL is the concentrator, DESCRIPTION holds the options.

Details
SUMMARY:rpc
URL:<RPC_Concentrator_uri>
DESCRIPTION:<parameters>

Options are separated by \n.

Notes Each rpc event names one concentrator, so several can be configured.

Since 3.0.0

Related RPC Concentrator, ready

RRULE

in Pull Mode event (ICS VEVENT) # attribute Pull Mode Player to server

Recurrence rule for repeating events.

Details
RRULE

Specify it once per event. Example: FREQ=MINUTELY;INTERVAL=15;WKST=SU. Limits: no more than 100 events per 8 hours (repeat no faster than every 5 minutes for one action, 10 minutes each for two); an event must not overlap the next one of its series (a 2 hour interval needs a duration of 2h or less, for example 1h 59m 59s).

spx-listing.xml

# element Pull Mode Player to server

XML file listing the files of a repository, for servers without WebDAV. Point the publish URL at it.

Details
spx-listing.xml (XML repository descriptor file)

Elementi M/X generate it in the root of the repository with Publish Location. Otherwise use a script (sample PHP 'Files pull' and 'Database pull' from SpinetiX) or write it by hand; format is on the XML repository descriptor file page.

Related publish

upload

# message Pull Mode Player to server

Uploads logs, snapshots or the player report to a server; the player content is not touched.

Details
SUMMARY:upload
URL:<server_location>
DESCRIPTION:[<options>\n]<file>[ <destination_name>]

Usually a WebDAV server, but a plain HTTP server works with -method post. Each file instruction is on its own line (\n). <file> is a URI (for example http://localhost/status/snapshot) or a shortcut. Needs write access on the server. The source file keeps its name unless a destination name is given; default format %n-%s-%d-%h.%x.

BEGIN:VEVENT
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

Related GET /status/snapshot, Destination name placeholders

WebDAV PROPFIND (content server)

# message Pull Mode Player to server

The player reads the remote folder tree and file properties with WebDAV PROPFIND to download only new or changed files.

Details
PROPFIND on the content server

IIS 7+ allows only PROPFIND for anonymous users; PUT, MKCOL, PROPPATCH, COPY, MOVE, DELETE and WebDAV GET need authentication. The IIS tutorial adds: SVG MIME type, Directory Browsing enabled, WebDAV authoring rule, Digest (domain) or Basic authentication (Basic only over SSL in production). With Basic auth enable only Basic on the IIS site. Errors go to uploader.log.

Notes Box ended WebDAV support on 25 Oct 2019. A player can act as a WebDAV server but serves at most two concurrent clients.

Related publish, Player content server

Player web server 14

Authentication to remote servers

# property Player web server Player to server

Methods the player uses against servers that need login: Basic, Digest, NTLM (HTTPS only, 3.2.0), form-based via Web Robot (4.5.0).

Details
Basic | Digest | NTLM | form (Web Robot)

Credentials: Control Center > System > Saved Passwords (Elementi: Settings > Network Credentials). Kerberos, Integrated Windows Authentication and SPNEGO are not supported; SharePoint and Exchange default to IWA and must be changed site-wide.

Since 3.2.0

Custom HTML interface

# element Player web server Remote to player

Your own HTML page served by the player and linked in the Control Center top bar. Needs the WIDGETS Feature Set; not on DiVA.

Details
index.html (or interface/index.html) in the project root

Main file index.html; other files (CSS, scripts) go in a folder named interface. An index.html in the project root wins over one in interface/. Use relative links only. The title element becomes the link label (up to 20 Western-Latin characters). Publish the project, log in with content authoring or admin rights, click the link.

Notes Observed on players: opened at https://<ip>/uiauth/content/<project>/interface/index.html. A common use is buttons that call the Web Storage REST API (needs SYSTEMS Feature Set) to change the Shared Variable of an Action to Switch widget.

Since 4.2.0

Related POST /webstorage/{key}, webstorage_set

HTTPS access

# property Player web server Remote to player

DSOS players serve the web interface on 443 and the content server on 9802 over HTTPS. Legacy players have no HTTPS.

Details
https://[player_address] (443) | https://[player_address]:9802

The certificate is self-signed and auto-generated; install it on the PC, or upload your own under Network > Server Certificates (firmware 4.x). Insecure HTTP can be disabled under Network > Server Security.

Related <server-certificate>, <active-certificate>, <http-server-security-access>

Partial GET (HTTP Range)

# property Player web server Player to server

The player requests the first 512 kb with a Range header. If the server returns 500, it retries the whole file.

Details
Range: bytes=0-524287

resources.log may show 500 errors although the data displays. IIS does not serve SVG by default: add the SVG MIME type if resources.log shows 404 errors for existing files.

Player content server

# endpoint Player web server Remote to player

WebDAV storage for published content and pulled content, on port 9802 (HTTPS) . Not on DiVA.

Details
https://[player_address]:9802 (WebDAV)

Elementi and other WebDAV clients publish here. Content from Scheduled Download and Pull Mode is stored here too. Insecure HTTP can be disabled under Network > Server Security (http-server-security-access).

Notes Max two concurrent clients, including the web interface.

Related HTTPS access, <http-server-security-access>

Player web interface

# endpoint Player web server Remote to player

Opens Control Center, or redirects to ARYA, on port 80 / 443.

Details
GET http(s)://[player_address]/

Default user admin, default password admin; a new password is requested at the end of the Configuration Wizard. Players with ARYA mode (DiVA, HMP300, HMP350) or without a Feature Set (HMP400/400W, iBX410, iBX440, third-party) redirect to ARYA; a second admin user opens Control Center instead.

Related Custom HTML interface

Transfer protocols (outgoing)

# property Player web server Player to server

The player fetches content over HTTP, HTTPS and WebDAV. FTP, NFS and SMB are not supported.

Details
HTTP | HTTPS | WebDAV

Trusted root certificates match Firefox; validation is controlled under Network > Trusted Certificates (https-validate-certificates). SNI virtual hosts supported from firmware 3.1.0. You can publish to an FTP server or UNC share from Elementi, but the player reads them only over HTTP.

Since 3.1.0

Related <https-validate-certificates>

X-raperca-version (request)

# property Player web server Player to server

Sent by the player on its own HTTP requests; rendering engine version.

Details
X-raperca-version (request)

X-raperca-version (response)

# property Player web server Remote to player

Response header with the rendering engine version, usually equal to the firmware version.

Details
X-raperca-version (response)
X-raperca-version: 4.7.4-0

X-spinetix-firmware (request)

# property Player web server Player to server

Sent by the player on its own HTTP requests; firmware version.

Details
X-spinetix-firmware (request)

Since DSOS 4.7.1

X-spinetix-firmware (response)

# property Player web server Remote to player

Response header with the player firmware version.

Details
X-spinetix-firmware (response)

Added to every HTTP response from the player on port 80 or 81.

X-spinetix-firmware: 4.7.4-2.0.0-6bfffad2

X-spinetix-hw (response)

# property Player web server Remote to player

Response header with the hardware type.

Details
X-spinetix-hw (response)

Values: fukiran (HMP400), fukiran-w (HMP400W), ikebana-x (HMP350), ikebana-m (HMP300), ikebana-s (DiVA), Sakura (HMP200), Bonsai (HMP130, HMP100).

X-spinetix-hw: fukiran-w

X-spinetix-serial (request)

# property Player web server Player to server

Sent by the player on its own HTTP requests; identifies the device.

Details
X-spinetix-serial (request)

Added to GET, HEAD, PROPFIND, PUT and POST requests the player makes. Elementi sends "[not defined]".

X-spinetix-serial (response)

# property Player web server Remote to player

Response header with the player serial number.

Details
X-spinetix-serial (response)

HMP400 models send the short serial number.

X-spinetix-serial: X3L626S8

Device discovery 5

_http._tcp (Bonjour)

# message Device discovery Remote to player

Bonjour service on port 80 named "HMP - device name"; the standard web browser service.

Details
_http._tcp (Bonjour)

TXT record: path=/. Can be disabled in Control Center, Network.

_spx-hmp._tcp (Bonjour)

# message Device discovery Remote to player

SpinetiX player service on port 80 with TXT records for mode, serial, firmware and model.

Details
_spx-hmp._tcp (Bonjour)

TXT records: txtvers=1, cport=81 (content server port), mode (normal, safe or recovery), serial, firmware, model (for example HMP100, HMP130, HMP200).

dns-sd -B _spx-hmp._tcp

_spx-im._tcp (Bonjour)

# message Device discovery Remote to player

Advertises the Network API port (usually 1234); only when the Network API is enabled.

Details
_spx-im._tcp (Bonjour)

Related UPDATE

_webdav._tcp (Bonjour)

# message Device discovery Remote to player

Bonjour service on port 81 named "HMP - device name"; the standard WebDAV service.

Details
_webdav._tcp (Bonjour)

TXT record: path=/.

SSDP / UPnP

# message Device discovery Remote to player

Players advertise through SSDP on UDP port 1900; TCP ports are derived from the alive and response messages.

Details
SSDP / UPnP

Added in firmware 4.1.0 and Elementi 2018. Cross-subnet discovery needs multicast routing of SSDP (firmware 4.1.0 or later) or an mDNS reflector for Bonjour. Elementi 2025 Update 3 (4.9.3) dropped Bonjour and relies on UPnP only.

Since 4.1.0

Cloud APIs 1

API key

# config-key Cloud APIs Cloud

Credential for SpinetiX cloud API calls; generated in the ARYA account.

Details
apiKey={api-key}

Sent as the apiKey query parameter. Audit Trail API access is available to all ARYA Enterprise accounts. How to generate a key is described in the ARYA help centre.

Related GET /v1/group/user-actions, apiKey (query parameter)

Audit Trail API 13

Audit event (JSON)

in GET /v1/group/user-actions # property Audit Trail API Cloud

One user action: actionType, userId, rights, resources[], timestamp.

Details
Audit event (JSON)

Structure of attached information depends on the event type. Each resource has resourceId, resourceName and a requestBody.

{ "actionType": "CreateMedia", "userId": "be7ea3cd-e313-474e-9e58-8a59589944b0", "rights": "user_schedule,extended,enterprise", "resources": [ { "resourceId": "vNoReUCjxPehywGYUBON3KL8DdegXWxp3O70", "resourceName": "earth.jpg", "requestBody": { "name": "earth.jpg", "fileExtension": "jpg", "fileSize": 230895 } } ], "timestamp": "2022-10-10T18:18:20.099Z" }

CSV report columns

in GET /v1/group/user-actions # property Audit Trail API Cloud

One CSV row per logged action; 12 columns from Timestamp to Serial Number.

Details
CSV report columns

Columns: Timestamp, Action Type, User ID, Email, First Name, Last Name, Resource Id, Resource Name, Template Set ID, Template Set Name, Target, Serial Number. Email, First Name and Last Name are present only when includeUserDetails is set. Target is the scheduled target player on a tag. Serial Number is the service serial number (main MAC address) of the player. Request with format=csv.

GET /v1/group/user-actions

# endpoint Audit Trail API Cloud

Returns the audit trail of user actions in an ARYA account as JSON or CSV.

Details
GET /v1/group/user-actions?accountId={account-id}&apiKey={api-key}[&actionType=...][&format=csv][&includeUserDetails=...]

Authenticated HTTPS GET. Data is kept for three months; download it periodically for longer archives. In CSV only top-level fields are returned; array values go into one column as a comma-separated string. Without a filter the CSV can be very large. Available to ARYA Enterprise accounts.

ParameterTypeDefaultDescription
accountIdstringARYA account ID.
apiKeystringAPI key.
actionTypestringFilter by action name, for example CreateMedia.
formatstringcsv for a CSV table. Default is JSON.
includeUserDetailsbooleanAdds Email, First Name and Last Name of the acting user to the CSV.

Returns JSON array of events, or CSV; 204 No Content with an empty body if no event matches

GET /v1/group/user-actions?actionType=CreateMedia&accountId={account-id}&apiKey={api-key}

Related Audit event (JSON), CSV report columns

Guides

  • jSignage Core The core jSignage framework — object model, APIs and lifecycle for SpinetiX content.
  • jQuery & uDOM DOM manipulation patterns used inside SpinetiX Elementi templates.
  • Layers Layer composition, ordering and visibility control in jSignage.
  • Text Layers Typography, text effects and localization for signage text elements.
  • Media Layers Video, image, audio and media layer behavior in SpinetiX content.
  • Animations Keyframe animations, easing and motion in jSignage.
  • Transitions & Effects Playlist transitions, fade, wipe and custom visual effects.
  • Frame Decoration Borders, shadows, frames and decorative elements around content.
  • Shapes & Gradients SVG shapes, gradients and vector styling in jSignage.
  • Interactive Elements Touch, hover and event handling for kiosks and interactive screens.
  • Data Feeds RSS, JSON, CSV and API feeds as data sources for dynamic content.
  • Playlists & Slideshows Programmatic playlist control and slideshow behavior.
  • Player APIs Device-level APIs exposed by SpinetiX players for scripting.
  • Web Storage & Status Persistent storage, state and player status reporting.
  • Shared Variables Shared variables across content and between zones.
  • Plugins Custom plugins and extensions to the jSignage framework.
  • Utilities Helper functions, common patterns and reusable utility snippets.
This page is available in English only
هذه الصفحة متوفرة باللغة الإنجليزية فقط
NS
Media La Vista support
Typically replies natively
مرحباً بكم في دعم SpinetiX عبر واتساب

كيف يمكنني مساعدتكم في حلول اللوحات الرقمية، أو البنية التحتية AV/IT، أو منتجات SpinetiX؟
Hello and welcome to SpinetiX Support on WhatsApp.

How can I help you with digital signage solutions, AV/IT infrastructure, or SpinetiX products?