@signageos/front-applet 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/docs/js-api/js-api-introduction.md +22 -11
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
|
|
|
4
4
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
5
5
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## [5.0.1] - 2022-01-25
|
|
8
|
+
### Fixed
|
|
9
|
+
- adjusted documentation to better reflect naming of JS SDK
|
|
10
|
+
|
|
7
11
|
## [5.0.0] - 2022-01-13
|
|
8
12
|
### Changed
|
|
9
13
|
- onceEnded promise on video will be rejected when video is stopped before it's end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: JS SDK Home
|
|
3
3
|
author: Josef Kral
|
|
4
4
|
date: 4.2.2018
|
|
5
5
|
type: rest-api
|
|
@@ -9,20 +9,19 @@ tags:
|
|
|
9
9
|
- api
|
|
10
10
|
description: "[Content JS API] General introduction to signageOS JS API"
|
|
11
11
|
---
|
|
12
|
-
# Applet
|
|
12
|
+
# Javascript SDK for Applet development
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
You can use the same functions across all devices with the same result. Applet JS API is available automatically within your Applet out-of-the-box.
|
|
16
|
-
|
|
17
|
-
Applet JS API supports content-playback features and device management features.
|
|
14
|
+
Javascript SDK gives you access to device's native features and functionalities. You can use the same functions across all devices with the same result.
|
|
18
15
|
|
|
19
16
|
::: alert alert--tip
|
|
20
|
-
All APIs are standardized and available across all [supported devices](/
|
|
17
|
+
All APIs are standardized and available across all [supported devices](https://signageos.zendesk.com/hc/en-us/sections/4405700629266-Supported-Devices).
|
|
21
18
|
:::
|
|
22
19
|
|
|
23
|
-
## Content-
|
|
20
|
+
## Content-related JS APIs
|
|
21
|
+
|
|
22
|
+
Content-related APIs help you with content part of your application /Applet/.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
Universal APIs for File system, access to accelerated video playback, sensor management and more provide you with robust tool set for creating extensive experiences.
|
|
26
25
|
|
|
27
26
|
::: table-responsive
|
|
28
27
|
| Domain | Description |
|
|
@@ -45,9 +44,9 @@ Content-playback API is an API for managing content on screen.
|
|
|
45
44
|
| [Video Streams](/api/js/content/js-video-stream) | Playing video streams (RTSP, HLS, UDP) via native video player |
|
|
46
45
|
:::
|
|
47
46
|
|
|
48
|
-
## Device
|
|
47
|
+
## Device control JS APIs
|
|
49
48
|
|
|
50
|
-
Device
|
|
49
|
+
Device control features exposed via Javascript APIs.
|
|
51
50
|
|
|
52
51
|
::: alert alert--tip
|
|
53
52
|
For **Device Management** we strongly recommend using REST APIs. [See the REST API documentation here](https://api.docs.signageos.io).
|
|
@@ -70,3 +69,15 @@ For **Device Management** we strongly recommend using REST APIs. [See the REST A
|
|
|
70
69
|
| [Security](/api/js/management/12-js-management-security) | Control system security (PIN code) |
|
|
71
70
|
| [Wi-Fi](/api/js/management/13-js-management-wifi) | Manage Wi-Fi |
|
|
72
71
|
:::
|
|
72
|
+
|
|
73
|
+
# Node.JS SDK
|
|
74
|
+
|
|
75
|
+
Library which allows you to fully manage signageOS applets, devices, management & monitoring using Node.JS and REST API.
|
|
76
|
+
|
|
77
|
+
See full [documentation on GitHub](https://github.com/signageos/sdk)
|
|
78
|
+
|
|
79
|
+
# REST API
|
|
80
|
+
|
|
81
|
+
Large collection of REST API endpoints for device management and monitoring.
|
|
82
|
+
|
|
83
|
+
See full [documentation on Postman](https://api.docs.signageos.io)
|