publisher •
subscriber •
---
# Red5 Pro WebRTC SDK
> The **Red5 Pro WebRTC SDK** allows you to integrate live streaming video into your desktop and mobile browser.
* [Quickstart](#quickstart)
* [Installation](#installation)
* [Requirements](#requirements)
* [Usage](#usage)
* [Publisher](#publisher)
* [WebRTC](PUBLISHER_README.md#webrtc)
* [Lifecycle Events](PUBLISHER_README.md#lifecycle-events)
* [Subscriber](#subscriber)
* [WebRTC](SUBSCRIBER_README.md#webrtc)
* [HLS](SUBSCRIBER_README.md#hls)
* [Auto Failover](SUBSCRIBER_README.md#auto-failover-and-order)
* [Lifecycle Events](SUBSCRIBER_README.md#lifecycle-events)
* [Contributing](#contributing)
# Quickstart
> Important Node About `11.0.0` Release
**Red5 Pro SDK now supports WHIP/WHEP**
Read more from out [documentation on WHIP/WHEP integration](WHIP_WHEP_README.md)!
> Important Note About `8.0.0` Release
**Red5 Pro SDK has been published on NPM!**
While currently not open source, the SDK build has been published to NPM to allow you to integrate into your projects with greater ease and dependency management.
## Installation
### As `script` in HTML page
```
```
... or if you know the version:
```
```
## Using `npm` or `yarn` for you browser-based projects
```
npm install --save-dev red5pro-webrtc-sdk
```
```
yarn install --dev red5pro-webrtc-sdk
```
### Usage
All members exposed on the otherwise global `window.red5prosdk` if loading as a script on an HTML page are importable from the `red5pro-webrtc-sdk` module:
_index.js_
```
import { WHIPClient, WHEPClient } from 'red5pro-webrtc-sdk'
```
To begin working with the *Red5 Pro HTML5 SDK* in your project:
### Quick Start - Standalone Server Deployment
```html
```
### Quick Start - StreamManager 2.0 Deployment
With the Stream Manager 2.0 Release, the `endpoint` init configuration property was introduced in the SDK to allow developers to specify the specific endpoint to proxy through on the Stream Manager.
> Note: You will need to know which Node Group you intend to target for publishing and subscribing.
```html
```
# Requirements
The **Red5 Pro WebRTC SDK** is intended to communicate with a [Red5 Pro Server](https://www.red5.net/red5-pro/low-latency-streaming-software/), which allows for broadcasting and consuming live streams utilizing [WebRTC](https://developer.mozilla.org/en-US/docs/Web/Guide/API/WebRTC) and other protocols, including [RTMP](https://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol) and [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming).
As such, you will need a distribution of the [Red5 Pro Server](https://www.red5pro.com/) running locally or accessible from the web, such as [Amazon Web Services](https://www.red5pro.com/docs/server/awsinstall/).
> **[Click here to start using the Red5 Pro Server today!](https://account.red5.net/login)**
# Usage
This section describes using the **Red5 Pro WebRTC SDK** browser install to create sessions for a [Publisher](#publisher) and a [Subscriber](#subscriber).
## WHIP/WHEP
Please refer to the [WHIP/WHEP Readme](WHIP_WHEP_README.md) for information about utilizing WHIP/WHEP clients for publishing and subscribing, respectively.
## Publisher
Please refer to the [Publisher Readme](PUBLISHER_README.md) for information about setting up a broadcast session.
## Subscriber
Please refer to the [Subscriber Readme](SUBSCRIBER_README.md) for information about setting up a subscriber session.
# Contributing
> Please refer to the [Contributing Documentation](CONTRIBUTING.md) to learn more about contributing to the development of the Red5 Pro WebRTC SDK.