@arcware-cloud/pixelstreaming-websdk

v0.1.11

Published

4 months ago

WebSDK for easy implementation of pixel streaming with Arcware Cloud Services. Heavily based on the '@epicgames-ps' library.

Downloads

924

0High
0Medium
0Low

b.rey

m.eschey

i.garcia

arcware arcware cloud pixelstreaming epicgames unrealengine

Arcware Cloud Pixel Streaming WebSDK

Introduction

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.

If you are not familiar with Arcware Cloud yet, check it out on www.arcware.com.

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.

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.

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.

Getting Started

Prerequisites

Before integrating the @arcware-cloud/pixelstreaming-websdk into your project, please ensure the following prerequisites are met:

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.
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.
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.

Installation

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:

npm install @arcware-cloud/pixelstreaming-websdk --save

yarn add @arcware-cloud/pixelstreaming-websdk

We recommend keeping the WebSDK up to date to ensure you have the latest features and bug fixes. Regularly check for and install updates.

Basic Usage

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.

<html>
  <head>
    <title>Arcware Cloud - Pixel Streaming</title>
    <script type="module">
      import * as PixelStreamingWebSdkCore from "https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@latest/index.esm.js";

      const { ArcwareInit } = PixelStreamingWebSdkCore;

      const { Config, PixelStreaming, Application } = ArcwareInit(
        {
          // Replace with your actual share ID
          shareId: "share-0be4620b-77aa-42b1-98cb-f7ee61be443?",
        },
        {
          initialSettings: {
            AutoConnect: false,
            // additional initial settings
          },
          settings: {
            // additional settings
          },
        }
      );

      document.getElementById("videoContainer").appendChild(Application.rootElement);
    </script>
  </head>
  <body>
    <div id="videoContainer" style="height: 1000px; width: 1000px;"></div>
  </body>
</html>

For more detailed examples and advanced usage, please refer to our documentation: Arcware Cloud Pixelstreaming WebSDK Documentation.

Changelog

0.1.* (Initial Release)

LICENSE

MIT License

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dependency Licenses

This software inherits code from several other libraries, namely:

Here's a summary of these Dependency Licenses/DEPENDENCY_LICENSE.md.

We appreciate the contributions of these libraries, as they are essential in supporting our development efforts.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme