Skip to main content

Forward participant or MCU stream

Any active meeting participant's stream can be forwarded or even the MCU One View stream.

The forward stream feature can only be activated with the API key.

danger

The API URL must contain the ROOM_ID in contrast to ACCESS_KEY in other API calls. forward_id MUST be unique for each forward!

The same source can be forwarded multiple times, but each must have its own forward_id.

warning

As soon as the source is disconnected, its forward will automatically stop.

For participants, you can use the Observer's participant_update event.

For playbacks, you can use the Observer's playback_update event.

Forward source​

POST /rooms/<ROOM_ID>/forward/source
HEADERS Authorization
RESPONSES 201 CREATED, 400 BAD REQUEST, 401 UNAUTHORIZED, 404 NOT FOUND

forward_id​

Type: String (required)

user_id​

Type: String (required)

type​

Type: Stringor Array<String> (required)
valid values: "audio", "video", "audio,video"

url​

Type: URL (required)

Example:

curl -X POST \
  -H "Authorization: <API_KEY>" \
  -d "forward_id=<FORWARD_ID>" \
  -d "user_id=<USER_ID>" \
  -d "type=audio,video" \
  -d "url=https://example.com/whip" \
  https://api.eyeson.team/rooms/<ROOM_ID>/forward/source

curl -X POST \
  -H "Authorization:  myeyesonapikey"\
  -d "forward_id=myforward1" \
  -d "user_id=63ede350b20526000f64376d" \
  -d "type=audio,video" \
  -d "url=https://example.com/whip" \
  https://api.eyeson.team/rooms/63ede57ff3e015000fbe1af5/forward/source

Forward MCU One View​

POST /rooms/<ROOM_ID>/forward/mcu
HEADERS Authorization
RESPONSES 201 CREATED, 400 BAD REQUEST, 401 UNAUTHORIZED, 404 NOT FOUND

forward_id​

Type: String (required)

type​

Type: Stringor Array<String> (required)
valid values: "audio", "video", "audio,video"

url​

Type: URL (required)

Forward playback​

POST /rooms/<ROOM_ID>/forward/playback
HEADERS Authorization
RESPONSES 201 CREATED, 400 BAD REQUEST, 401 UNAUTHORIZED, 404 NOT FOUND

forward_id​

Type: String (required)

play_id​

Type: String (required)

type​

Type: Stringor Array<String> (required)
valid values: "audio", "video", "audio,video"

url​

Type: URL (required)

End forward​

DELETE /rooms/<ROOM_ID>/forward/<FORWARD_ID>
HEADERS Authorization
RESPONSES 200 OK, 400 BAD REQUEST, 401 UNAUTHORIZED, 404 NOT FOUND

Example:

curl -X DELETE \
  -H "Authorization: <API_KEY>" \
  https://api.eyeson.team/rooms/<ROOM_ID>/forward/<FORWARD_ID>

curl -X DELETE \
  -H "Authorization: myeyesonapikey" \
  https://api.eyeson.team/rooms/63ede57ff3e015000fbe1af5/forward/myforward1