Red5

https://www.red5.net/docs/
Admin
Red5 is a real-time live streaming platform that provides ultra-low latency video, audio, and data...
Tokens:1,329,263
Snippets:9,065
Trust Score:9.7
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install Go SDK package

Source: https://www.red5.net/docs/red5-cloud/development/sdks/backend-sdk/go-golang

Install the Red5 Go Backend SDK using go get. The package is not published yet, so you must obtain it from the support team.

```bash
go get github.com/red5pro/red5-bcs-go  
```

--------------------------------

### Get Provision Status

Source: https://www.red5.net/docs/red5-pro/development/api/stream-manager-2.0/restreamer/stream-manager-2.0-restreamer-example-rtmp-pull

Queries the status of the provision's streams. Note: the example uses `zixi1` as the provision GUID, which may be a typo; the actual provision GUID is `rtmppull1`.

```bash
curl -H "Authorization: Bearer ${JWT}" https://as-test1.example.org/as/v1/streams/provision/nodegroup1/zixi1?status=true | json_pp
```

--------------------------------

### Build examples with make

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/examples/red5-core-sdk-examples-overview

Navigate to the examples directory and run make to build the examples.

```bash
cd ~/Red5Core/<distribution>/examples

make
```

--------------------------------

### Client setup with master credentials

Source: https://www.red5.net/docs/red5-cloud/development/sdks/backend-sdk/go-golang

Import the package and create a new client using your master credentials. Replace YOUR_MASTER_KEY and YOUR_MASTER_SECRET with your actual credentials.

```go
package main  

import (  
    "fmt"  
    "log"  
    "github.com/red5pro/red5-bcs-go"  
)  

func main() {  
    masterKey := "YOUR_MASTER_KEY"  
    masterSecret := "YOUR_MASTER_SECRET"  

    client, err := red5bcs.NewRed5Client(masterKey, masterSecret)  
    if err != nil {  
        log.Fatal(err)  
    }  
}  
```

--------------------------------

### Install and Start TrueTime Meetings

Source: https://www.red5.net/docs/red5-cloud/development/truetime-meetings

Commands to clone the repository, install dependencies, and start the development server.

```bash
# Clone the repository  

git clone https://github.com/red5pro/red5-truetime-meetings  

cd truetime-meetings  

  

# Install dependencies  

npm install --legacy-peer-deps  

  

# Start the development server  

npm start  
```

--------------------------------

### Full application example

Source: https://www.red5.net/docs/red5-cloud/development/sdks/backend-sdk/go-golang

Complete example that creates a client, generates an admin conference token (2 hours) and a chat token (read/write, 1 hour), and prints them.

```go
package main  

import (  
    "fmt"  
    "log"  
    "github.com/red5pro/red5-bcs-go"  
)  

func main() {  
    masterKey := "MASTER_KEY"  
    masterSecret := "MASTER_SECRET"  

    client, err := red5bcs.NewRed5Client(masterKey, masterSecret)  
    if err != nil {  
        log.Fatal(err)  
    }  

    // Admin conference token (2 hours)  
    adminToken, err := client.GetConferenceToken(  
        "userA",  
        "room1",  
        "admin",  
        120,  
    )  
    if err != nil {  
        log.Fatal(err)  
    }  
    fmt.Println(adminToken)  

    // Chat token (read/write, 1 hour)  
    chatToken, err := client.GetChatToken(  
        "userA",  
        "channel1",  
        true,  
        true,  
        60,  
    )  
    if err != nil {  
        log.Fatal(err)  
    }  
    fmt.Println(chatToken)  
}  
```

--------------------------------

### Get Applications API Response Example

Source: https://www.red5.net/docs/red5-pro/development/api/server/red5-pro-server-applications-api

Example JSON response for a successful GET request to the applications endpoint.

```json
{

  "status": "success",

  "code": 200,

  "data": [

    "api",

    "live"

  ],

  "timestamp": 1467060546158

}
```

--------------------------------

### Build examples on Linux/MacOS

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/examples

Compile the examples using make.

```bash
cd ~/Red5Core/<distribution>/examples  

make  
```

--------------------------------

### Get Alarm Threshold - Example request URI

Source: https://www.red5.net/docs/red5-pro/development/api/archive/rest-api-v-310/smapi-alarms

Example GET request URI with a sample access token.

```http
http://{host}:{port}/streammanager/api/3.1/admin/alarm/scaleout/default?type=edge&accessToken=xyz123
```

--------------------------------

### Quick Start: Configure client, listen for events, and join a room

