(Doc) agora.io integration: core

[RemyMess]

A. Summary: We want agora administrators and speakers to be able to stream their seminars on agora.stream. Here, we will only implement the core functionalities.

---

B. Full vision? Here is an overview on how we envision the full thing on the long term. (Note: our first version is not going to have all of that! I wrote this section so that you know where we are going)

1. How will it be for the agora administrator?

   • When creating an event, the admnistrator will be proposed 2 options: (1) using an external streaming tech (they will be asked to copy paste the videoconference URL of their event) (that is currently what we do) (2) host the streaming on agora.stream.
   • Before the seminar, the administrator will also have the option to generate a "speaker URL" than can be sent to the speaker; this speaker will not have to create an agora.stream account to be able to do his presentation.
   • During the seminar, the administrators will be able to do the following things: (1) speak and share their screen, (2) promote someone in the room to the rank of speaker (this person will have an augmented UI), (3) pass the mic to someone in the audience (this person will be able to speak + maybe video conference but thats it), (4) initiate/stop speaker introductions, initiate/stop seminar, initiate/stop q&a
   • The administrator will also be able to click on a button called "Thank the speaker" which will trigger the following event to all participant of the seminar: once triggered, they will have the option to press their space bar to generate a clap that will be broadcasted to the room. (only an administrator can trigger this).

2. How will it be for the allowed participant?

   • The event page (e.g. agora.stream/event/432) will redirect the allowed user to agora.stream/stream/432). (Note: this is not very secure to keep the ID in the url like that, so we will want to encrypt that string into something else) Knowing whether a user is allowed or not depends on which privacy the organiser set (some talks are for "members only" while others are accessible by "everybody").
   • During the talk, the participant will be able to chat to people, ask/upvote/downvote/answer questions and press his space bar to clap.
   • "Request the mic" if they want to speak.

3. How will it be for the speaker?

   • The speaker will join either using a speaker URL sent by an admin OR by requesting a promotion to the role of speaker when in the room (he will need to be logged in). Note: to start with, we focus on just having the speaker URL.

C. First version: Here are the core features we will have in version 1.

1. How will it be for the agora administrator?

   • When creating an event, the admnistrator will be proposed 2 options: (1) using an external streaming tech (they will be asked to copy paste the videoconference URL of their event) (that is currently what we do) (2) host the streaming on agora.stream.
   • The administrator will be able to generate a URL for the speaker that they will share with them before the event starts.
   • During the seminar, the administrators will be able to do the following things: (1) speak with webcam, (2) pass the mic to someone who has a question, (3) start/stop the seminar

2. How will it be for the allowed participant?

   • The event page (e.g. agora.stream/event/432) will redirect the allowed user to agora.stream/stream/432). Knowing whether a user is allowed or not depends on which privacy the organiser set (some talks are for "members only" while others are accessible by "everybody").
   • The participant will be able to chat in a general channel (no private messages)

3. How will it be for the speaker?

   • The speaker will receive a URL from the adminsitrators before the seminar. Joining via this URL instantlty sets him as a speaker.

   • The speaker will have a button to share his screen, enable/disable his webcam and/or microphone.

     D. Todos to have version 1: Frontend:

   • Add option in event creation for the agora administrator to use agora.stream streaming tech (just an alternative to the field "streaming URL")
   • Make the view page for the speaker (abilities: button: screen sharing, camera on/off, mic on/off, chat)
   • Make the view page for the administrator (abilities: button give mic, remove mic, start the streaming, stop the streaming, chat)
   • Make the view page for the participant (abilities: ask for mic, chat)
   • Add button "copy paste speaker URL" for administrators (they will be able to press this button next to the "edit talk" in the admin view in the agora)
   • Grid handling for multiple parallel streams

Backend:

• Encryption of the agora.stream streaming link done using following flag: "_agora.stream_tech"
• Logic for chats and streams ID (agora.io side) to be mapped with our event id internally.
• API to stop / start seminar for administrators (- Socket to keep track of the connected speaker) (- Request mic/pass the mic: using agora.io API)

[RemyMess]

D. Todos to have for version 2.0.1 Basically, goal is to make streaming work + a couple things Frontend:

• Latex in chat
• Button for chairman: "thank the speaker"
• Clapping overlay triggered when a chairman clicks on "Thank the speaker" (with firebase)

Backend:

• API to stop / start seminar for administrators
• Request mic/pass the mic integrated with firebase
• Follow up on logic on encryption of the agora.stream streaming link done using following flag: "_agora.stream_tech" (Remy will do this)
• Follow up on logic for chats and streams ID (agora.io side) to be mapped with our event id internally (Remy will do this)

[RemyMess]

D. Todos to have for version 2.0.2: Here is the minimal set of changes required for the streaming to be released.

Main changes:

• [x] Rework of the "pass the mic" feature: basically, add a table where admin sees who requested mic. Admin can pass the mic to the person and remove it from them. (Remove delay in mic passing) - Where will the table appear? What happens when admin ignore, or reject the request?
• [x] Talk landing page: everything arrives directly in the room with chat available for everybody 5mn before the start of the event but area where the streaming should appear would be replaced by "The admin is going to start the talk soon." if it hasnt started yet. - What will be visible on speaker's end?
• [x] Screensharing dimensions: we want the shared window to always be embedded in a larger frame (and not just a zoomed portion of it to be shared) How is it atm: Type of embedding we want (minus the right-hand rectangle with "Ray Mess" written in it. Note that we shared the same window as above)
• [x] Overlay when user enters the room ("What is your name?") + add his name in chat + when he requests mic. - How to fetch speaker's name?
• [x] "Stop" button opens an overlay "Are you sure? Doing so will redirect people to the Cafeteria." - You mentioned that admin should be able to restart the call in case he ends it by mistake, but I don't see it here
• [ ] Automatically stop the seminar 15mn after the end of the talk (When the scheduled end-time is reached, show an overlay "Event end time reached. The video-call will automatically end in 15 minutes." (chat message, in in green/blue visible).
• [ ] We want to allow admin to "Thank the speaker" more than once (maybe multiple talks within the same session).
• [ ] Add encodings of URLs in website (Remy will do this)

Small bugs/hotfix:

• [x] The speaker is for some reason unable to share his screen (button working for speaker but not admin)
• [x] Title and speaker does not show to the admin before the start (we want the data to be fetched before the admin clicks on start) (Remy will do this)
• [ ] Latex not rendered in chat (Remy will do this)
• [ ] Add button "Grab a coffee" for participants and speaker (appearing 5mn before the end of the talk) (Remy will do this)