streaming html5

requirements •
publishing •
subscribing

Red5 Pro HTML Streaming Testbed

This repository contains a simple project with a number of examples that can be used for testing and reference for the Red5 Pro WebRTC SDK.

Requirements

You will need a functional, running Red5 Pro server web- (or locally-) accessible for the client browser (mobile & desktop) to connect to.

For more information visit https://www.**r*ed5.net/.

Browser Compability

The Red5 Pro WebRTC SDK aims to utilize WebRTC for its streaming solution (both publishing and subscribing), but also provides HLS support for browsers that support it natively (e.g., Mobile and Desktop Safari).

More information about browser compability can be viewed at the WebRTC Peer Connnection information on caniuse.com.

Publisher

The term Publisher in the context of Red5 Pro refers to a client that produces a broadcast stream. There are two types of instances from the SDK that can be utilized to start a Publisher:

1. WHIPClient – The WHIPClient relies on the WebRTC-HTTP ingestion protocl to establish a connection through series of HTTP/S requests.
2. RTCPublisher – The RTCPublisher relies on a WebSocket connection to establish a broadcast session.

The WHEPClient connection sequence is very fast – ~1 second – whereas the RTCPublisher, due to its reliance on a WebSocket can take roughly 3 – 5 seconds for a connection to stream.

Subscriber

The term Subscriber in the context of Red5 Pro refers to a client that consumes and plays back an already live broadcast stream. There are three types of instances from the SDK that can be utilized to start a Subscriber:

1. WHEPClient – The WHEPClient relies on the WebRTC-HTTP egress protocol to establish a connection through series of HTTP/S requests.
2. RTCSubscriber – The RTCSubscriber relies on a WebSocket connection to establish a broadcast session.
3. HLSSubscriber – The HLSSubscriber relies on the native ability to playback HLS streams (e.g., Mobile and Desktop Safari).

The WHEPClient connection sequence is very fast – ~1 second – whereas the RTCPublisher, due to its reliance on a WebSocket can take roughly 3 – 5 seconds for a connection to stream

The HLSSubscriber does not go through a connection sequence and streams the HLS directly from the server, however it does have an up to 6 second latency due to the length of its live segments.

NOTE: The WHIPClient and WHEPClient were introduced in the 11.0.0 release of the Red5 Pro WebRTC SDK.

Setup

You will need to modify the Host field from the Settings page to point to your server instance\’s IP address. If you do not, the examples will not function when you build. If you are running the server locally, then your machine and mobile device need to be on the same WiFi network.

Note on TLS and CORS

It is important to note that some of these examples – specifically those that involve publishing using WebRTC – require being run on TLS and, thusly, served over HTTPS. If running the examples on localhost you should not see an issues, but if your server is deployed remotely you will need to be sure that these examples are served over HTTPS and the proper Cross Origin Resource Sharing (CORS) settings are defined for the server.

• Read More about Red5 Pro and SSL.
• More information on CORS.

Instructions

To define the server instance\’s IP address, open the testbed webapp in a browser and navigate to the Settings page if not presented upon launch. To access the Settings back, select the Home item from the examples list located at the top.

To define the Host with the server instance\’s IP, click the Host field f the form and enter in the local or remote IP address – e.g., 10.0.0.5, 76.199.199.199.

Hint: You can also open the landing page of your server instance at port 5080 (i.e., http://*l*ocal*host:5080 if launched locally) and the page will display its IP in the upper-right corner.

WHIP/WHEP Settings Option

You can select to prefer WHIP/WHEP from the Settings page. By selecting this option, all tests will utilize the WHEPClient and WHIPClient for publishing and subscribing, respectively.

If you decide to de-select the WHIP/WHEP option, all tests will revert to using the RTCPublisher and RTCSubscriber for publishing and subscibing, respectively. These instances require WebSocket support in the browser during their negotiation stage. Once the connection is made, the messaging transport system is switching to RTCDataChannel and the WebSocket is closed.

Examples

Publishing

Publishing – Stream Manager Examples

Multi

Subscribing

Subscribing – Stream Manager Examples

Mixer – Stream Manager Examples

Notes

1. For the Subscriber examples, you will need to have a live stream currently being published and named based on the Stream 1 Name field of the Settings. You can use another device to start streaming using this webapp, or you can also use a web browser to publish via Flash, http://your_re*d**5_pro_server_ip:5080/live.
2. You can see a list of active streams by navigating to http://y*o*ur_re*d5_pro_server_ip:5080/live/subscribe.jsp (will need to refresh this page after you have started publishing).
3. You can access the server IP of your Red5 Pro Server install – to be used in the Host field of the Settings – by opening http://yo*ur_r**ed5_pro_server_ip:5080/ and finding the IP printed in the upper-right of the page.
4. Unless you are running the server locally, WebRTC publishing requires a valid SSL certificate.