@arcware-cloud/pixelstreaming-websdk 0.1.3 → 0.1.4

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.
Files changed (6) hide show
  1. package/README.md +10 -11
  2. package/index.cjs.js +1 -1
  3. package/index.esm.js +1 -1
  4. package/index.umd.js +1 -1
  5. package/package.json +1 -1
  6. package/types/lib/ArcwareConfig.d.ts +1 -1
package/README.md CHANGED
@@ -8,7 +8,7 @@ If you are not familiar with Arcware CloudRT yet, check it out on [www.arcware.c
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/final-link-missing).
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
12
 
13
13
  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
14
 
@@ -24,8 +24,6 @@ Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project,
24
24
 
25
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
26
 
27
-
28
-
29
27
  ### Installation
30
28
 
31
29
  To integrate the Arcware CloudRT Pixel Streaming WebSDK into your project, you can use either npm or yarn. Run one of the following commands in your project directory:
@@ -33,6 +31,7 @@ To integrate the Arcware CloudRT Pixel Streaming WebSDK into your project, you c
33
31
  ```bash
34
32
  npm install @arcware-cloud/pixelstreaming-websdk --save
35
33
  ```
34
+
36
35
  ```bash
37
36
  yarn add @arcware-cloud/pixelstreaming-websdk
38
37
  ```
@@ -40,7 +39,9 @@ yarn add @arcware-cloud/pixelstreaming-websdk
40
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.
41
40
 
42
41
  ### Basic Usage
42
+
43
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
+
44
45
  ```html
45
46
  <html>
46
47
  <head>
@@ -57,12 +58,12 @@ Below is a simple example demonstrating how to use the WebSDK in an HTML file to
57
58
  },
58
59
  {
59
60
  initialSettings: {
60
- AutoConnect: false
61
+ AutoConnect: false,
61
62
  // additional initial settings
62
63
  },
63
64
  settings: {
64
65
  // additional settings
65
- }
66
+ },
66
67
  }
67
68
  );
68
69
 
@@ -75,12 +76,12 @@ Below is a simple example demonstrating how to use the WebSDK in an HTML file to
75
76
  </html>
76
77
  ```
77
78
 
78
- For more detailed examples and advanced usage, please refer to our documentation: [Arcware CloudRT Pixelstreaming WebSDK Documentation](https://docs.arcware.cloud/final-link-missing).
79
-
79
+ For more detailed examples and advanced usage, please refer to our documentation: [Arcware CloudRT Pixelstreaming WebSDK Documentation](https://docs.arcware.cloud/web-integration/new-websdk).
80
80
 
81
81
  # Changelog
82
82
 
83
- ### 0.1.* (Initial Release)
83
+ ### 0.1.\* (Initial Release)
84
+
84
85
  <!-- - Upcoming changes or improvements that are currently in development can be listed here.
85
86
 
86
87
  ### [Version Number] - Release Date
@@ -103,7 +104,6 @@ For more detailed examples and advanced usage, please refer to our documentation
103
104
  ### [Previous Version Number] - Previous Release Date
104
105
  - Changes for previous versions follow the same format. -->
105
106
 
106
-
107
107
  # LICENSE
108
108
 
109
109
  MIT License
@@ -131,7 +131,6 @@ Here's a summary of these [Dependency Licenses](https://www.npmjs.com/package/@a
131
131
 
132
132
  We appreciate the contributions of these libraries, as they are essential in supporting our development efforts.
133
133
 
134
-
135
134
  <!-- # Configuration Options
136
135
 
137
136
  When creating a new instance of `ArcwareConfig`, you provide an object with two main properties: `initialSettings` and `settings`.
@@ -178,4 +177,4 @@ Once initialized, `pixelStreamingInstance` can be used to interact with the stre
178
177
  });
179
178
 
180
179
  - ` application.getApplicationResponse(``string``) `: This method can be called to get a response from the application, which might include status updates or other messages.
181
- - `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. -->
180
+ - `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. -->