README.md

requirements • publishing • subscribing

Red5 Pro HTML5 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 HTML SDK.

These examples are also shipped with the Red5 Pro Server and can be found in the webapp webrtcexamples.

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 Red5Pro.com.

Browser Compability

While the Red5 Pro HTML SDK aims to utilize WebRTC for its streaming solution (both publishing and subscribing), the SDK does support fallback support for non-supporting browsers in both contexts. The default failover order for both contexts, which can be redfined by developers, is:

Publisher

1. WebRTC
2. Flash

Subscriber

1. WebRTC
2. Flash
3. HLS

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

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://localhost:5080 if launched locally) and the page will display its IP in the upper-right corner.

Examples

Publishing

Publisher
Basic publisher example using WebRTC with failover. i.e, if no WebRTC browser support, then Flash Player if detected.

1080p
A high quality publisher.

Authentication
Demonstrates authentication with the Simple-Auth-Plugin for publishing.

Camera Source
Demonstrates selecting the desired camera to publish with.

MediaStream Swap
Demonstrates using replaceTrack to swap in a different Camera source dynamically for WebRTC-based Publishers.

Image Capture
Demonstrates capturing an image of a live video being published.

Mute
Muting and unmuting audio for a live video being published.

Record
Demonstrates recording a stream to the server for VOD (Video-On-Demand) playback.

Append
Demonstrates record-append function a stream to the server for VOD (Video-On-Demand) playback.

Remote Call
Demonstrates sending a remote message to all subscribed clients.

Round Trip Authentication
An example of utilizing round-trip authentication with Red5 Pro.

Shared Object
Demonstrates using remote Shared Object to send and recieve information between connected clients.

Screen Share
An example of utilizing the screen sharing capabilities of Chrome and Firefox. For use with Subscribe Screen Share example.

Publishing - Stream Manager Examples

Stream Manager
Demonstrates utilizing the Red5 Pro Stream Manager API to publish to an autoscaling cluster's origin.

Stream Manager Proxy
Demonstrates utilizing the Red5 Pro Stream Manager as an SSL WebSocket Proxy to publish WebRTC to an autoscaling cluster's origin.

Stream Manager Provision Form
Provides an easy form to POST a new Provision to the Stream Manager for ABR broadcasts. Once the provision is POSTed, use your favorite Media Encoder to broadcast the variants.

Stream Manager Proxy Round Trip Authenticaion
An example of utilizing round-trip authentication with Red5 Pro over Stream Manager Proxy.

Stream Manager Proxy Screen Share
An example of utilizing the screen sharing capabilities of Chrome and Firefox. For use with Stream Manager Proxy Subscribe Screen Share example.

Stream Manager Proxy Transcoder
Provides an easy form to POST a new Provision to the Stream Manager for ABR broadcasts and to start a single variant broadcast using the Transcoder.

Two-Way Stream Manager Proxy
The Two-Way example through a Stream Manager - including use of a proxy. Includes stream detection and auto-connection.

Multi

Two-Way
Demonstrates simultaneously publishing while subscribing - allowing a conversation. Includes stream detection and auto-connection.

Conference
Demonstrates multi-party communication using Red5 Pro. It also demonstrates using Shared Objects as notifications to recognize the addition and removal of parties broadcasting.

Shared Object (websockets only)
Demonstrates the use of Shared Objects through a WebSocket proxy from the Red5 Pro HTML SDK.

Subscribing

Subscriber
Basic subscriber example with failover. i.e, if no WebRTC browser support, then first Flash Player is detected, then HLS.

Audio Only
Demonstrates playback of audio-only stream.

Authentication
Demonstrates authentication with the Simple-Auth-Plugin for subscribing.

Image Capture
Demonstrates capturing an image of a live video being consumed.

Cluster
Demonstrates accessing an IP from the Red5 Pro Cluster API to subcribe to a live stream.

Reconnect
Demonstrates the failover mechanism of the Red5 Pro HTML SDK to select a subscriber based on browser support and to auto-reconnect on close of broadcast or loss of connection.

Remote Call
Demonstrates receiving a remote message from broadcaster.

Round Trip Authentication
An example of utilizing round-trip authentication with Red5 Pro over Stream Manager Proxy

Shared Object
Demonstrates using remote Shared Object to send and recieve information between connected clients.

Screen Share
An example of utilizing the screen sharing capabilities of Chrome and Firefox. For use with Publish Screen Share example.

Two Streams
An example that subscribes to two streams, using the Stream1 Name and Stream 2 Name variables from the settings page.

Video Mute
Example to demonstrate subscribing to a broadcast which has its video stream "muted".

Subscribing - Stream Manager Examples

Stream Manager
Demonstrates utilizing the Red5 Pro Stream Manager API, and acting as SSL WebSocket Proxy, to access an Edge server IP to subscribe to a live stream.

Stream Manager Proxy
Demonstrates utilizing the Red5 Pro Stream Manager API to access an Edge server IP to subscribe to a live stream.

Stream Manager Proxy Round Trip Authentication
Demonstrates subscribing using round trip authentication.

Stream Manager Proxy Transcoder (RTC)
Demonstrates utilizing the Red5 Pro Stream Manager API to access Provisions and an Edge server IP to subscribe to a live WebRTC-based stream with Adaptive Bitrate Control.

Stream Manager Proxy Transcoder (RTMP)
Demonstrates utilizing the Red5 Pro Stream Manager API to access Provisions and an Edge server IP to subscribe to a live Flash-based stream with Adaptive Bitrate Control.

Stream Manager Proxy Transcoder (HLS)
Demonstrates utilizing the Red5 Pro Stream Manager API to access Provisions and an Edge server IP to subscribe to a live HLS-based stream with Adaptive Bitrate Control.

Stream Manager Proxy Screen Share
An example of utilizing the screen sharing capabilities of Chrome and Firefox. For use with Publish Screen Share example.

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_red5_pro_server_ip:5080/live.
2. You can see a list of active streams by navigating to http://your_red5_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://your_red5_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.