requirements • publishing • subscribing
-------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.
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:
More information about browser compability can be viewed at the WebRTC Peer Connnection information on caniuse.com.
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.
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.
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:5080if launched locally) and the page will display its IP in the upper-right corner.
| 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. |
| Image Capture |
|---|
| Demonstrates capturing an image of a live video being published. |
| Mute |
|---|
| Muting and unmuting audio for a live video being published. |
| 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. |
| 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. |
| Shared Object |
|---|
| Demonstrates using remote Shared Object to send and recieve information between connected clients. |
| Two-Way |
|---|
| Demonstrates simultaneously publishing while subscribing - allowing a conversation. Includes stream detection and auto-connection. |
| 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. |
| 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. |
| Remote Call |
|---|
| Demonstrates receiving a remote message from broadcaster. |
| Shared Object |
|---|
| Demonstrates using remote Shared Object to send and recieve information between connected clients. |
- 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.
- 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).
- 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.