view doc/calls.rst @ 517:f316c7f19909

install: update Kivy version to fix build issue.
author Goffi <goffi@goffi.org>
date Sat, 13 Jul 2024 13:08:13 +0200
parents 0fdf3e59aaad
children
line wrap: on
line source

=================
Audio/Video Calls
=================

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. 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
-----------------

Upon accessing the call feature, you are presented with the "search" UI:

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:

   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
----------------

When someone calls you:

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
-------------

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:

   - An icon lets you toggle between fullscreen and the regular view.

4. Below the video feeds, four 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. 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.
   d. Hang Up: A red phone icon in a horizontal direction to end the call.

.. note::

   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.

Fullscreen Mode
---------------

While in fullscreen:

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 and Desktop Sharing
-----------------------------------------------------

When using Libervia's call feature, prioritize your privacy and safety:

**1. Sharing Your "Online Presence" and Address:**

 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.

**2. Privacy Implications:**

 Although it's common to share this information with trusted contacts, unfamiliar users may infer your activity patterns and general vicinity.

**3. Screen Sharing Considerations:**

 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.

**4. Safety Recommendations:**

 - **Be Selective:** Only make or receive calls and share your screen with trusted individuals.
 - **Review Before Sharing:** Ensure no sensitive information is visible on your screen before initiating screen sharing.
 - **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.

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.