Source: https://www.red5.net/docs/red5-cloud/development/sdks/conference-sdk

This example shows how to import the ConferenceClient and ConferenceEvents, configure the client with host, nodeGroup, ICE servers, and PubNub keys, listen for USER_PUBLISHED and NEW_PARTICIPANT events, and join a room with media stream and role. It uses async/await and requires a valid auth token and media stream from getUserMedia.

```javascript
import { ConferenceClient, ConferenceEvents } from 'red5pro-conference-sdk';  

// 1. Configure the client  
const config = {  
  host: 'your-red5-pro-host',  
  nodeGroup: 'your-node-group',  
  iceServers: [{ urls: 'stun:stun.l.google.com:19302' }],  
  pubnubPublishKey: 'your-pubnub-publish-key',  
  pubnubSubscribeKey: 'your-pubnub-subscribe-key'  
};  

const client = new ConferenceClient(config);  

// 2. Listen for events  
client.on(ConferenceEvents.USER_PUBLISHED, (event) => {  
  console.log('Successfully published to room:', event.streamName);  
});  

client.on(ConferenceEvents.NEW_PARTICIPANT, (participant) => {  
  console.log('New participant joined:', participant.userId);  
  // Auto-subscribe to the new participant  
  client.subscribe(participant);  
});  

// 3. Join a room  
const joinParams = {  
  roomId: 'my-awesome-room',  
  userId: 'user-' + Math.floor(Math.random() * 1000),  
  token: 'your-auth-token',  
  role: 'publisher',  
  mediaStream: await navigator.mediaDevices.getUserMedia({ video: true, audio: true }),  
  videoEnabled: true,  
  audioEnabled: true  
};  

await client.join(  
  joinParams.roomId,  
  joinParams.userId,  
  joinParams.token,  
  joinParams.role,  
  joinParams.mediaStream,  
  joinParams.videoEnabled,  
  joinParams.audioEnabled  
);  
```

--------------------------------

### Get Alarm Threshold - Example success response

Source: https://www.red5.net/docs/red5-pro/development/api/archive/rest-api-v-310/smapi-alarms

Example JSON response for a successful GET request, showing a threshold of 60.

```json
    {  

      "id": 1,  

      "type": "SCALEOUTALARM",  

      "metric": "CONNECTIONS",  

      "unit": "PERCENTAGE",  

      "threshold": 60,  

      "comparator": "GREATERTHAN",  

      "targetType": "GROUP"  

    }  
```

--------------------------------

### Autoplay in 3.5.0 SDK: play() on Subscriber

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-webrtc-sdk/red5-webrtc-sdk-migrating-from-3-5-to-4

In SDK 3.5.0, calling play() on a Red5ProSubscriber automatically starts playback upon successful subscription. The example shows a basic subscriber setup with a video element without autoplay attribute.

```html
<!doctype html>  

<html>  

  <head>  

    <script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>  

    <script src="lib/red5pro/red5pro-sdk.min.js"></script>  

  <head>  

  <body>  

    <video id="red5pro-subscriber" controls></video>  

    <script>  

        (function (red5prosdk) {  

          'use strict';  

  

          var configuration = {}; // not defined for clarity in this example.  

  

          var subscriber = new red5prosdk.Red5ProSubscriber();  

          var view = new red5prosdk.PlaybackView('red5pro-subscriber');  

          view.attachSubscriber(subscriber);  

  

          subscriber.init(configuration)  

            .then(function (selectedSubscriber) {  

              selectedSubscriber.play();  

            });  

  

        })(window.red5prosdk);  

    </script>  

  </body>  

</html>  


```

--------------------------------

### Full application example

Source: https://www.red5.net/docs/red5-cloud/development/sdks/backend-sdk/node

Complete example that initializes the client, generates an admin conference token (2 hours) and a chat token (read/write, 1 hour), and logs both.

```javascript
import Red5Client from 'red5-bcs-node';  

async function main() {  
    const masterKey = "MASTER_KEY";  
    const masterSecret = "MASTER_SECRET";  

    const client = new Red5Client(masterKey, masterSecret);  

    // Admin conference token (2 hours)  
    const adminToken = await client.getConferenceToken(  
        "userA",  
        "room1",  
        "admin",  
        120  
    );  
    console.log(adminToken);  

    // Chat token (read/write, 1 hour)  
    const chatToken = await client.getChatToken(  
        "userA",  
        "channel1",  
        true,  
        true,  
        60  
    );  
    console.log(chatToken);  
}  

main();  
```

--------------------------------

### InsecurePlatformWarning example

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/archive/ssl/installing

