Skip to content

Latest commit

 

History

History
99 lines (83 loc) · 3.75 KB

README.md

File metadata and controls

99 lines (83 loc) · 3.75 KB
Raw

SMIL player

SMIL mandatory structure

<smil>
    <head>
        <layout>
            <root-layout width="1080" height="1920" backgroundColor="#FFFFFF" />
            <region regionName="video" left="0" top="0" width="1080" height="1920" z-index="1" backgroundColor="#FFFFFF" mediaAlign="center" />
        </layout>
    </head>
    <body>
        <par> 
            Whole playlist goes here
        </par> 
    </body>
</smil>

Supported SMIL playlist tags

Necessary attributes in SMIL file

  • region name has to be specified in one of these two ways
<region regionName="widget12"..../>
<region xml:id="widget12" .... />
  • accepts only url to SMIL file ( form input at main page )
  • url to SMIL file can be also passed as smilUrl variable via SoS timings
  • all files ( audio, video.. ) must be stored on remote server
  • it is possible to specify path to files in two ways, if file url is specified by relative path, absolute path is build by combining smil url and relative path
absolute
    <video src="https://static.signageos.io/assets/video-test-1_e07fc21a7a72e3d33478243bd75d7743.mp4" />
relative
    <video src="assets/landscape1.mp4" />
    
    if smil path is https://static.signageos.io/testing.smil then absolute path for video will be https://static.signageos.io/assets/landscape1.mp4

Supported features

  • sequential and parallel play of audio, video, image and widget
  • priority playlist
  • supports simple layering ( z-index ) with videos always played on background ( lowest level )
  • pairs all media with proper regions from layout part of SMIL, if no region specified, uses values from root-layout tag
  • plays media in endless loops if necessary ( one element as well as multiple )
  • supports prefetch event ( plays intro while downloading rest of the files )
  • downloads all necessary files from remote server, stores files in local storage
  • downloads and extracts of widgets into local storage
  • checks for changes in provided SMIL file as well as checks for all files linked in SMIL
  • ability to restart on SMIL file change
  • supports media scheduling using wallclock definition
  • supports playing media loops using repeatCount attribute, possible to combine with wallclock
  • supports sensors-based triggers
  • supports keyboard-based triggers
  • supports conditional expressions
  • supports keyboard-based triggers

Used technology

  • webpack, typescript, mocha, xml2js, json-easy-filter

Code documentation

  • See documentation here

SMIL documentation

Development

For development internally in signageOS team, there are a few specifics. We are using internal private NPM registry, so please copy the template .npmrc.template to .npmrc and adjust your local PC ~/.bashrc file as below (for unix systems, for Win add environment variables in windows This PC options).

echo 'export NPM_REGISTRY_URL="https://npm.signageos.io"' >> ~/.bashrc
echo 'export NPM_REGISTRY_HOST="npm.signageos.io"' >> ~/.bashrc
echo 'export NPM_AUTH_TOKEN="__PASTE_YOUR_SECRET_TOKEN__"' >> ~/.bashrc
cp .npmrc.template .npmrc

Quick deployment

npm install
npm run build --production

// delete "sos" item in package.json

// login to signageOS
sos login
// upload the SMIL Player applet to signageOS
sos applet upload

// once the SMIL Player is uploaded, deploy to any supported device