Mercurial > libervia-desktop-kivy

annotate doc/calls.rst @ 513:0fdf3e59aaad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (calls): update doc for Wayland implementation: fix 434
author Goffi <goffi@goffi.org>
date Thu, 18 Jan 2024 23:46:31 +0100
parents 290b405940b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 =================
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 Audio/Video Calls
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 =================
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
4
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
5 Libervia's Kivy desktop application provides the capability for one-to-one audio and video calls. This guide provides a step-by-step approach to utilizing this functionality.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 Accessing the Call Feature
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 --------------------------
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
9
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 1. Navigate to the main menu.
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
11 2. Click on the phone icon labeled "Calls" or, alternatively, select the phone icon in the "widget selection" zone, situated on the top left corner.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
12
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 Initiating a Call
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 -----------------
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
16 Upon accessing the call feature, you are presented with the "search" UI:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
18 1. A search bar is available at the top for entering the full JID (akin to an email address) of the person you wish to call.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
19 2. Below, contact icons are displayed. These icons get filtered based on the terms you enter in the search bar.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
20 3. To initiate a call:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
22 a. Type the full JID of the person you wish to call into the search bar and click the "Call" button or press ``[ENTER]``.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
23 b. Alternatively, click on a contact icon at the bottom of the screen to call directly.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
24
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 Receiving a Call
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 ----------------
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
27
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
28 When someone calls you:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
30 1. A ringtone will play.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
31 2. A desktop notification displays the caller's details.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
32 3. In the header zone, a dialog with the right "bird head" icon appears. Click on this icon and choose "yes" to accept the call or "no" to decline.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
33
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 During a Call
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 -------------
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
36
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
37 Once the call begins, the interface shifts to the "call" UI:
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
38
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
39 1. The main portion of the screen displays the caller's video feed.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
40 2. Your own video feed appears in the bottom right corner.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
41 3. On the top right:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
42
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
43 - An icon lets you toggle between fullscreen and the regular view.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
44
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
45 4. Below the video feeds, four buttons are available:
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
46
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
47 a. Mute/unmute video: When muted, the video icon turns yellow with a red strike-through.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
48 b. Mute/unmute audio: When muted, the audio icon turns yellow with a red strike-through.
513
0fdf3e59aaad doc (calls): update doc for Wayland implementation:
Goffi <goffi@goffi.org>
parents: 511
diff changeset
49 c. Desktop Sharing: A desktop icon to initiate screen sharing. By default, the icon is green with a strike-through, indicating no screen sharing. For X11 systems, clicking this icon opens a popup to select either full screen or a specific window for sharing. In Wayland systems, instead of a popup, a screen sharing selection window (provided by the system's desktop environment) will be used to choose the monitor or window for sharing. Once sharing, the icon turns red and the strike-through disappears. Click again to stop sharing.
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
50 d. Hang Up: A red phone icon in a horizontal direction to end the call.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
51
513
0fdf3e59aaad doc (calls): update doc for Wayland implementation:
Goffi <goffi@goffi.org>
parents: 511
diff changeset
52 .. note::
0fdf3e59aaad doc (calls): update doc for Wayland implementation:
Goffi <goffi@goffi.org>
parents: 511
diff changeset
53
0fdf3e59aaad doc (calls): update doc for Wayland implementation:
Goffi <goffi@goffi.org>
parents: 511
diff changeset
54 For desktop sharing to work, your computer needs additional software: ``xdg-desktop-portal`` and a desktop-specific companion package (like ``xdg-desktop-portal-gtk`` for GNOME or ``xdg-desktop-portal-kde`` for KDE). These programs are usually provided through your operating system's software library. Check your system's help resources for guidance on installing these packages.
0fdf3e59aaad doc (calls): update doc for Wayland implementation:
Goffi <goffi@goffi.org>
parents: 511
diff changeset
55
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
56 Fullscreen Mode
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
57 ---------------
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
58
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
59 While in fullscreen:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
60
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
61 1. Click on the same icon in the top right corner to revert to the standard view.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
62 2. The "Hang Up" button allows you to end the call and return to the regular view.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
63 3. Use the shortcut ``Alt+n`` to toggle the notification bar on or off. By default, it's hidden.
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
64
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
65 Security Considerations for Calls and Desktop Sharing
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
66 -----------------------------------------------------
508
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
67
d87b9a6b0b69 doc (calls): updated documentation to describe the new UI features:
Goffi <goffi@goffi.org>
parents: 502
diff changeset
68 When using Libervia's call feature, prioritize your privacy and safety:
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
69
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
70 **1. Sharing Your "Online Presence" and Address:**
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
71
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
72 Engaging in a call shares your unique online address (akin to a phone number), indicating you're online and active. It's like turning the lights on at home, letting others know you're present.
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
73
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
74 **2. Privacy Implications:**
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
75
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
76 Although it's common to share this information with trusted contacts, unfamiliar users may infer your activity patterns and general vicinity.
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
77
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
78 **3. Screen Sharing Considerations:**
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
79
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
80 Sharing your desktop or a specific window during a call allows the other party to see everything on that screen. Be mindful of any sensitive information displayed.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
81
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
82 **4. Safety Recommendations:**
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
83
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
84 - **Be Selective:** Only make or receive calls and share your screen with trusted individuals.
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
85 - **Review Before Sharing:** Ensure no sensitive information is visible on your screen before initiating screen sharing.
502
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
86 - **Network Usage:** Though designed to function anywhere, remember that public networks (like those in coffee shops or hotels) might be less secure.
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
87 - **Stay Informed:** For any queries or concerns, join our community chat room. You can find it at the provided link on our website.
4d45bed01183 doc: add forgotten file:
Goffi <goffi@goffi.org>
parents:
diff changeset
88
511
290b405940b5 doc (calls): add desktop sharing documentation:
Goffi <goffi@goffi.org>
parents: 508
diff changeset
89 Remember to stay vigilant and make informed decisions while using the call and screen sharing features. Regularly check for updates, as we continually work to enhance your experience.