Example warning that may appear during installation and can be disregarded.

```text
InsecurePlatformWarning  

./root/.local/share/letsencrypt/local/lib/python2.7/site-packages/pip/_vendor/requests/packages/urllib3/util/ssl_.py:90: InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.  

```

--------------------------------

### Execute the basic example

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/red5-core-sdk-mac

Runs the basic example binary. For each example, see the README for expected behavior.

```bash
./r5sdk_example_basic
```

--------------------------------

### Execute the basic example on Linux/MacOS

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/examples/red5-core-sdk-examples-overview

Run the basic example executable from the basic directory.

```bash
cd ~/Red5Core/<distribution>/examples/basic   ./r5sdk_example_basic
```

--------------------------------

### getLiveStreamStatistics Example Request

Source: https://www.red5.net/docs/red5-pro/development/api/server/red5-pro-server-streams-api

A concrete example of a GET request for stream statistics.

```http
http://localhost:5080/api/v1/applications/live/streams/stream1?accessToken=xyz123
```

--------------------------------

### Start Red5 Pro and tail log (startred5pro.sh)

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/archive/auto-aws-wav/red5proservice

Creates a script to start the Red5 Pro service and follow the log file. Make it executable with chmod +x startred5pro.sh. Note that starting via systemctl produces no console logging; logs are written to /log/red5.log.

```bash
#!/bin/bash  

sudo systemctl start red5pro  

tail -f /usr/local/red5pro/log/red5.log  

```

--------------------------------

### stopStreamRecord Example Request

Source: https://www.red5.net/docs/red5-pro/development/api/server/red5-pro-server-streams-api

A concrete example of a GET request to stop recording for a specific stream.

```http
http://localhost:5080/api/v1/applications/live/streams/stream1/action/stoprecord?accessToken=xyz123
```

--------------------------------

### Navigate to installation directory

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/archive/auto-aws-wav/ubuntuinstall

Change to the directory where you want to run the Red5 Pro instance. The example uses /usr/local.

```bash
cd /usr/local  

```

--------------------------------

### Install NTP on the instance

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/archive/auto-aws/prepare-red5-pro-ami-for-nodes

Install NTP (network time protocol) to ensure the Stream Manager and all nodes are in sync. The service should start automatically once installed.

```bash
sudo apt-get install ntp
```

--------------------------------

### Navigate to Installation Directory

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/archive/jdk8-docs/ubuntuinstall-jdk8

Change the current working directory to /usr/local to prepare for the server installation.

```bash
cd /usr/local
```

--------------------------------

### Install CMake via Homebrew

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/red5-core-sdk-mac

Installs CMake using Homebrew, required for generating build files for the examples.

```bash
brew install cmake
```

--------------------------------

### Install GCC via Homebrew

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/red5-core-sdk-mac

Installs the GCC compiler using Homebrew, a prerequisite for building the SDK examples.

```bash
brew install gcc
```

--------------------------------

### Publisher example using R5Stream

Source: https://www.red5.net/docs/red5-pro/resources/migration-guides/wowza-to-red5-pro-migration-guide/wowza-to-red5-pro-sdk-migration-guide

Java code showing how to set up a publisher with R5Configuration, R5Connection, R5Stream, attach camera and microphone, and publish to a live stream. Requires a valid license key and camera access method.

```Java
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {  

    View rootView = inflater.inflate(R.layout.publish_test, container, false);  

    preview = (R5VideoView)rootView.findViewById(R.id.videoView);  

    publish();  

  

    return rootView;  

}  

  

protected void publish() {  

    String b = getActivity().getPackageName();  

    R5Configuration config = new R5Configuration(R5StreamProtocol.RTSP,  

            "your-red5-domain.com",  

            8554,  

            "live",  

            0.5);  

    config.setLicenseKey("YOUR_SDK_LICENSE_KEY");  

    config.setBundleID(b);  

  

    R5Connection connection = new R5Connection(config);  

    R5Stream publishStream = new R5Stream(connection);  

  

    Camera cam = openFrontFacingCameraGingerbread(); // Camera access method  

    R5Camera camera = new R5Camera(cam, 640, 480);  

    R5Microphone mic = new R5Microphone();  

  

    publishStream.attachCamera(camera);  

    publishStream.attachMic(mic);  

  

    preview.attachStream(publishStream);  

  

    publishStream.publish("mystream", R5Stream.RecordType.Live);  

}  


```

--------------------------------

### GET Request for Stream Metadata

Source: https://www.red5.net/docs/red5-pro/development/api/archive/rest-api-v-310/abr-json-schema

