Skip to content

Commit 82eb0d2

Browse files
committed
Update readme for version 0.3.0
1 parent e032f63 commit 82eb0d2

File tree

13 files changed

+29
-26
lines changed

13 files changed

+29
-26
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,29 @@ Rooms are where the videoconference/classes will take place. For each room there
2525

2626
Here we see the login process. Just a username and a password are needed. After the login we see the dashboard containing all the rooms the user is in, and the role they have in them.
2727
![Login](/documentation/images/login.gif)
28-
In this animation we see how moderators get either of the invite links from the dashboard. Then they would have to share this link to give other users access to the room. Once they have gained access they don't need to use this link again. Each link would grant a different role to those who use it: moderator or participant.
28+
In this animation we see how moderators get either of the invite links from the dashboard. Then they would have to share this link to give other users access to the room. Once they have gained access they don't need to use this link again. Each link would grant a different role to those who use it: moderator, presenter or participant.
2929
![Invite links from dashboard](/documentation/images/inviteDashboard.gif)
3030
Now we see how admins can create new rooms. Only the name of the room is needed. After it is created, the user navigates to it and is made a moderator (and the only user in it for now, obviously). Before entering the actual room we see a dialog that lets as choose the input camera, microphone, screenshare and avatar.
3131
![Create room](/documentation/images/createRoom.gif)
32-
Moderators can also get the invite links from the toolbar in the room itself. In the gif we can also see the other buttons in the toolbar (the same as in OpenViduCall + the raise hand button).
32+
Moderators can also get the invite links from the settings component in the room itself.
3333
![Invite links from room](/documentation/images/inviteRoom.gif)
3434
Here we can see where new users go when using the invite link. They have the option to either login if they already have an account or create a new one as shown. Then we see that, because the invite link was a participant one the user cannot send video or audio stream (and therefore cannot choose a mic or cam) and can only see the moderator's video.
3535
![Invite](/documentation/images/invite.gif)
3636
At the top right corner the user can open the menu, which contains:
3737
* The chat for all the assistants of the room.
3838
* The chat for moderators (only if the user is a moderator).
39-
* A list of all the assistants of the room, their roles and whether they are connected at the moment or not.
39+
* A list of all the assistants of the room, their roles and whether they are connected at the moment or not.
40+
* The settings where moderators can get the invite links and start/stop recordings.
4041
![Menu](/documentation/images/menu.gif)
4142
In the next gif we see the button that makes the user raise their hand. The button displays a number of the position in the queue of people who are raising their hand. Then we see the actual popup. Moderators can lower the hand of other people. If there are multiple people with their hand raised only the name of the first one is displayed (hence the queue).
4243
![Raise hand button](/documentation/images/raiseHand.gif)
4344
![Raise hand popup](/documentation/images/raiseHandPopup.gif)
4445
Now we can see the other two kinds of popups: a user who just connected/disconnected and a new chat message.
4546
![Popups](/documentation/images/popups.gif)
47+
In the next gif we can see how moderators can start and stop a recording.
48+
![Recording](/documentation/images/recording.gif)
49+
In the last gif we can see how to access the previous recordings of a room. It can only be done from the dashboard, or with the URL {roomName}/video/{videoId}
50+
![Video](/documentation/images/video.gif)
4651

4752

4853
## Project Roadmap ##
@@ -56,8 +61,8 @@ Now we can see the other two kinds of popups: a user who just connected/disconne
5661
* When a user joins or leaves the session and chat messages
5762
- [X] Ability to "raise the hand"
5863
* Pop up to get the moderator's attention
59-
- [ ] Basic session recording
60-
* Video only recordings
64+
- [X] Basic session recording
65+
* Video only recordings with composed layout
6166
- [ ] Full fledged session recording including chat
6267
* Chat messages will be displayed at the time they were posted, with links to the time offset in the video player
6368
- [ ] Document sharing/presentation
@@ -66,10 +71,11 @@ Now we can see the other two kinds of popups: a user who just connected/disconne
6671
- [ ] Polls/quizzes
6772
- [ ] Mood/status sharing
6873
* Users may display their mood for a brief time
74+
6975
Note that this roadmap may change throughout development.
7076

7177
## Development & Installation ##
7278

73-
For information on how to get the the app working [CLICK HERE](/documentation/deploy.md).\
79+
For information on how to deploy the app [CLICK HERE](/documentation/deploy.md).\
7480
For information on how to develop the app [CLICK HERE](/documentation/development.md).\
7581
For information on the REST API [CLICK HERE](/documentation/api.md).

documentation/api.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -621,26 +621,23 @@ Get the info of the recordings of a room.
621621
Password: pass
622622
- **Response**:
623623
~~~~ json
624-
{
625-
"count": 1,
626-
"items": [
627-
{
628-
"id": "roomA-2",
629-
"sessionId": "room",
630-
"name": "roomA-2",
631-
"outputMode": "COMPOSED",
632-
"hasAudio": true,
633-
"hasVideo": true,
634-
"recordingLayout": "BEST_FIT",
635-
"resolution": "1920x1080",
636-
"createdAt": 1521202349460,
637-
"size": 22887561,
638-
"duration": 132.08,
639-
"url": "https://localhost:4443/recordings/roomA-2/roomA-2.mp4",
640-
"status": "available"
641-
}
642-
]
643-
}
624+
[
625+
{
626+
"id": "roomA-2",
627+
"sessionId": "roomA",
628+
"name": "roomA-2",
629+
"outputMode": "COMPOSED",
630+
"hasAudio": true,
631+
"hasVideo": true,
632+
"recordingLayout": "BEST_FIT",
633+
"resolution": "1920x1080",
634+
"createdAt": 1521202349460,
635+
"size": 22887561,
636+
"duration": 132.08,
637+
"url": "https://localhost:4443/recordings/roomA-2/roomA-2.mp4",
638+
"status": "available"
639+
}
640+
]
644641
~~~~
645642

646643
### Get video ###
998 KB
Loading

documentation/images/invite.gif

1.77 MB
Loading
101 KB
Loading
-2.59 MB
Loading

documentation/images/login.gif

-3.08 MB
Loading

documentation/images/menu.gif

-5.09 MB
Loading

documentation/images/popups.gif

56.4 KB
Loading

documentation/images/raiseHand.gif

27.5 KB
Loading

0 commit comments

Comments
 (0)