Mercurial > libervia-desktop-kivy

comparison doc/calls.rst @ 508:d87b9a6b0b69

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (calls): updated documentation to describe the new UI features: fix 425
author Goffi <goffi@goffi.org>
date Wed, 25 Oct 2023 15:29:33 +0200
parents 4d45bed01183
children 290b405940b5
comparison
equal deleted inserted replaced
507:f6b8300e8234 508:d87b9a6b0b69
1 ================= 1 =================
2 Audio/Video Calls 2 Audio/Video Calls
3 ================= 3 =================
4 4
5 Libervia's Kivy desktop application offers a one-to-one audio and video call feature. This guide provides a step-by-step approach to utilizing this functionality. 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.
6 6
7 Accessing the Call Feature 7 Accessing the Call Feature
8 -------------------------- 8 --------------------------
9 9
10 1. Navigate to the main menu. 10 1. Navigate to the main menu.
11 2. Look for the widget with a phone icon and select it to access the "Call" feature. 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.
12 12
13 Initiating a Call 13 Initiating a Call
14 ----------------- 14 -----------------
15 15
16 When you're in the "Call" widget: 16 Upon accessing the call feature, you are presented with the "search" UI:
17 17
18 1. You will notice a search bar located at the top. 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.
19 2. To make a call: 19 2. Below, contact icons are displayed. These icons get filtered based on the terms you enter in the search bar.
20 3. To initiate a call:
20 21
21 a. Type the full address (similar to an email address) of the person you wish to call into the search bar. 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]``.
22 b. Click the "Call" button situated next to the search bar to initiate the call. 23 b. Alternatively, click on a contact icon at the bottom of the screen to call directly.
23
24 *Note:* As development progresses, the interface may provide more intuitive ways to initiate calls.
25 24
26 Receiving a Call 25 Receiving a Call
27 ---------------- 26 ----------------
28 27
29 *For the time being, ensure you are in the "Call" widget to receive an incoming call. This will change in upcoming versions.* 28 When someone calls you:
30 29
31 Upon receiving a call: 30 1. A ringtone will play.
32 31 2. A desktop notification displays the caller's details.
33 1. The call is automatically accepted. 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.
34 2. If it's a video call, you will see the video of the person calling. Additionally, a smaller video feed in the bottom right corner shows what you are transmitting.
35 33
36 During a Call 34 During a Call
37 ------------- 35 -------------
38 36
39 While you are on a call: 37 Once the call begins, the interface shifts to the "call" UI:
40 38
41 1. **End Call:** To conclude the call, you can click the "Hang Up" button 39 1. The main portion of the screen displays the caller's video feed.
40 2. Your own video feed appears in the bottom right corner.
41 3. On the top right:
42 42
43 Security and Privacy Aspects of Calls 43 - An icon lets you toggle between fullscreen and the regular view.
44 -------------------------------------
45 44
46 It's crucial to stay aware of what information you share and prioritize your privacy: 45 4. Below the video feeds, three buttons are available:
46
47 a. Mute/unmute video: When muted, the video icon turns yellow with a red strike-through.
48 b. Mute/unmute audio: When muted, the audio icon turns yellow with a red strike-through.
49 c. Hang Up: A red phone icon in a horizontal direction to end the call.
50
51 Fullscreen Mode
52 ---------------
53
54 While in fullscreen:
55
56 1. Click on the same icon in the top right corner to revert to the standard view.
57 2. The "Hang Up" button allows you to end the call and return to the regular view.
58 3. Use the shortcut ``Alt+n`` to toggle the notification bar on or off. By default, it's hidden.
59
60 Security Considerations for Calls
61 ---------------------------------
62
63 When using Libervia's call feature, prioritize your privacy and safety:
47 64
48 **1. Sharing Your "Online Presence" and Address:** 65 **1. Sharing Your "Online Presence" and Address:**
49 66
50 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. 67 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.
51 68
53 70
54 Although it's common to share this information with trusted contacts, unfamiliar users may infer your activity patterns and general vicinity. 71 Although it's common to share this information with trusted contacts, unfamiliar users may infer your activity patterns and general vicinity.
55 72
56 **3. Safety Recommendations:** 73 **3. Safety Recommendations:**
57 74
58 - **Be Selective:** Make or accept calls only with those you trust. 75 - **Be Selective:** Only make or receive calls from trusted individuals.
59 - **Network Usage:** Though designed to function anywhere, remember that public networks (like those in coffee shops or hotels) might be less secure. 76 - **Network Usage:** Though designed to function anywhere, remember that public networks (like those in coffee shops or hotels) might be less secure.
60 - **Stay Informed:** For any queries or concerns, join our community chat room. You can find it at the provided link on our website. 77 - **Stay Informed:** For any queries or concerns, join our community chat room. You can find it at the provided link on our website.
61 78
62 Remember to stay vigilant and make informed decisions while using the call feature. Regularly check for updates, as we continually work to enhance your experience. 79 Remember to stay vigilant and make informed decisions while using the call feature. Regularly check for updates, as we continually work to enhance your experience.