Mercurial > libervia-backend
annotate doc/libervia-cli/call.rst @ 4291:39ac821ebbdb
plugin XEP-0167: handle conferences:
- SDP can now be answered by component instead of frontend. This is useful for A/V
conferences component to handle A/V call jingle sessions.
- new `call_update` and method, and `content-add` action preparation. This is not yet used
by A/V conference, but it's a preparation for a potential future use.
- Add NS_AV_CONFERENCES to features as required by the newly proposed A/V Conferences
protoXEP.
rel 447
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 29 Jul 2024 03:31:09 +0200 |
parents | be89ab1cbca4 |
children |
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 |
4208
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
9 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
10 Common UI |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
11 ========= |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
12 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
13 There are various UI available to display a call. By default, one will be automatically |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
14 selected according to platform. To select an UI, use the ``--output, -O`` option, with one |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
15 of the following value: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
16 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
17 default |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
18 ------- |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
19 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
20 The default value make a guess on the best output to use on the current platform. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
21 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
22 .. note:: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
23 |
4211
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
24 For the moment, ``default`` tries ``gui`` first, and fallbacks to ``simple`` if it's |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
25 not possible. |
4208
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
26 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
27 simple |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
28 ------ |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
29 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
30 During a call, a simple graphical window will be created, displaying your correspondent's |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
31 video, with your own video feed in the bottom right corner. |
4144
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 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
|
34 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
35 - 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
|
36 - one to (un)mute audio with the ``m`` key shortcut |
4211
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
37 - one to hang up with the ``h`` key shortcut. ``Ctrl+c`` will also have the same effect. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
38 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
39 The following output options can be used: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
40 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
41 - **split**: use 2 windows, one for local feedback and the other for remote video, instead of |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
42 the default single one with local feedback use with Picture-in-Picture. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
43 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
44 - **size=widthxheight**: specify the size of the destination windows (when **split** is |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
45 not used). By default, 1280x720 is used. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
46 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
47 tui |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
48 --- |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
49 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
50 A Text User Interface can be used; it will then output the video streams directly in the |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
51 terminal. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
52 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
53 To make it work, you need to have a terminal compatible with at least one image |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
54 standard (Kitty, iTerm2, or "block", which uses Unicode half blocks and 24-bit color |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
55 escape codes). |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
56 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
57 The control buttons are the same as for the ``simple`` output. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
58 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
59 .. note:: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
60 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
61 `term-image`_ is used to display images in the terminal. Check its documentation to see |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
62 if your terminal is compatible with it (or just try). You can check compatibility at |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
63 https://term-image.readthedocs.io/en/stable/start/installation.html#supported-terminal-emulators |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
64 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
65 .. note:: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
66 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
67 You need to have installed the ``term-image`` package to make it work. It is the case |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
68 if you have used `[TUI]` or `[all]` dependencies during Libervia installation. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
69 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
70 .. _term-image: https://term-image.readthedocs.io/en/stable/ |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
71 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
72 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
73 The following output options can be used: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
74 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
75 - **renderer=RENDERER**: Use a specific renderer. It is case-insensitive and RENDERER can |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
76 be one of: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
77 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
78 - **auto** (default): selects the best possible renderer automatically |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
79 - **block**: uses Unicode half blocks. This option may be less resource-intensive than |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
80 other options (but not necessarily, depending on the implementation). |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
81 - **iterm2**: iTerm2 image protocol |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
82 - **fps**: frames per second to render. It defaults to 25, you can try lower values if |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
83 your machine struggles to show images. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
84 - **size**: same as for ``simple`` output, except the default here is 640x380 for |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
85 performance reasons. |
4144
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
86 |
4208
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
87 gui |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
88 --- |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
89 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
90 The ``gui`` option enables a full graphical user interface for handling calls, akin to |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
91 other frontends (web, desktop). This GUI provides a comprehensive and interactive |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
92 experience for call management directly from your CLI environment, ensuring quick access |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
93 to the call feature from the CLI frontend. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
94 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
95 This interface is accessible if your system supports X11 or Wayland and requires ``PyQt`` |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
96 v6 or higher. Here's how to navigate and use the GUI: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
97 |
4211
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
98 .. note:: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
99 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
100 You need to have installed the ``PyQt6`` package to make it work. It is the case if you |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
101 have used `[GUI]` or `[all]` dependencies during Libervia installation. |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
102 |
4208
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
103 Call Interface |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
104 ^^^^^^^^^^^^^^ |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
105 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
106 The call interface is made with: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
107 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
108 - **Video Feeds**: The main window displays the other party's video, with your video in |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
109 the bottom right. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
110 - **Fullscreen Mode**: A fullscreen toggle button is located at the top right of the |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
111 window. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
112 - **Controls**: The following buttons are available at the bottom of your screen: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
113 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
114 - Mute/Unmute video or audio with respective buttons. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
115 - Desktop Sharing. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
116 - Hang up. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
117 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
118 Desktop Sharing |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
119 ^^^^^^^^^^^^^^^ |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
120 To share your desktop, you need to be in a supported environment (X11 or Wayland). |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
121 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
122 For Wayland, you'll need to have the ``xdg-desktop-portal`` package installed, along with |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
123 its sibling desktop environment-specific package (e.g., ``xdg-desktop-portal-gtk`` or |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
124 ``xdg-desktop-portal-kde``). |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
125 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
126 Once you've clicked on the desktop sharing button, you'll have to select what you want to |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
127 share. It can be your entire screen or a specific application window. On X11, a simple |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
128 dialog will appear, while for Wayland, a dialog provided by your environment will ask you |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
129 to select what you want to share. |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
130 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
131 example |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
132 ------- |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
133 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
134 Pierre wants to call Louise with a GUI:: |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
135 |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
136 $ li call make louise@example.org -O gui |
fd9e78b7a0cd
doc (cli/call): add outputs documentation:
Goffi <goffi@goffi.org>
parents:
4144
diff
changeset
|
137 |
4211
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
138 Louise is expecting Pierre call, and will use TUI with the ``block`` renderer to show it:: |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
139 |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
140 $ li call receive -a pierre@example.net -O tui --oo renderer=block |
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
141 |
4144
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
142 make |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
143 ==== |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
144 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
145 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
|
146 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
147 example |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
148 ------- |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
149 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
150 Pierre wants to call Louise:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
151 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
152 $ li call make louise@example.org |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
153 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
154 receive |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
155 ======= |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
156 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
157 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
|
158 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
|
159 --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
|
160 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
|
161 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
162 .. note:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
163 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
164 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
|
165 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
|
166 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
|
167 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
168 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
169 examples |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
170 -------- |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
171 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
172 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
|
173 start it:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
174 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
175 $ li call receive |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
176 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
177 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
|
178 to automatically accept his calls:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
179 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
180 $ li call receive -a piotr@example.net |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
181 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
182 .. note:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
183 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
184 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
|
185 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
|
186 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
187 .. note:: |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
188 |
14523ee96538
doc (cli): documentation for the new `call` command:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
189 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
|
190 implications and ensure that no one will be filmed or recorded without their consent. |
4211
be89ab1cbca4
doc (cli/call): add ``tui`` output, and document options:
Goffi <goffi@goffi.org>
parents:
4208
diff
changeset
|
191 |