@arcware-cloud/pixelstreaming-websdk 1.3.32 → 1.3.33
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/README.md +4 -289
- package/index.cjs +2 -1
- package/index.mjs +19 -17
- package/index.umd.cjs +2 -1
- package/package.json +1 -1
- package/types/lib/ArcwareConfig.d.ts +1 -1
package/README.md
CHANGED
|
@@ -8,8 +8,6 @@ If you are not familiar with Arcware Cloud yet, check it out on [www.arcware.com
|
|
|
8
8
|
|
|
9
9
|
The WebSDK is designed to bring immersive experiences, similar to those found in native applications, to the web. It's enabled for a range of applications, from gaming and architectural visualization to interactive training. Bringing high quality real-time and ensures a seamless user experience.
|
|
10
10
|
|
|
11
|
-
This README offers an initial guide to integrating the WebSDK into your application. For comprehensive instructions, including setup, configuration, advanced features, and best practices, please refer to our detailed documentation: [Arcware Pixel Streaming WebSDK Documentation](https://docs.arcware.cloud/web-integration/new-websdk).
|
|
12
|
-
|
|
13
11
|
For an in-depth understanding of the underlying technology and infrastructure, you can explore the original "PixelStreamingInfrastructure" repository by Epic Games on GitHub: [EpicGames/PixelStreamingInfrastructure](https://github.com/EpicGames/PixelStreamingInfrastructure).
|
|
14
12
|
|
|
15
13
|
## Getting Started
|
|
@@ -20,252 +18,17 @@ Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project,
|
|
|
20
18
|
|
|
21
19
|
1. **Share ID**: You must have a valid Share ID set up for your project. This ID is crucial for establishing the connection between your application and the Arcware Cloud pixel streaming service. If you need assistance in setting up your Share ID, please refer to our detailed guide: [Setting up Share ID](https://docs.arcware.cloud/arcware-cloud-platform/getting-started/07.-preview-and-share-the-stream).
|
|
22
20
|
|
|
23
|
-
2. **Web Application Development Environment**:
|
|
24
|
-
|
|
25
|
-
3. **TypeScript Recommendation**: While the SDK can be used with JavaScript, we strongly recommend using TypeScript in your development process. TypeScript offers enhanced code quality, readability, and will provide you with more intrinsic information during development, often surpassing what traditional documentation can offer.
|
|
26
|
-
|
|
27
|
-
### Installation
|
|
28
|
-
|
|
29
|
-
To integrate the Arcware Cloud Pixel Streaming WebSDK into your project, you can use either npm or yarn. Run one of the following commands in your project directory:
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
npm install @arcware-cloud/pixelstreaming-websdk --save
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
yarn add @arcware-cloud/pixelstreaming-websdk
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
We recommend keeping the WebSDK up to date to ensure you have the latest features and bug fixes. Regularly check for and install updates.
|
|
40
|
-
|
|
41
|
-
### Basic Usage
|
|
42
|
-
|
|
43
|
-
Below is a simple example demonstrating how to use the WebSDK in an HTML file to set up pixel streaming. This example imports the SDK and initializes it with a share ID and initial settings. It then attaches the streaming application to a div element in your HTML.
|
|
44
|
-
|
|
45
|
-
```html
|
|
46
|
-
<html>
|
|
47
|
-
<head>
|
|
48
|
-
<title>Arcware Cloud - Pixel Streaming</title>
|
|
49
|
-
<script type="module">
|
|
50
|
-
import * as PixelStreamingWebSdkCore from "https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@latest/index.esm.js";
|
|
51
|
-
|
|
52
|
-
const { ArcwareInit } = PixelStreamingWebSdkCore;
|
|
53
|
-
|
|
54
|
-
const { Config, PixelStreaming, Application } = ArcwareInit(
|
|
55
|
-
{
|
|
56
|
-
// Replace with your actual share ID
|
|
57
|
-
shareId: "share-0be4620b-77aa-42b1-98cb-f7ee61be443?"
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
initialSettings: {
|
|
61
|
-
AutoConnect: false
|
|
62
|
-
// additional initial settings
|
|
63
|
-
},
|
|
64
|
-
settings: {
|
|
65
|
-
// additional settings
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
);
|
|
69
|
-
|
|
70
|
-
document.getElementById("videoContainer").appendChild(Application.rootElement);
|
|
71
|
-
</script>
|
|
72
|
-
</head>
|
|
73
|
-
<body>
|
|
74
|
-
<div id="videoContainer" style="height: 1000px; width: 1000px;"></div>
|
|
75
|
-
</body>
|
|
76
|
-
</html>
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
For more detailed examples and advanced usage, please refer to our documentation: [Arcware Cloud Pixelstreaming WebSDK Documentation](https://docs.arcware.cloud/web-integration/new-websdk).
|
|
80
|
-
|
|
81
|
-
# Changelog
|
|
82
|
-
|
|
83
|
-
### 1.3.25
|
|
84
|
-
|
|
85
|
-
- fixed types being emitted again after bundler change
|
|
86
|
-
|
|
87
|
-
### 1.3.24
|
|
88
|
-
|
|
89
|
-
- allowing json type payload for upcoming events feature
|
|
90
|
-
|
|
91
|
-
### 1.3.20
|
|
92
|
-
|
|
93
|
-
- polished types a bit and aligned with documentation
|
|
94
|
-
|
|
95
|
-
### 1.3.19
|
|
96
|
-
|
|
97
|
-
- added new configuration parameters to optionally hide AfkOverlay and to hide love letters box
|
|
98
|
-
- exposing a function to clear session ID which can be called before connecting to stream to force a fresh instance
|
|
99
|
-
- fixed a bug that was causing onWebsocketClosedEventHandler to fire three times. Also it now returns proper CloseEvent
|
|
100
|
-
|
|
101
|
-
### 1.3.17
|
|
102
|
-
|
|
103
|
-
- added support for videos in white labelling
|
|
104
|
-
|
|
105
|
-
### 1.3.16
|
|
106
|
-
|
|
107
|
-
- added white labeling options for loader icon and screen
|
|
108
|
-
- options can be loaded via base64 encoded string in URL, fetched via API (configured on platform) or set as properties on the SDK
|
|
109
|
-
|
|
110
|
-
### 1.3.12
|
|
111
|
-
|
|
112
|
-
- added orientationZoom field for managing zoom
|
|
113
|
-
- fixed stream-ui issue (occurred on React.js)
|
|
114
|
-
|
|
115
|
-
### 1.3.9
|
|
116
|
-
|
|
117
|
-
- added an event handler to check if video is streaming if cloud requests evidence
|
|
118
|
-
|
|
119
|
-
### 1.3.8
|
|
120
|
-
|
|
121
|
-
- fixed error handling in SDK to back of reconnects if connection was intentionally terminated by cloud
|
|
122
|
-
|
|
123
|
-
### 1.3.3
|
|
124
|
-
|
|
125
|
-
- adding built in functionality for filetransfer (docs will follow soon)
|
|
126
|
-
- added function to send events to Arcware Platform for custom analytics (this feature is alpha on backend, contact account manager if you are interested)
|
|
127
|
-
- some fixes to
|
|
128
|
-
|
|
129
|
-
### 1.2.18
|
|
130
|
-
|
|
131
|
-
- fixed webpack to emit types
|
|
132
|
-
|
|
133
|
-
### 1.2.17 (broken)
|
|
134
|
-
|
|
135
|
-
- fixed diagnostics to interpred user agent and user agent data more accurately
|
|
136
|
-
- webpack did not emit types.d.ts do not use this version!
|
|
137
|
-
|
|
138
|
-
### 1.2.16
|
|
139
|
-
|
|
140
|
-
- Added "diagnostics collector" module
|
|
141
|
-
|
|
142
|
-
### 1.2.13
|
|
143
|
-
|
|
144
|
-
- Replaced "moment" by "date-fns"
|
|
145
|
-
|
|
146
|
-
### 1.2.7
|
|
147
|
-
|
|
148
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.3.1",
|
|
149
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "1.2.1",
|
|
150
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "1.3.1",
|
|
151
|
-
|
|
152
|
-
### 1.2.6
|
|
153
|
-
|
|
154
|
-
- Added the "TextboxEntry" handler
|
|
155
|
-
- global CSS rule encapsulation
|
|
156
|
-
|
|
157
|
-
### 1.2.5
|
|
158
|
-
|
|
159
|
-
- Initial resolution can now be set as configuration parameter. Platform will start the instance with this resolution as startup argument for Unreal, such that Unreal will start with the web container size's resolution for fastest loading experience and screen adaptation
|
|
160
|
-
|
|
161
|
-
### 1.1.22
|
|
162
|
-
|
|
163
|
-
- Added flag to force refresh the components on ArcwareInit
|
|
164
|
-
- removed lodash and lottie dependencies to reduce package size significantly
|
|
165
|
-
|
|
166
|
-
### 1.1.20
|
|
21
|
+
2. **Web Application Development Environment**: Please check out our documentation [Arcware Pixel Streaming WebSDK Getting started](https://docs.arcware.cloud/web-integration/new-websdk/implementing-the-stream-on-your-app/getting-started)
|
|
167
22
|
|
|
168
|
-
|
|
23
|
+
# CHANGELOG
|
|
169
24
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.2.9"
|
|
173
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "1.1.0"
|
|
174
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "1.2.0"
|
|
175
|
-
|
|
176
|
-
### 1.1.18
|
|
177
|
-
|
|
178
|
-
- hotfix: PixelStreaming.websocketState now returning correct state
|
|
179
|
-
|
|
180
|
-
### 1.1.17
|
|
181
|
-
|
|
182
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.2.9"
|
|
183
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "1.0.3"
|
|
184
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "1.0.2"
|
|
185
|
-
|
|
186
|
-
### 1.1.12
|
|
187
|
-
|
|
188
|
-
- pushing to newer versions of pixelstreaming infrastructure
|
|
189
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.2.8"
|
|
190
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "1.0.1"
|
|
191
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "1.0.0"
|
|
192
|
-
|
|
193
|
-
### 1.1.5
|
|
194
|
-
|
|
195
|
-
- removing the reconnect on successive calls to ArcwareInit if websocket was stale. If this behaviour is needed, it should be implemented outside the SDK
|
|
196
|
-
|
|
197
|
-
### 1.1.3
|
|
198
|
-
|
|
199
|
-
- reverting as the new versions of pixelstreaming infrastructure break things at least on Arcware side
|
|
200
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.1.7"
|
|
201
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "0.4.8"
|
|
202
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "0.4.8"
|
|
203
|
-
|
|
204
|
-
### 1.0.11
|
|
205
|
-
|
|
206
|
-
- reduced logging verbosity of pixel streaming infrastructure to not spam console
|
|
207
|
-
|
|
208
|
-
### 1.0.10
|
|
209
|
-
|
|
210
|
-
- Storing initialized WebSDK in global variable after calling ArcwareInit to return existing object on consecutive calls.
|
|
211
|
-
This prevents double websocket connections and potential failures to connect to stream
|
|
212
|
-
|
|
213
|
-
### 1.0.9
|
|
214
|
-
|
|
215
|
-
- Fixed peerDependencies in package.json
|
|
216
|
-
|
|
217
|
-
### 1.0.0
|
|
218
|
-
|
|
219
|
-
This version was created with the support of Tensorworks and is now sourcing from upstream packages
|
|
220
|
-
|
|
221
|
-
- "@epicgames-ps/lib-pixelstreamingcommon-ue5.5": "0.1.7"
|
|
222
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "^0.4.8"
|
|
223
|
-
- "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "^0.4.8"
|
|
224
|
-
|
|
225
|
-
#### Added
|
|
226
|
-
|
|
227
|
-
- Support for Versions 5.1 and higher
|
|
228
|
-
- Support for controllers
|
|
229
|
-
- Experimental support for VR streaming
|
|
230
|
-
|
|
231
|
-
#### Fixed
|
|
232
|
-
|
|
233
|
-
- Random freezes on streams
|
|
234
|
-
|
|
235
|
-
#### Deprecated
|
|
236
|
-
|
|
237
|
-
- Support for Unreal 4.27 (fall back to WebRTC Plugin)
|
|
238
|
-
- Support for Unreal 5.0.3.0 (fall back to WebRTC Plugin)
|
|
239
|
-
|
|
240
|
-
### 0.1.\* (Initial Release)
|
|
241
|
-
|
|
242
|
-
<!-- - Upcoming changes or improvements that are currently in development can be listed here.
|
|
243
|
-
|
|
244
|
-
### [Version Number] - Release Date
|
|
245
|
-
|
|
246
|
-
#### Added
|
|
247
|
-
- List of new features or additions to the WebSDK in this release.
|
|
248
|
-
|
|
249
|
-
#### Changed
|
|
250
|
-
- Updates to existing features or overall improvements to the WebSDK.
|
|
251
|
-
|
|
252
|
-
#### Deprecated
|
|
253
|
-
- Features that are planned to be removed in future releases.
|
|
254
|
-
|
|
255
|
-
#### Removed
|
|
256
|
-
- Features or functionalities that have been removed from the WebSDK.
|
|
257
|
-
|
|
258
|
-
#### Fixed
|
|
259
|
-
- Bug fixes and corrections made in this release.
|
|
260
|
-
|
|
261
|
-
### [Previous Version Number] - Previous Release Date
|
|
262
|
-
- Changes for previous versions follow the same format. -->
|
|
25
|
+
Our changelog moved to the documentation: [CHANGELOG](https://docs.arcware.cloud/web-integration/new-websdk/changelog)
|
|
263
26
|
|
|
264
27
|
# LICENSE
|
|
265
28
|
|
|
266
29
|
MIT License
|
|
267
30
|
|
|
268
|
-
Copyright
|
|
31
|
+
Copyright 2026 Arcware GmbH
|
|
269
32
|
|
|
270
33
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
271
34
|
|
|
@@ -286,51 +49,3 @@ This software inherits code from several other libraries, namely:
|
|
|
286
49
|
Here's a summary of these [Dependency Licenses](https://www.npmjs.com/package/@arcware-cloud/pixelstreaming-websdk?activeTab=code)/DEPENDENCY_LICENSE.md.
|
|
287
50
|
|
|
288
51
|
We appreciate the contributions of these libraries, as they are essential in supporting our development efforts.
|
|
289
|
-
|
|
290
|
-
<!-- # Configuration Options
|
|
291
|
-
|
|
292
|
-
When creating a new instance of `ArcwareConfig`, you provide an object with two main properties: `initialSettings` and `settings`.
|
|
293
|
-
|
|
294
|
-
####
|
|
295
|
-
|
|
296
|
-
`initialSettings`
|
|
297
|
-
|
|
298
|
-
This property is an object that defines the initial environment and behavior of the Pixel Streaming session. Here's a breakdown of the options used in the example:
|
|
299
|
-
|
|
300
|
-
- `ss`: This is the URL to the signalling server, which is essential for establishing the WebRTC connection. It is typically provided by your environment configuration.
|
|
301
|
-
- `StartVideoMuted`: A boolean that, when set to `true`, starts the video in a muted state.
|
|
302
|
-
- `AutoConnect`: If `true`, the client will automatically attempt to connect to the Pixel Streaming session as soon as possible.
|
|
303
|
-
- `AutoPlayVideo`: When set to `true`, the video will automatically play as soon as it's ready.
|
|
304
|
-
|
|
305
|
-
####
|
|
306
|
-
|
|
307
|
-
`settings`
|
|
308
|
-
|
|
309
|
-
The `settings` property is an object containing various configuration options that tailor the user interface and interaction capabilities of the streaming session:
|
|
310
|
-
|
|
311
|
-
- `shareId`: An identifier used for sharing sessions. \*Required
|
|
312
|
-
- `session`: The session ID, which can be used for session management and reconnection.
|
|
313
|
-
- `token`: An authentication token, if required by your backend.
|
|
314
|
-
- `infoButton`: A boolean to toggle the visibility of an information button in the UI.
|
|
315
|
-
- `micButton`: A boolean to control the display of a microphone toggle button.
|
|
316
|
-
- `audioButton`: A boolean to show or hide the audio control button.
|
|
317
|
-
- `fullscreenButton`: A boolean to enable a fullscreen toggle button.
|
|
318
|
-
- `settingsButton`: A boolean to add a settings button to the UI.
|
|
319
|
-
- `connectionStrengthIcon`: A boolean to display an icon indicating the connection strength.
|
|
320
|
-
|
|
321
|
-
###
|
|
322
|
-
|
|
323
|
-
Initialization Process
|
|
324
|
-
|
|
325
|
-
After configuring `ArcwareConfig`, you create an instance of `ArcwarePixelStreaming` by passing the configuration object. This instance is responsible for managing the streaming session and handling user interactions.
|
|
326
|
-
|
|
327
|
-
const pixelStreamingInstance = new ArcwarePixelStreaming(config);
|
|
328
|
-
|
|
329
|
-
Once initialized, `pixelStreamingInstance` can be used to interact with the streaming session. For example, you can retrieve the application's response or emit UI interactions:
|
|
330
|
-
|
|
331
|
-
const application = new ArcwareApplication({
|
|
332
|
-
stream: pixelStreamingInstance,
|
|
333
|
-
});
|
|
334
|
-
|
|
335
|
-
- ` application.getApplicationResponse(``string``) `: This method can be called to get a response from the application, which might include status updates or other messages.
|
|
336
|
-
- `application.emitUIInteraction(descriptor:` ` object | string``) `: This method allows you to send UI interaction events to the streaming application, such as button presses or command inputs. -->
|
package/index.cjs
CHANGED
|
@@ -23391,6 +23391,7 @@ const ArcwareSettingsSchema_1 = __webpack_require__(9913);
|
|
|
23391
23391
|
const whiteLabelling_1 = __webpack_require__(5292);
|
|
23392
23392
|
const ZWhiteLabel_1 = __webpack_require__(1938);
|
|
23393
23393
|
const EventHandler_1 = __webpack_require__(3916);
|
|
23394
|
+
lib_pixelstreamingfrontend_ue5_5_1.Logger.InitLogging(2, false);
|
|
23394
23395
|
/** Default arcware signalling endpoint. */
|
|
23395
23396
|
exports.DefaultUrl = `wss://signalling-client.ragnarok.arcware.cloud`;
|
|
23396
23397
|
function deepEqual(a, b) {
|
|
@@ -23449,7 +23450,7 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
|
|
|
23449
23450
|
if (!config.initialSettings.ss)
|
|
23450
23451
|
config.initialSettings.ss = exports.DefaultUrl;
|
|
23451
23452
|
super(config);
|
|
23452
|
-
this.VERSION = "1.3.
|
|
23453
|
+
this.VERSION = "1.3.33";
|
|
23453
23454
|
this.whiteLabellingChanged = new EventHandler_1.EventHandler();
|
|
23454
23455
|
this.signallingWlURL = "https://signalling-client.arcware.cloud/whiteLabel/";
|
|
23455
23456
|
if (config.envName) {
|
package/index.mjs
CHANGED
|
@@ -23388,12 +23388,13 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
23388
23388
|
/* harmony export */ });
|
|
23389
23389
|
/* harmony import */ var tslib__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(1635);
|
|
23390
23390
|
/* harmony import */ var zod__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2080);
|
|
23391
|
-
/* harmony import */ var _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(
|
|
23392
|
-
/* harmony import */ var
|
|
23393
|
-
/* harmony import */ var
|
|
23394
|
-
/* harmony import */ var
|
|
23395
|
-
/* harmony import */ var
|
|
23396
|
-
/* harmony import */ var
|
|
23391
|
+
/* harmony import */ var _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(948);
|
|
23392
|
+
/* harmony import */ var _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(223);
|
|
23393
|
+
/* harmony import */ var _domain_Session__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(3266);
|
|
23394
|
+
/* harmony import */ var _domain_ArcwareSettingsSchema__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(9913);
|
|
23395
|
+
/* harmony import */ var _features_whiteLabelling__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(5292);
|
|
23396
|
+
/* harmony import */ var _features_ZWhiteLabel__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(1938);
|
|
23397
|
+
/* harmony import */ var _domain_EventHandler__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(3916);
|
|
23397
23398
|
|
|
23398
23399
|
|
|
23399
23400
|
|
|
@@ -23402,6 +23403,7 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
23402
23403
|
|
|
23403
23404
|
|
|
23404
23405
|
|
|
23406
|
+
_epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_2__.Logger.InitLogging(2, false);
|
|
23405
23407
|
/** Default arcware signalling endpoint. */
|
|
23406
23408
|
const DefaultUrl = `wss://signalling-client.ragnarok.arcware.cloud`;
|
|
23407
23409
|
function deepEqual(a, b) {
|
|
@@ -23412,7 +23414,7 @@ function deepEqual(a, b) {
|
|
|
23412
23414
|
return false;
|
|
23413
23415
|
}
|
|
23414
23416
|
}
|
|
23415
|
-
class ArcwareConfig extends
|
|
23417
|
+
class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_3__.Config {
|
|
23416
23418
|
/**
|
|
23417
23419
|
* Can be used to fetch projectId and shareId from the current url.
|
|
23418
23420
|
* Example:
|
|
@@ -23448,7 +23450,7 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23448
23450
|
throw new Error(`ShareId or ProjectId must be specified.`);
|
|
23449
23451
|
}
|
|
23450
23452
|
// Validate settings input.
|
|
23451
|
-
const settings =
|
|
23453
|
+
const settings = _domain_ArcwareSettingsSchema__WEBPACK_IMPORTED_MODULE_5__.ArcwareSettingsSchema.parse(config.settings);
|
|
23452
23454
|
// Setup arcware default settings.
|
|
23453
23455
|
if (!config.initialSettings)
|
|
23454
23456
|
config.initialSettings = {};
|
|
@@ -23460,17 +23462,17 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23460
23462
|
if (!config.initialSettings.ss)
|
|
23461
23463
|
config.initialSettings.ss = DefaultUrl;
|
|
23462
23464
|
super(config);
|
|
23463
|
-
this.VERSION = "1.3.
|
|
23464
|
-
this.whiteLabellingChanged = new
|
|
23465
|
+
this.VERSION = "1.3.33";
|
|
23466
|
+
this.whiteLabellingChanged = new _domain_EventHandler__WEBPACK_IMPORTED_MODULE_8__.EventHandler();
|
|
23465
23467
|
this.signallingWlURL = "https://signalling-client.arcware.cloud/whiteLabel/";
|
|
23466
23468
|
if (config.envName) {
|
|
23467
23469
|
this.signallingWlURL = `https://signalling-client.${config.envName}.arcware.cloud/whiteLabel/`;
|
|
23468
23470
|
}
|
|
23469
23471
|
this.settings = settings;
|
|
23470
|
-
this.session = new
|
|
23472
|
+
this.session = new _domain_Session__WEBPACK_IMPORTED_MODULE_4__.Session();
|
|
23471
23473
|
this._initialSettings = config.initialSettings;
|
|
23472
23474
|
// Setup arcware default settings.
|
|
23473
|
-
this.setFlagEnabled(
|
|
23475
|
+
this.setFlagEnabled(_epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_3__.Flags.AFKDetection, true);
|
|
23474
23476
|
// IMPORTANT NOTE: The feature BrowserSendOffer is no longer supported in PSInfra 5.5.
|
|
23475
23477
|
// The offer is now expected to come from UE. Ensure that your signalling server supports this behaviour.
|
|
23476
23478
|
//this.setFlagEnabled(Flags.BrowserSendOffer, true);
|
|
@@ -23480,7 +23482,7 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23480
23482
|
if (qs.has("wl")) {
|
|
23481
23483
|
if (qs.get("wl") !== "") {
|
|
23482
23484
|
// Retrieve image loading from there
|
|
23483
|
-
const wlParsed = this.useUrlParams ? (0,
|
|
23485
|
+
const wlParsed = this.useUrlParams ? (0,_features_whiteLabelling__WEBPACK_IMPORTED_MODULE_6__.readWhiteLabelFromQuery)(qs) : undefined; // respect useUrlParams
|
|
23484
23486
|
if (wlParsed) {
|
|
23485
23487
|
this.settings.whiteLabelling = Object.assign(Object.assign({}, ((_c = this.settings.whiteLabelling) !== null && _c !== void 0 ? _c : {})), wlParsed);
|
|
23486
23488
|
}
|
|
@@ -23496,7 +23498,7 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23496
23498
|
return (0,tslib__WEBPACK_IMPORTED_MODULE_0__.__awaiter)(this, void 0, void 0, function* () {
|
|
23497
23499
|
const qs = new URLSearchParams(window.location.search);
|
|
23498
23500
|
if (qs.get("wl") !== "") {
|
|
23499
|
-
|
|
23501
|
+
_domain_EventHandler__WEBPACK_IMPORTED_MODULE_8__.EventHandler.Emit(this.whiteLabellingChanged, {
|
|
23500
23502
|
next: this.settings.whiteLabelling,
|
|
23501
23503
|
changed: false
|
|
23502
23504
|
});
|
|
@@ -23526,14 +23528,14 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23526
23528
|
catch (_a) {
|
|
23527
23529
|
return undefined;
|
|
23528
23530
|
}
|
|
23529
|
-
const parsed =
|
|
23531
|
+
const parsed = _features_ZWhiteLabel__WEBPACK_IMPORTED_MODULE_7__.ZWhiteLabel.safeParse(json);
|
|
23530
23532
|
if (!parsed.success)
|
|
23531
23533
|
return undefined;
|
|
23532
23534
|
// Only apply & emit if it actually changed
|
|
23533
23535
|
const prev = this.settings.whiteLabelling;
|
|
23534
23536
|
const next = parsed.data;
|
|
23535
23537
|
this.settings.whiteLabelling = next;
|
|
23536
|
-
|
|
23538
|
+
_domain_EventHandler__WEBPACK_IMPORTED_MODULE_8__.EventHandler.Emit(this.whiteLabellingChanged, { next, changed: !deepEqual(prev, next) });
|
|
23537
23539
|
return parsed.data;
|
|
23538
23540
|
}
|
|
23539
23541
|
catch (_b) {
|
|
@@ -23595,7 +23597,7 @@ class ArcwareConfig extends _epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBP
|
|
|
23595
23597
|
return this._initialSettings;
|
|
23596
23598
|
}
|
|
23597
23599
|
modifyInitialSettings(mouseLock) {
|
|
23598
|
-
this.setFlagEnabled(
|
|
23600
|
+
this.setFlagEnabled(_epicgames_ps_lib_pixelstreamingfrontend_ue5_5__WEBPACK_IMPORTED_MODULE_3__.Flags.HoveringMouseMode, mouseLock);
|
|
23599
23601
|
}
|
|
23600
23602
|
}
|
|
23601
23603
|
|
package/index.umd.cjs
CHANGED
|
@@ -23401,6 +23401,7 @@ const ArcwareSettingsSchema_1 = __webpack_require__(9913);
|
|
|
23401
23401
|
const whiteLabelling_1 = __webpack_require__(5292);
|
|
23402
23402
|
const ZWhiteLabel_1 = __webpack_require__(1938);
|
|
23403
23403
|
const EventHandler_1 = __webpack_require__(3916);
|
|
23404
|
+
lib_pixelstreamingfrontend_ue5_5_1.Logger.InitLogging(2, false);
|
|
23404
23405
|
/** Default arcware signalling endpoint. */
|
|
23405
23406
|
exports.DefaultUrl = `wss://signalling-client.ragnarok.arcware.cloud`;
|
|
23406
23407
|
function deepEqual(a, b) {
|
|
@@ -23459,7 +23460,7 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
|
|
|
23459
23460
|
if (!config.initialSettings.ss)
|
|
23460
23461
|
config.initialSettings.ss = exports.DefaultUrl;
|
|
23461
23462
|
super(config);
|
|
23462
|
-
this.VERSION = "1.3.
|
|
23463
|
+
this.VERSION = "1.3.33";
|
|
23463
23464
|
this.whiteLabellingChanged = new EventHandler_1.EventHandler();
|
|
23464
23465
|
this.signallingWlURL = "https://signalling-client.arcware.cloud/whiteLabel/";
|
|
23465
23466
|
if (config.envName) {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arcware-cloud/pixelstreaming-websdk",
|
|
3
3
|
"description": "WebSDK for easy implementation of pixel streaming with Arcware Cloud Services. Heavily based on the '@epicgames-ps' library.",
|
|
4
|
-
"version": "1.3.
|
|
4
|
+
"version": "1.3.33",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "./index.cjs",
|
|
7
7
|
"types": "./types/index.d.ts",
|
|
@@ -29,7 +29,7 @@ export declare class ArcwareConfig extends Config {
|
|
|
29
29
|
readonly session: Session;
|
|
30
30
|
readonly settings: Settings;
|
|
31
31
|
private _initialSettings;
|
|
32
|
-
readonly VERSION = "1.3.
|
|
32
|
+
readonly VERSION = "1.3.33";
|
|
33
33
|
readonly whiteLabellingChanged: EventHandler<{
|
|
34
34
|
next: WhiteLabel;
|
|
35
35
|
changed: boolean;
|