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

Symphony Media Bridge WHEP Gateway

Symphony Media Bridge WHEP Gateway (serviceId eyevinn-wrtc-egress) provides a WHEP (WebRTC-HTTP Egress Protocol) endpoint that lets any WHEP-compatible player pull a video stream out of a Symphony Media Bridge (SMB) conference. SMB is a media server that handles audio, video and screen sharing streams in an RTC conference system. In Eyevinn Open Source Cloud (OSC) the gateway is a long-running service instance. It is the egress counterpart to the Symphony Media Bridge WHIP Gateway. License: MIT. Source: Eyevinn/wrtc-egress.

What it can do

  • Expose a WHEP endpoint for conference streams in a Symphony Media Bridge instance.
  • Let standard WHEP players subscribe to those streams.

Creating an instance

Create a Symphony Media Bridge instance (eyevinn-docker-wrtc-sfu) first and confirm it is running. Read its URL with describe-service-instance and note its API key if it requires authentication. If the key is sensitive, store it with create-service-secret (serviceId: "eyevinn-wrtc-egress") and pass it as {{secrets.NAME}}.

Then call create-service-instance with serviceId: "eyevinn-wrtc-egress":

{
  "name": "myegress",
  "SmbUrl": "https://mysmb.eyevinn-docker-wrtc-sfu.auto.prod-se.osaas.io",
  "SmbApiKey": "{{secrets.smbkey}}"
}

Verify with wait-for-service-ready or get-instance-status. The instance URL is the base URL of your WHEP endpoints. With the OSC CLI:

npx -y @osaas/cli create eyevinn-wrtc-egress myegress \
  -o SmbUrl="https://mysmb.eyevinn-docker-wrtc-sfu.auto.prod-se.osaas.io"

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/word characters only (^\w+$), at most 20 characters.
SmbUrl Yes string URL of the Symphony Media Bridge instance to pull streams from. The catalog associates it with eyevinn-docker-wrtc-sfu.
SmbApiKey No string, sensitive API key of the Symphony Media Bridge instance, needed if that instance requires authentication.

A {{secrets.NAME}} reference must be the whole field value.

Using the instance

Any WHEP-compatible player can subscribe to a conference stream. The WHEP endpoint URL follows this pattern:

https://myegress.eyevinn-wrtc-egress.auto.prod-se.osaas.io/api/v2/whep/<endpoint-id>

Replace myegress with your instance name and <endpoint-id> with the conference endpoint ID from your Symphony Media Bridge. Test playback with a WHEP player such as web.whep.eyevinn.technology.

Resources