Requirements
Red5 Pro Server
You will need a functional, running Red5 Pro server web- (or locally-) accessible for the client to connect to. If you already have a Red5 Pro Account, you can find the Red5 Pro Server download at https://account.red5pro.com/download.
For more information visit Red5Pro.com.
Red5 Pro SDK License Key
A Red5 Pro SDK License Key is required to use the iOS Mobile SDK. If you already have a Red5 Pro Account, you can find your Red5 Pro SDK License Key at https://account.red5pro.com/overview.
You will need to copy the
SDK Licenseinto thelicense_keyproperty field of the tests.xml resource file.
Setup
You will need to modify app/src/res/raw/test.xml (the domain value) to point to your host server instance's IP address and update the license_key property to that of your Red5 Pro SDK License. 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.
Once you have modified your settings, you can run the application for simulator or device.
Examples
Publishing
| 1080p |
|---|
| A high quality publisher. Note that this is the publish test with a non-default 'bitrate' and camera size values set in tests.xml |
| --- |
| ABR |
| A high bitrate publisher with AdaptiveBitrateController |
| --- |
| Aspect Ratio |
| Publish example that includes manipulation of the preview display's aspect ratio |
| --- |
| Authentication |
| An example of publishing a stream as an authenticated user |
| --- |
| Background |
| An example that continues publishing audio from the background. |
| --- |
| Bandwidth Detection - Upload |
| An example that tests the upload speed between the device and server before publishing. |
| --- |
| Camera Device Orientation |
An example that combines the Camera Swap and Device Orientation examples. |
| --- |
| Camera Swap |
| Touch the screen to swap which camera is being used! Verify using flash that camera is swapping properly and no rendering problems occur. |
| --- |
| Camera2 |
| Publish example for the camera2 api. |
| --- |
| Custom Mic Source |
| Uses a custom controller to supply audio data to the publisher. |
| --- |
| Custom Video Source |
| Uses a custom controller to supply video data to the publisher. |
| --- |
| Device Orientation |
| After starting a broadcast, rotate your device from portrait to landscape. You will notice that the view updates on the broadcasting device. Additionally, if you subscribe with mobile or the browser-based players, you will see their orientation update with the change to device orientation. |
| --- |
| Encrypted |
| An example that encrypts all traffic between the device and server. |
| --- |
| HQ Audio |
| A publish example with high quality audio |
| --- |
| Image Capture |
| Touch the publish stream to take a screen shot that is displayed! |
| --- |
| LocalRecord |
| A publish example that records stream data locally on the device. |
| --- |
| Orientation |
| Touch the screen to rotate the output video 90 degrees. Verify with flash, android, or other iOS device running subscribe test. |
| --- |
| Mute/Unmute |
| Touch the screen to toggle between sending Audio & Video, sending just Video, sending just Audio, and sending no Audio or Video. Turning off and on the media sources is considered mute and unmute events, respecitively |
| --- |
| Record |
| A publish example that records stream data on the server. |
| --- |
| Remote Call |
| The publish portion of the remote call example - sends the remote call. |
| --- |
| Stream Manager |
| A publish example that connects with a server cluster using a Stream Manger. |
| --- |
| Stream Manager Encrypted |
| A publish example that connects with a server cluster using a Stream Manger and encrypts the data in transit. |
| --- |
| Stream Manager Transcoder |
| A publish example that uses transcoding broadcast over Stream Manager. |
| --- |
| Two Way |
| An example of simultaneously publishing while subscribing - allowing a conversation. Includes stream detection and auto-connection. |
| --- |
| Two Way - Stream Manager |
| The two way example, modified to work with a stream manager. Includes stream detection and auto-connection. |
| --- |
| Shared Object |
| An example of sending data and messages between clients through remote shared objects. |
| --- |
| Shared Object |
| Chat example with shared objects that doesn't require an active stream.. |
Subscribing
| Aspect Ratio |
|---|
| Change the fill mode of the stream. scale to fill, scale to fit, scale fill. Aspect ratio should be maintained on first 2. |
| --- |
| Authentication |
| An example of subscribing to a stream as an authenticated user |
| --- |
| Background Test |
| An example of running a subscribe example in a separate process so that it can continue when the application loses focus. |
| --- |
| Bandwidth Test |
| Detect Insufficient and Sufficient BW flags. Test on a poor network using a publisher that has high video quality. Video should become sporadic or stop altogether. The screen will darken when no video is being received. |
| --- |
| Bandwidth Detection - Download |
| An example that tests the download speed between the device and server before subscribing. |
| --- |
| Bandwidth Detection - Dual |
| An example that tests both the upload and download speeds between the device and server before subscribing. |
| --- |
| Cluster |
| An example of conecting to a cluster server. |
| --- |
| Encrypted |
| An example that encrypts all traffic between the device and server. |
| --- |
| Image Capture |
| Touch the subscribe stream to take a screen shot that is displayed! |
| --- |
| Hardware Acceleration |
| Subscribe test using hardware acceleration for decoding. |
| --- |
| Mute |
| Simple Subscribe Mute Audio Test! |
| --- |
| No View |
| A proof of using an audio only stream without attaching it to a view. |
| --- |
| Reconnect |
| An example of reconnecting to a stream on a connection error. |
| --- |
| Remote Call |
| The subscribe portion of the remote call example - receives the remote call. |
| --- |
| Render RGB |
| Subscribe test forcing RGB scalar for decoding. |
| --- |
| Set Volume |
| Set playback volume on a subscriber. |
| --- |
| Stream Manager |
| A subscribe example that connects with a server cluster using a Stream Manger. |
| --- |
| Stream Manager Encrypted |
| A subscribe example that connects with a server cluster using a Stream Manger and encrypts the data in transit. |
| --- |
| Stream Manager Transcoder |
| A subscribe example that connects to a cluster server with the Stream Manager using ABR. |
| --- |
| Two Streams |
| An example of subscribing to multiple streams at once, useful for subscribing to a presentation hosted by two people using a Two Way connection. |
Multi
| 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. |
Notes
- For some of the above examples you will need two devices (a publisher, and a subscriber). You can also use a web browser to subscribe or publish via Flash.
- You can see a list of active streams by navigating to http://your_red5_pro_server_ip:5080/live/streams.jsp
- Click on the flash link (for example, flash_publisher) in the streams list displayed to view the published stream in your browser.
Android Release and Proguard
The following Proguard Rules may be required when deploying an Android App Release with minification:
-keepattributes *Annotation*,Signature,EnclosingMethod
-keep class com.red5pro.** { *; }
-keep interface com.red5pro.** { *; }
-keep public class com.red5pro.streaming.** { *; }
-dontwarn com.red5pro.**
-keep, includedescriptorclasses class com.red5pro.streaming.R5Stream { *; }
-keep, includedescriptorclasses class com.android.webrtc.audio.** { *; }Informative Documentation: https://medium.com/google-developers/practical-proguard-rules-examples-5640a3907dc9