Example of a GET request to retrieve the provisioned stream metadata from the Stream Manager.

```http
https://yourstreammanager.com/streammanager/api/3.1/admin/event/meta/live/mystream?accessToken=myaccessToken
```

--------------------------------

### Run the installer

Source: https://www.red5.net/docs/red5-pro/users-guide/installation/red5pro-installer

Execute the main installer script to launch the interactive menu.

```bash
sudo ./red5proInstaller.sh
```

--------------------------------

### Subscriber example using R5Stream

Source: https://www.red5.net/docs/red5-pro/resources/migration-guides/wowza-to-red5-pro-migration-guide/wowza-to-red5-pro-sdk-migration-guide

Java code showing how to set up a subscriber with R5Configuration, R5Connection, R5Stream, configure audio controller, and play a live stream. Requires a valid license key.

```Java
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {  

    View rootView = inflater.inflate(R.layout.publish_test, container, false);  

    preview = (R5VideoView)rootView.findViewById(R.id.videoView);  

    subscribe();  

  

    return rootView;  

}  

  

protected void subscribe() {  

    String b = getActivity().getPackageName();  

    R5Configuration config = new R5Configuration(R5StreamProtocol.RTSP,  

            "your-red5-domain.com",  

            8554,  

            "live",  

            0.5);  

    config.setLicenseKey("YOUR_SDK_LICENSE_KEY");  

    config.setBundleID(b);  

  

    R5Connection connection = new R5Connection(config);  

    R5Stream subscriberStream = new R5Stream(connection);  

    subscriberStream.audioController = new R5AudioController();  

    subscriberStream.audioController.sampleRate = 44100;  

  

    preview.attachStream(subscriberStream);  

  

    subscriberStream.play("mystream", true);  

}  


```

--------------------------------

### Get all Scheduled Events Example Response

Source: https://www.red5.net/docs/red5-pro/development/api/archive/rest-api-v-310/smapi-events

A concrete example of a successful 200 OK response for a scheduled event.

```json
[

    {

        "id": 4,

        "eventName": "auction",

        "date": "1537795840000",

        "data": {

            "launchConfig": "default",

            "scalePolicy": "auction",

            "region": [

                {

                    "name": "us-east-1",

                    "info": {

                        "minSubscribers": "15",

                        "minPublishers": "15",

                        "maxPublishers": "20",

                        "maxSubscribers": "20"

                    }

                }

            ]

        },

        "state": "pending"

    }

]
```

--------------------------------

### Create build files with cmake

Source: https://www.red5.net/docs/red5-pro/development/sdks/red5-core-sdk/examples/red5-core-sdk-examples-overview

Navigate to the examples directory and run cmake to generate build files.

```bash
cd ~/Red5Core/<distribution>/examples

cmake .
```

--------------------------------

### Restreamer Provision Example

Source: https://www.red5.net/docs/red5-pro/development/api/stream-manager-2.0/stream-manager-2-streams-provision-api

Example provision for a restreamer that creates an IP camera stream. It specifies the provision GUID, stream GUID, ABR level 0, and camera parameters including host, port, and remote stream details.

```json
{

  "provisionGuid": "restreamer1",

  "streams": [

	{

	  "streamGuid": "live/test1",

	  "abrLevel": 0,

	  "camParams": {

		"properties": {

			"type": "ipcam",

			"action": "create",

			"remoteContextPath": "axis-media",

			"remoteStreamName": "media.amp",

			"host": "192.168.1.10",

			"port": 5443

		}

	  }

	}

  ]

}
```

--------------------------------

### Example .env file configuration for LINODE

Source: https://www.red5.net/docs/red5-pro/users-guide/stream-manager-2-0/installation/linode/red5-pro-sm2-linode-create-stream-manager-instance

Example .env file with all variables set for a Linode deployment.

```bash
R5AS_AUTH_SECRET=12345abcd  
R5AS_AUTH_USER=admin  
R5AS_AUTH_PASS=password  
R5AS_PROXY_USER=proxy_user  
R5AS_PROXY_PASS=proxy_password  
R5AS_CLOUD_PLATFORM_TYPE=LINODE  
KAFKA_HOST=10.0.0.1  
TRAEFIK_HOST=red5pro-sm2.example.com  
TRAEFIK_SSL_EMAIL=email@example.com  
R5P_LICENSE_KEY=1111-2222-3333-4444  
LINODE_API_TOKEN=example123xyz456token789  
LINODE_SSH_KEY_NAME=example-ssh-key-name  
```
Tokens:
Raw