Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@arcware/webrtc-plugin

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@arcware/webrtc-plugin

Javascript/Typescript module to connect any frontend to Unreal Engine 4 app with pixel streaming enabled through signalling WS.

0.1.4
npm

Version published: 2 years ago

Maintainers: 2

Created: 3 years ago

Source

Arcware WebRTC Plugin

Javascript/Typescript module to connect any frontend to Unreal Engine 4 app with pixel streaming enabled through signalling WS.

Getting started

import { WebRTCClient } from "@arcware/webrtc-plugin";

// Vue template
<div ref="sizeContainer">
  <div ref="videoContainer">
    <video ref="videoRef" />
  </div>
</div>

// React template
const sizeContainerRef = React.useRef();
const containerRef = React.useRef();
const videoRef = React.useRef();

<div ref={sizeContainerRef}>
  <div ref={containerRef}>
    <video ref={videoElRef} />
  </div>
</div>;

// Angular template

<div #sizeContainer>
  <div #container>
    <video #videoEl></video>
  </div>
</div>

@ViewChild("videoEl") inputVideo!: ElementRef;
@ViewChild("container") container!: ElementRef;
@ViewChild("sizeContainer") sizeContainer!: ElementRef;

// Initialize WebRTC

const args = {
  address: "Signalling WS URL",
  packageId: "Name of the package (if there are multiple applications)",
  settings: {},
  // --- Containers Options ---
  // Vue
  sizeContainer: this.$refs.sizeContainer,
  container: this.$refs.videoContainer,
  videoRef: this.$refs.videoRef,
  // React
  sizeContainer: sizeContainerRef,
  container: containerRef,
  videoRef: videoRef,
  // Angular
  sizeContainer: this.sizeContainer.nativeElement,
  container: this.container.nativeElement,
  videoRef: this.inputVideo.nativeElement,
  // ---  ---
  playOverlay: true, // Set default overlay with play button. Make it false and use loader
  loader: (val) => {}, // Callback for loading screen, etc. Once stream is ready, the function will be triggered with false value.
  applicationResponse: (obj) => {}, // Callback for Unreal Engine application messages.
};

const webrtc_client = new WebRTCClient(args);
const emitUIInteraction = webrtc_client.emitUIInteraction; // Method to send descriptors to UE4 app

// <script> with index.html implementation
<head>
  <script src="https://unpkg.com/@arcware/webrtc-plugin@latest/webrtc-plugin.umd.js"></script>
</head>
<body style="background: black; margin: 50px">
  <script>
    window.addEventListener("load", function () {
      const args = {
        address: "Signalling WS URL",
        packageId: "id/alias of the package",
        settings: {},
        sizeContainer: "container",
        playOverlay: true, // play button before stream runs
      };

      this.webrtc = new window.WebrtcPlugin.WebRTCClient(args);
    });
  </script>
  <div id="container"></div>
</body>

Types and Props

Please follow to WebRTCClientProps interface exported from module to check properties types

SizeContainer, container and videoRef

FAQs

What is @arcware/webrtc-plugin?

Is @arcware/webrtc-plugin well maintained?

Package last updated on 25 Jul 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@arcware/webrtc-plugin

Arcware WebRTC Plugin

Getting started

Types and Props

SizeContainer, container and videoRef

Related posts

Typosquatting Cryptographic Libraries: Malicious npm Packages Threaten Crypto Developers with Keylogging and Wallet Theft

Weekly Downloads Now Available in npm Package Search Results