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