Mercurial > libervia-backend

annotate doc/libervia-cli/call.rst @ 4189:04cd749de818

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docker (backend-dev-demo): command renaming + add a bookmark to avoid empty chat
author Goffi <goffi@goffi.org>
date Mon, 11 Dec 2023 00:54:01 +0100
parents 14523ee96538
children fd9e78b7a0cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4144
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 .. _libervia-cli_call:
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 ===============
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 call: A/V Calls
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 ===============
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 ``call`` lets you initiate or receive calls from the terminal.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
8
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 During a call, a graphical window will be created, displaying your correspondent's video,
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 with your own video feed in the bottom right corner.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 With the UI present (by default), there are 3 buttons:
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
13
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 - one to (un)mute video with the ``v`` key shortcut
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 - one to (un)mute audio with the ``m`` key shortcut
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 - one to hang up with the ``h`` key shortcut. ``Ctrl+c`` will have the same effect.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 make
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 ====
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
20
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 Make a call. The primary argument is the JID of the entity you wish to call.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
22
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 example
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 -------
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 Pierre wants to call Louise::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
27
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 $ li call make louise@example.org
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 receive
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 =======
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
32
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
33 Receive a call. By default, you'll see a confirmation prompt when someone is calling; you
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 can then use ``y`` to accept the call or ``n`` to reject it. Use the ``-a JID,
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 --auto-accept JID`` option to automatically accept calls from a specific entity (can be
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 used multiple times), or the ``--auto-accept-all`` to accept any incoming call.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
37
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 .. note::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
39
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 Accepting a call automatically activates your webcam and microphone, and shares your IP
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 address with the caller. Therefore, using ``--auto-accept-all`` is a security risk. Only
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 use it if you have a very good reason to do so.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
43
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
44
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 examples
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 --------
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
47
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
48 Louise is expecting a call. When she receives one, a prompt will ask her to confirm and
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 start it::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
50
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
51 $ li call receive
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
52
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
53 Piotr has a device with a webcam and microphone for observing wildlife. He set the device
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
54 to automatically accept his calls::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
55
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
56 $ li call receive -a piotr@example.net
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
57
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 .. note::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
59
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
60 Libervia CLI will exit once the first accepted call is terminated. Looping in a shell
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
61 may be necessary to call the same device multiple times.
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
62
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
63 .. note::
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
64
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
65 Since using auto-accept mode activates the webcam and microphone, consider the privacy
14523ee96538 doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff changeset
66 implications and ensure that no one will be filmed or recorded without their consent.