Evexi API

Introduction

The Evexi API provides content connectivity to either the underlying player hardware, software or evexi platform features. This can be used in either zip media, web media, background tasks or assigned applications.

It is important to note that it is the responsibility of the developer to manage any stored assets. The Evexi API has been tested to support Tizen firmware 2070 and later and we cannot guarantee the API to work reliably on previous firmware versions.

All filesystem methods returning a promise are wrapped in a timeout of 5 seconds. If no response is received within this time an error will be thrown within the catch statement.

Overview

• Install
• Build
• Packaging
• Developer Tools

API Features & Methods

• Lifecycle
• File System
• Touch To Engage
• Interactive
• Misc
• Kiosk
• Environment Variables
• Nexmosphere
• Helpers
• Square
• Stripe

Install

Install the Evexi package from NPM. This Github repo provides examples and documentation. The Evexi API is subject to change on a per version basis so ensure to check the app definitions match the player version.

yarn add evexi
npm i evexi

import {Evexi, EvexiMock} from 'evexi'

Note: If you plan to target SSSP2 or SSSP4 platform you should use the legacy script. Example Here

Build

All examples shown in /docs directory are built on Github CI and available to download from Github Actions. Alternatively clone this repo and build the examples locally. Once built you can upload to the Evexi platform and assign to a player.

yarn run build

Packaging

A Evexi .zip application must not contain hidden files and consist of a flat structure (no nested directories for SSSP2). The index.html should be in the root of the zip. A zip should contain at least an index.html file in the root level.

If you run zipinfo against the .zip file you should see an output like so.

Archive:  fs-240.zip
Zip file size: 73108 bytes, number of entries: 2
-rw-r--r--  3.0 unx      346 tx defN 21-Sep-21 09:35 index.html
-rw-r--r--  3.0 unx   317567 tx defN 21-Sep-21 09:35 src.77de5100.js
2 files, 317913 bytes uncompressed, 72780 bytes compressed:  77.1%

You can zip your application using standard zip CLI.

cd app # go into directory
zip app.zip . -x '.*' -x '__MACOSX' -x '*.DS_Store' # zip all files at current level

Further examples can be found here.