@arcware-cloud/pixelstreaming-websdk 0.1.10 → 0.1.12
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
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Arcware
|
|
1
|
+
# Arcware Cloud Pixel Streaming WebSDK
|
|
2
2
|
|
|
3
3
|
## Introduction
|
|
4
4
|
|
|
5
|
-
Welcome to the `@arcware-cloud/pixelstreaming-websdk`, a robust solution tailored for integrating Unreal Engine's Pixel Streaming technology into web applications via Arcware
|
|
5
|
+
Welcome to the `@arcware-cloud/pixelstreaming-websdk`, a robust solution tailored for integrating Unreal Engine's Pixel Streaming technology into web applications via Arcware Cloud. This SDK is an extension of Epic Games' "PixelStreamingInfrastructure", enriching it with functionalities specifically designed for Arcware Cloud. It empowers developers to deliver interactive 3D experiences of exceptional quality directly to modern web browsers, eliminating the need for any plugins or downloads.
|
|
6
6
|
|
|
7
|
-
If you are not familiar with Arcware
|
|
7
|
+
If you are not familiar with Arcware Cloud yet, check it out on [www.arcware.com](https://arcware.com/cloudrt).
|
|
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
|
|
|
@@ -18,7 +18,7 @@ For an in-depth understanding of the underlying technology and infrastructure, y
|
|
|
18
18
|
|
|
19
19
|
Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project, please ensure the following prerequisites are met:
|
|
20
20
|
|
|
21
|
-
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
|
|
21
|
+
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
22
|
|
|
23
23
|
2. **Web Application Development Environment**: Ensure that your web application development environment is set up with either `yarn` or `npm`. These package managers are required for installing the WebSDK.
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project,
|
|
|
26
26
|
|
|
27
27
|
### Installation
|
|
28
28
|
|
|
29
|
-
To integrate the Arcware
|
|
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
30
|
|
|
31
31
|
```bash
|
|
32
32
|
npm install @arcware-cloud/pixelstreaming-websdk --save
|
|
@@ -45,7 +45,7 @@ Below is a simple example demonstrating how to use the WebSDK in an HTML file to
|
|
|
45
45
|
```html
|
|
46
46
|
<html>
|
|
47
47
|
<head>
|
|
48
|
-
<title>Arcware
|
|
48
|
+
<title>Arcware Cloud - Pixel Streaming</title>
|
|
49
49
|
<script type="module">
|
|
50
50
|
import * as PixelStreamingWebSdkCore from "https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@latest/index.esm.js";
|
|
51
51
|
|
|
@@ -76,7 +76,7 @@ Below is a simple example demonstrating how to use the WebSDK in an HTML file to
|
|
|
76
76
|
</html>
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
For more detailed examples and advanced usage, please refer to our documentation: [Arcware
|
|
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
80
|
|
|
81
81
|
# Changelog
|
|
82
82
|
|