changeset 508:d87b9a6b0b69

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 f6b8300e8234
children f0ce49b360c8
files doc/calls.rst
diffstat 1 files changed, 37 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/doc/calls.rst	Wed Oct 25 15:29:12 2023 +0200
+++ b/doc/calls.rst	Wed Oct 25 15:29:33 2023 +0200
@@ -2,48 +2,65 @@
 Audio/Video Calls
 =================
 
-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.
+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.
 
 Accessing the Call Feature
 --------------------------
 
 1. Navigate to the main menu.
-2. Look for the widget with a phone icon and select it to access the "Call" feature.
+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.
 
 Initiating a Call
 -----------------
 
-When you're in the "Call" widget:
-
-1. You will notice a search bar located at the top.
-2. To make a call:
+Upon accessing the call feature, you are presented with the "search" UI:
 
- a. Type the full address (similar to an email address) of the person you wish to call into the search bar.
- b. Click the "Call" button situated next to the search bar to initiate the call.
+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.
+2. Below, contact icons are displayed. These icons get filtered based on the terms you enter in the search bar.
+3. To initiate a call:
 
-*Note:* As development progresses, the interface may provide more intuitive ways to initiate calls.
+   a. Type the full JID of the person you wish to call into the search bar and click the "Call" button or press ``[ENTER]``.
+   b. Alternatively, click on a contact icon at the bottom of the screen to call directly.
 
 Receiving a Call
 ----------------
 
-*For the time being, ensure you are in the "Call" widget to receive an incoming call. This will change in upcoming versions.*
+When someone calls you:
 
-Upon receiving a call:
-
-1. The call is automatically accepted.
-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.
+1. A ringtone will play.
+2. A desktop notification displays the caller's details.
+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.
 
 During a Call
 -------------
 
-While you are on a call:
+Once the call begins, the interface shifts to the "call" UI:
+
+1. The main portion of the screen displays the caller's video feed.
+2. Your own video feed appears in the bottom right corner.
+3. On the top right:
 
-1. **End Call:** To conclude the call, you can click the "Hang Up" button
+   - An icon lets you toggle between fullscreen and the regular view.
+
+4. Below the video feeds, three buttons are available:
+
+   a. Mute/unmute video: When muted, the video icon turns yellow with a red strike-through.
+   b. Mute/unmute audio: When muted, the audio icon turns yellow with a red strike-through.
+   c. Hang Up: A red phone icon in a horizontal direction to end the call.
 
-Security and Privacy Aspects of Calls
--------------------------------------
+Fullscreen Mode
+---------------
+
+While in fullscreen:
 
-It's crucial to stay aware of what information you share and prioritize your privacy:
+1. Click on the same icon in the top right corner to revert to the standard view.
+2. The "Hang Up" button allows you to end the call and return to the regular view.
+3. Use the shortcut ``Alt+n`` to toggle the notification bar on or off. By default, it's hidden.
+
+Security Considerations for Calls
+---------------------------------
+
+When using Libervia's call feature, prioritize your privacy and safety:
 
 **1. Sharing Your "Online Presence" and Address:**
 
@@ -55,7 +72,7 @@
 
 **3. Safety Recommendations:**
 
- - **Be Selective:** Make or accept calls only with those you trust.
+ - **Be Selective:** Only make or receive calls from trusted individuals.
  - **Network Usage:** Though designed to function anywhere, remember that public networks (like those in coffee shops or hotels) might be less secure.
  - **Stay Informed:** For any queries or concerns, join our community chat room. You can find it at the provided link on our website.