annotate doc/user/calls.rst @ 1554:1dc23ba67f47

doc (user/calls): add screen sharing documentation: fix 432
author Goffi <goffi@goffi.org>
date Mon, 14 Aug 2023 16:54:13 +0200
parents 4b0464b2a12b
children 0796bb8bad2f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1550
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 =================
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 Audio/Video Calls
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 =================
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
4
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 Libervia provides the capability for one-to-one audio and video calls. This section will guide you on how to use this feature effectively.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 Accessing the Call Feature
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 --------------------------
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
9
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 1. Navigate to the main menu.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 2. Select the "Calls" option.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
12
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 Initiating a Call
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 -----------------
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 Upon entering the "Calls" page:
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 1. An interface will display a search box at the top and a list of your contacts below.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 2. To the right of the search box, there is a button labeled "Video Call," indicating that both audio and video will be enabled for the call.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 3. To make an audio-only call, click the adjacent icon. The "Video Call" button will change to "Audio Call."
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 4. To start a call:
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 a. Enter a full JID into the search box, then click on either "Audio Call" or "Video Call."
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 b. Alternatively, directly click on a contact's name to initiate a call with them.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
24
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 *Note:* The search box functions as expected – inputting a portion of a contact's name or the group they belong to will filter the displayed contacts.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
26
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 Receiving a Call
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 ----------------
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 *Currently, you must be on the "Calls" page to receive an incoming call. This limitation will be addressed in future updates.*
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
31
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 Upon receiving a call:
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
33
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 1. An audible ring will sound.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 2. A dialog box will appear, prompting you to either **Answer** or **Reject** the incoming call.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 3. If you choose to answer and it's a video call, the call interface will display both the caller's video feed and your video in the bottom right corner. For audio-only calls, no video feeds will be shown.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
37
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 During a Call
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 -------------
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
40
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 The call interface offers the following features:
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
42
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 1. **Fullscreen Mode:** The top right button allows you to expand the video feeds to cover the entire screen.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 2. **Mute Options:** Two buttons at the bottom of the interface enable you to mute your audio or video.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 - Muted audio: The audio icon will turn yellow with a red strike-through, indicating that your audio is off and the other party cannot hear you.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 - Muted video: The video icon will turn yellow with a red strike-through, signaling that your video is off and the other party cannot see you.
1554
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
47 3. **Screen Sharing (Desktop Only):** Next to the mute buttons is a desktop icon. By default, it is green and crossed out, indicating no screen sharing.
1550
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
48
1554
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
49 - Click the icon to share your desktop or a specific window. The browser will prompt you to choose what you want to share.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
50 - Once sharing, the icon turns red and the cross disappears, replacing the camera stream with your desktop or selected window.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
51 - Click the icon again or use the browser dialog to stop sharing and revert to the camera stream.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
52 4. **End Call:** Click the "Hang Up" button to conclude the call.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
53
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
54 *Note:* The screen sharing feature is available only on desktop versions of browsers that support the functionality.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
55
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
56 Security Considerations for Calls and Screen Sharing
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
57 ----------------------------------------------------
1550
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
58
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
59 When using Libervia's call feature, it's essential to consider certain privacy aspects:
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
60
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
61 **1. Sharing Your "Online Presence" and Address:**
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
62
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
63 Making or receiving a call not only shares your device's unique online address (similar to a unique phone number) but also informs others that you're currently online. This means people can see when you're active, much like noticing you're home when the lights are on.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
64
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
65 **2. Privacy Implications:**
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
66
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
67 This information is standard when chatting with trusted contacts. However, with unfamiliar individuals, it might slightly reveal your activity pattern and general location.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
68
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
69 **3. Safety Recommendations:**
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
70
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
71 - **Be Selective:** Only initiate or accept calls from people you trust.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
72 - **Network Usage:** While the call feature is designed for use anywhere, including public networks like in restaurants or hotels, be mindful that unfamiliar networks might be less secure.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
73 - **Stay Informed:** If you have questions or concerns, you can join our community chat room for guidance. Visit `Libervia's Chat Room <xmpp:libervia@chat.jabberfr.org?join>`_.
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
74
1554
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
75 **4. Screen Sharing Implications:**
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
76
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
77 Sharing your desktop or a specific window offers another layer of accessibility to the person on the other side of the call. This means they can see everything displayed on the chosen screen, including personal files, notifications, and other sensitive information that might be accidentally displayed.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
78
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
79 **5. Safety Recommendations for Screen Sharing:**
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
80
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
81 - **Review Before Sharing:** Before starting a screen sharing session, close any unrelated applications or windows. Ensure no sensitive information, like passwords, private messages, or confidential documents, is visible.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
82 - **Stay Aware:** During a screen sharing session, remember that everything on your screen is visible to the other party. Avoid accessing personal files or confidential information.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
83 - **Use With Trusted Contacts:** As with audio and video calls, only use the screen sharing feature with individuals or groups you trust.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
84 - **Understand Browser Permissions:** The browser will typically ask you which screen, application, or window you'd like to share. Ensure you're only sharing what's intended. If in doubt, choose to share a specific application or window rather than the entire screen.
1dc23ba67f47 doc (user/calls): add screen sharing documentation:
Goffi <goffi@goffi.org>
parents: 1550
diff changeset
85
1550
4b0464b2a12b doc: add end-user A/V calls documentation:
Goffi <goffi@goffi.org>
parents:
diff changeset
86 Always prioritize your privacy and be aware of the information you share while using the call feature.