Presentation

Presentation mode gives one participant the whole Eyeson One View stream. Use it to build screen sharing or file sharing into your application.

Activate presentation mode

Whenever a participant starts a presentation, the Eyeson One View stream switches to SFU mode. The presenter's video is set to full screen and forwarded to all other participants as efficiently as possible. While the presentation runs, all other participants are in audio-only mode.

The request has no body. Use the access_key of the participant who presents.

POST /rooms/`ACCESS_KEY`/presentation
RESPONSES 200 OK, 201 CREATED, 409 CONFLICT, 404 NOT FOUND, 401 UNAUTHORIZED

Req/Res Example: Start presenting

export ACCESS_KEY=...
curl -X POST "https://api.eyeson.team/rooms/$ACCESS_KEY/presentation"

Response

201 Created

caution

Only one presentation can run at a time. If another participant sends the same POST request with their access_key, a 409 CONFLICT is returned. The current presentation has to end before another participant can start one.

info

This endpoint only puts the presenter's video source into a single, full-screen layout. To share a screen, replace the presenter's video track on the client, for example with the Screen Capture API (getDisplayMedia()).

End presentation mode

Any participant can end the presentation with a DELETE request using their own access_key. It does not have to be the participant who started it.

DELETE /rooms/`ACCESS_KEY`/presentation
RESPONSES 200 OK, 404 NOT FOUND, 401 UNAUTHORIZED

Req/Res Example: End presenting

export ACCESS_KEY=...
curl -X DELETE "https://api.eyeson.team/rooms/$ACCESS_KEY/presentation"

Response

200 OK

Every start and end triggers a presentation_update event in the Meeting Observer.