@arcware/webrtc-plugin

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-cloud/webrtc-plugin";

const webrtc_client = new WebRTCClient(args);

const args = {
  address: "Signalling WS URL",
  packageName: "Name of the package (if there are multiple applications)",
  settings: {},
  // --- Containers Options ---
  // Vue (with ref="")
  sizeContainer: this.$refs.sizeContainer,
  container: this.$refs.videoContainer,
  videoRef: this.$refs.videoRef,
  // React (with useRef)
  sizeContainer: this.sizeContainer.current,
  container: this.videoContainer.current,
  videoRef: this.videoRef.current,
  // Pure JS/HTML
  sizeContainer: "container-id",
  // ---  ---
  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.
};

const webrtc = new WebRTCClient(args);
const emitUIInteraction = this.webrtc.emitUIInteraction;

Types and Props

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

SizeContainer, container and videoRef