Skip to main content

Getting started with WebRTC Ingest

Deprecated

WebRTC ingest is deprecated for new browser-based integrations. Use MoQ ingest with the Publisher SDK for new browser publishing workflows.

The WebRTC ingest workflow below remains available for existing integrations.

There are multiple ways to integrate WebRTC ingest for existing deployments:

Embeddable sender​

The WebRTC Ingest Embed can be standalone or embedded using iframe on your website without any coding effort for existing WebRTC integrations.

You can find the latest version of the WebRTC Embed Sender at webrtc-ingest-embed.vindral.com.

Iframe example​

Below is a simple example of how to embed a responsive WebRTC Ingest.

<style>
  .vindral-container {
    position: relative;
    height: 0;
    overflow: hidden;
    max-width: 100%;
  }
  .vindral-container iframe {
    position: absolute;
    top: 0;
    left: 0;
    width: 100%;
    height: 100%;
  }
</style>
<div class="vindral-container" style="padding-bottom: 75%">
  <iframe
    src="https://webrtc-ingest-embed.vindral.com?core.streamKey=enteryourstreamid"
    frameborder="0"
    allow="camera; microphone"
    allowfullscreen
  ></iframe>
</div>

Read more about embedding WebRTC ingest.

WebRTC Ingest QoS​

The Vindral WebRTC Ingest QoS Client, Quality of Service client, is a web page for sending live streams from the browser in existing WebRTC workflows. You will find connection and media statistics to make it easier to test stability issues, which can be hard to find in other software.

You can find the latest version of the WebRTC Ingest QoS Client at webrtc-ingest-qos.vindral.com.

Installation​

Install @vindral/webrtc-ingest-sdk only if you are maintaining an existing WebRTC ingest integration.

Use npm:

npm install --save @vindral/webrtc-ingest-sdk

or yarn:

yarn add @vindral/webrtc-ingest-sdk

Example usage​

Examples of how to use the WebRTC Ingest SDK can be found in the examples repository.

API Reference​

For more in-depth information about the SDK, read the WebRTC Ingest SDK API reference.

Self-hosted WebRTC Ingest QoS/Embed​

The WebRTC Ingest QoS and Embed clients are available as a separate package for customers that need to keep hosting the workflow on their own infrastructure.

Contact us for more information on self-hosting.