Skip to main content

Getting started with WebRTC Ingest

Using WebRTC for ingesting is an excellent way of providing users (and broadcasters alike) with an easy way of broadcasting without the need to install any software.

There are multiple ways to integrate the WebRTC Ingest, depending on use-case:

Embeddable sender​

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

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. 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 using 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, 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 want to host it on their infrastructure.

Contact us for more information on self-hosting.