Service: Symphony Media Bridge WHIP Gateway - EyevinnOSC/community GitHub Wiki

Getting Started

The Symphony Media Bridge (SMB) is a media server application that handles audio, video and screen sharing media streams in an RTC conference system. The SMB WHIP Gateway provides a WHIP endpoint for a Symphony Media Bridge and enables any WHIP compatible media client to push video to a Symphony Media Bridge. This tutorial walks you through how to setup this WHIP endpoint in Open Source Cloud.

Prerequisites

  • If you have not already done so, sign up for an OSC account.
  • A Symphony Media Bridge instance running

Step 1: Setup secrets

Create three service secrets in the Symphony Media Bridge WHIP gateway service in the OSC web user interface.

  • smburl=https://my-smb.example.org/
  • smbapikey=mysecret
  • apikey=guide

Step 2: Create gateway

Click on the button "Create gateway" in the web user interface.

Skärmavbild 2024-08-15 kl  19 50 36

Then enter the following values in the create instance dialog.

Skärmavbild 2024-08-15 kl  19 52 39

Press the button Create and wait for the instance to be in status Running.

Skärmavbild 2024-08-15 kl  19 53 24

Copy to clipboard the URL to the instance.

Step 3: Send media

Now that we have a WHIP endpoint up and running we can use a WHIP compatible client to send media to Symphony Media Bridge. An example of a web browser based WHIP client is available at https://web.whip.eyevinn.technology/ that we can use.

Enter the address https://demo-guide.eyevinn-smb-whip-bridge.auto.prod.osaas.io/api/v2/whip/sfu-broadcaster as WHIP URL in the client. Replace demo with the name of your tenant. Enter the api-key guide that we chosen in the Authorization field.

Skärmavbild 2024-08-15 kl  20 00 28

Then press the button Camera and you will receive a WHIP resource URL if everything is correctly working.

Skärmavbild 2024-08-15 kl  20 01 04

Now you are sending media to your Symphony Media Bridge and a new conference with an endpoint with id ingest should have been created.