Mercurial > libervia-backend

comparison doc/libervia-cli/call.rst @ 4208:fd9e78b7a0cd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (cli/call): add outputs documentation: outputs are now documentated, and notably the new `gui` one. fix 427
author Goffi <goffi@goffi.org>
date Sun, 11 Feb 2024 23:22:18 +0100
parents 14523ee96538
children be89ab1cbca4
comparison
equal deleted inserted replaced
4207:2865e70b0b2c 4208:fd9e78b7a0cd
4 call: A/V Calls 4 call: A/V Calls
5 =============== 5 ===============
6 6
7 ``call`` lets you initiate or receive calls from the terminal. 7 ``call`` lets you initiate or receive calls from the terminal.
8 8
9 During a call, a graphical window will be created, displaying your correspondent's video, 9
10 with your own video feed in the bottom right corner. 10 Common UI
11 =========
12
13 There are various UI available to display a call. By default, one will be automatically
14 selected according to platform. To select an UI, use the ``--output, -O`` option, with one
15 of the following value:
16
17 default
18 -------
19
20 The default value make a guess on the best output to use on the current platform.
21
22 .. note::
23
24 For the moment, ``default`` always select ``simple`` output.
25
26
27 simple
28 ------
29
30 During a call, a simple graphical window will be created, displaying your correspondent's
31 video, with your own video feed in the bottom right corner.
11 32
12 With the UI present (by default), there are 3 buttons: 33 With the UI present (by default), there are 3 buttons:
13 34
14 - one to (un)mute video with the ``v`` key shortcut 35 - one to (un)mute video with the ``v`` key shortcut
15 - one to (un)mute audio with the ``m`` key shortcut 36 - one to (un)mute audio with the ``m`` key shortcut
16 - one to hang up with the ``h`` key shortcut. ``Ctrl+c`` will have the same effect. 37 - one to hang up with the ``h`` key shortcut. ``Ctrl+c`` will have the same effect.
38
39 gui
40 ---
41
42 The ``gui`` option enables a full graphical user interface for handling calls, akin to
43 other frontends (web, desktop). This GUI provides a comprehensive and interactive
44 experience for call management directly from your CLI environment, ensuring quick access
45 to the call feature from the CLI frontend.
46
47 This interface is accessible if your system supports X11 or Wayland and requires ``PyQt``
48 v6 or higher. Here's how to navigate and use the GUI:
49
50 Call Interface
51 ^^^^^^^^^^^^^^
52
53 The call interface is made with:
54
55 - **Video Feeds**: The main window displays the other party's video, with your video in
56 the bottom right.
57 - **Fullscreen Mode**: A fullscreen toggle button is located at the top right of the
58 window.
59 - **Controls**: The following buttons are available at the bottom of your screen:
60
61 - Mute/Unmute video or audio with respective buttons.
62 - Desktop Sharing.
63 - Hang up.
64
65 Desktop Sharing
66 ^^^^^^^^^^^^^^^
67 To share your desktop, you need to be in a supported environment (X11 or Wayland).
68
69 For Wayland, you'll need to have the ``xdg-desktop-portal`` package installed, along with
70 its sibling desktop environment-specific package (e.g., ``xdg-desktop-portal-gtk`` or
71 ``xdg-desktop-portal-kde``).
72
73 Once you've clicked on the desktop sharing button, you'll have to select what you want to
74 share. It can be your entire screen or a specific application window. On X11, a simple
75 dialog will appear, while for Wayland, a dialog provided by your environment will ask you
76 to select what you want to share.
77
78 example
79 -------
80
81 Pierre wants to call Louise with a GUI::
82
83 $ li call make louise@example.org -O gui
17 84
18 make 85 make
19 ==== 86 ====
20 87
21 Make a call. The primary argument is the JID of the entity you wish to call. 88 Make a call. The primary argument is the JID of the entity you wish to call.