@signageos/front-applet 6.4.0 → 6.4.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/content/js-video-stream.md +34 -12
- 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
|
+
## [6.4.1] - 2024-01-24
|
|
8
|
+
### Fixed
|
|
9
|
+
- Stream public documentation formatting
|
|
10
|
+
|
|
7
11
|
## [6.4.0] - 2024-01-24
|
|
8
12
|
### Added
|
|
9
13
|
- New method `sos.stream.pause()` to pause running stream
|
|
@@ -22,8 +22,8 @@ Methods to play or stop video streams.
|
|
|
22
22
|
| `prepare()` | Prepare video stream in the background | 4.7.0 |
|
|
23
23
|
| `play()` | Start playing video stream | 1.0.18 |
|
|
24
24
|
| `stop()` | Stop video stream | 1.0.18 |
|
|
25
|
-
| `pause()` | Pause video stream | 6.
|
|
26
|
-
| `resume()` | Resume video stream | 6.
|
|
25
|
+
| `pause()` | Pause video stream | 6.4.0 |
|
|
26
|
+
| `resume()` | Resume video stream | 6.4.0 |
|
|
27
27
|
| `getTracks()` | Get all tracks of the stream | 6.1.0 |
|
|
28
28
|
| `selectTrack()` | Select track of the stream | 6.1.0 |
|
|
29
29
|
| `resetTrack()` | Reset track of the stream | 6.1.0 |
|
|
@@ -35,18 +35,30 @@ Methods to play or stop video streams.
|
|
|
35
35
|
| `onPrepare()` | Calls a listener callback when stream prepares | 5.12.0 |
|
|
36
36
|
| `onTracksChanged()` | Calls a listener callback when stream tracks change | 6.1.0 |
|
|
37
37
|
|
|
38
|
-
:::warning
|
|
39
|
-
[Read more about limitation and Tizen-specific details](https://docs.signageos.io/hc/en-us/articles/4405387373458). :::
|
|
38
|
+
:::warning
|
|
40
39
|
|
|
41
|
-
|
|
42
|
-
|
|
40
|
+
Are you using **Samsung Tizen** to play streams?
|
|
41
|
+
[Read more about limitation and Tizen-specific details](https://docs.signageos.io/hc/en-us/articles/4405387373458).
|
|
42
|
+
|
|
43
|
+
:::
|
|
44
|
+
|
|
45
|
+
:::danger
|
|
46
|
+
|
|
47
|
+
Be aware version of JS API (v6.0.0+) changed how stream functions `play()` and `prepare()` work. For using an options object you need to our
|
|
48
|
+
latest core app versions. If you are using older core app versions, you need to use deprecated format.
|
|
49
|
+
|
|
50
|
+
:::
|
|
43
51
|
|
|
44
52
|
## prepare()
|
|
45
53
|
|
|
46
54
|
Calls the internal player and prepares a video stream in memory, so it can later start playing instantaneously.
|
|
47
55
|
|
|
48
|
-
:::info
|
|
49
|
-
|
|
56
|
+
:::info
|
|
57
|
+
|
|
58
|
+
If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height =
|
|
59
|
+
document.documentElement.clientHeight as setup parameters.
|
|
60
|
+
|
|
61
|
+
:::
|
|
50
62
|
|
|
51
63
|
### Parameters
|
|
52
64
|
|
|
@@ -104,14 +116,21 @@ await sos.stream.prepare(uri, x, y, width, height, 'HTTP');
|
|
|
104
116
|
```
|
|
105
117
|
|
|
106
118
|
:::note[GitHub Example]
|
|
107
|
-
|
|
119
|
+
|
|
120
|
+
[Stream video Applet example](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/stream)
|
|
121
|
+
|
|
122
|
+
:::
|
|
108
123
|
|
|
109
124
|
## play()
|
|
110
125
|
|
|
111
126
|
Calls the internal player and starts a video stream in correct position.
|
|
112
127
|
|
|
113
|
-
:::info
|
|
114
|
-
|
|
128
|
+
:::info
|
|
129
|
+
|
|
130
|
+
If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height =
|
|
131
|
+
document.documentElement.clientHeight as setup parameters.
|
|
132
|
+
|
|
133
|
+
:::
|
|
115
134
|
|
|
116
135
|
### Parameters
|
|
117
136
|
|
|
@@ -155,7 +174,10 @@ await sos.stream.play(uri, x, y, width, height, 'HTTP');
|
|
|
155
174
|
```
|
|
156
175
|
|
|
157
176
|
:::note[GitHub Example]
|
|
158
|
-
|
|
177
|
+
|
|
178
|
+
[Stream video Applet example](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/stream)
|
|
179
|
+
|
|
180
|
+
:::
|
|
159
181
|
|
|
160
182
|
## stop()
|
|
161
183
|
|