libervia-web: doc/user/calls.rst annotate

annotate doc/user/calls.rst @ 1612:ebd538cb26cb

server, pages (files/view): use new `use_local_shared_tmp` option.

author	Goffi <goffi@goffi.org>
date	Wed, 12 Jun 2024 23:11:08 +0200
parents	9cde31a21a9b
children	e338426ed4de

rev	line source
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	1 =================
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	2 Audio/Video Calls
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	3 =================
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	4
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	5 Libervia provides the capability for one-to-one audio and video calls. This section will guide you on how to use this feature effectively.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	6
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	7 Accessing the Call Feature
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	8 --------------------------
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	9
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	10 1. Navigate to the main menu.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	11 2. Select the "Calls" option.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	12
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	13 Initiating a Call
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	14 -----------------
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	15
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	16 Upon entering the "Calls" page:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	17
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	18 1. An interface will display a search box at the top and a list of your contacts below.
1558 2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	19 2. Above the list of contacts, you'll see two icons: one depicting a camera for video calls and another with a phone for audio calls.
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	20 3. To start a call:
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	21
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	22 a. Enter a full JID into the search box, then click on the desired icon for either video call or audio call.
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	23 b. To initiate a video call directly, click anywhere on a contact item. For more options:
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	24
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	25 - Hover over a contact item to reveal a three-dot menu icon on desktops. This icon is always visible on touch devices.
2f2250ddad23 doc (calls): update how to initiate a call Goffi <goffi@goffi.org> parents: 1555 diff changeset	26 - Clicking on the three-dot menu displays a dropdown, allowing you to select between "video call" and "audio call."
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	27
1605 9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	28 .. note::
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	29
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	30 The search box functions as expected – inputting a portion of a contact's name or the group they belong to will filter the displayed contacts.
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	31
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	32 Receiving a Call
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	33 ----------------
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	34
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	35 Currently, you must be on the "Calls" page to receive an incoming call. This limitation will be addressed in future updates.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	36
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	37 Upon receiving a call:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	38
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	39 1. An audible ring will sound.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	40 2. A dialog box will appear, prompting you to either Answer or Reject the incoming call.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	41 3. If you choose to answer and it's a video call, the call interface will display both the caller's video feed and your video in the bottom right corner. For audio-only calls, no video feeds will be shown.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	42
1603 e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	43 Remote Control a Device
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	44 -----------------------
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	45
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	46 You can initiate a remote control session with another user by accessing the "Remote
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	47 Control" menu on a contact item. Clicking on this option will bring up a call interface,
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	48 featuring only "Hang Up" and full-screen buttons. If your request is accepted, you will be
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	49 able to view your peer's device screen in real-time. You can then interact with their
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	50 device using your mouse and keyboard as if you were sitting in front of it. On
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	51 touch-enabled devices, you can also use touch gestures or a pointer to control the remote
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	52 device.
e105d7719479 doc (user/calls): Add a section to explain remote control: Goffi <goffi@goffi.org> parents: 1558 diff changeset	53
1605 9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	54 Group Call
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	55 ----------
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	56
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	57 Call several person at once with group calling feature:
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	58
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	59 1. Select Participants:
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	60
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	61 - On the "Calls" page, locate the checkboxes at the top left corner of each contact item.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	62 - Check the boxes next to the contacts you wish to include in the group call. As soon
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	63 as you select at least one contact, the interface will switch to "Group Call" mode.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	64
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	65 2. Initiate the Group Call:
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	66
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	67 - Once the desired participants are selected, a "Group Call" button will appear next to
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	68 the search bar.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	69 - Click the "Group Call" button to start the group call session.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	70
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	71 3. During the Group Call:
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	72
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	73 - You'll be presented with the group call interface.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	74 - Each participant's video will appear as they join the session, allowing for a
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	75 seamless and interactive group communication experience.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	76
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	77 .. note::
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	78
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	79 Ensure that all participants' clients support the group call feature for an uninterrupted experience.
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	80
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	81
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	82 During a Call
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	83 -------------
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	84
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	85 The call interface offers the following features:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	86
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	87 1. Fullscreen Mode: The top right button allows you to expand the video feeds to cover the entire screen.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	88 2. Mute Options: Two buttons at the bottom of the interface enable you to mute your audio or video.
1555 0796bb8bad2f doc (calls): minor markup fix Goffi <goffi@goffi.org> parents: 1554 diff changeset	89
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	90 - Muted audio: The audio icon will turn yellow with a red strike-through, indicating that your audio is off and the other party cannot hear you.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	91 - Muted video: The video icon will turn yellow with a red strike-through, signaling that your video is off and the other party cannot see you.
1554 1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	92 3. Screen Sharing (Desktop Only): Next to the mute buttons is a desktop icon. By default, it is green and crossed out, indicating no screen sharing.
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	93
1554 1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	94 - Click the icon to share your desktop or a specific window. The browser will prompt you to choose what you want to share.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	95 - Once sharing, the icon turns red and the cross disappears, replacing the camera stream with your desktop or selected window.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	96 - Click the icon again or use the browser dialog to stop sharing and revert to the camera stream.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	97 4. End Call: Click the "Hang Up" button to conclude the call.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	98
1605 9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	99 .. note::
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	100
9cde31a21a9b doc (user/calls): document group call feature: Goffi <goffi@goffi.org> parents: 1603 diff changeset	101 The screen sharing feature is available only on desktop versions of browsers that support the functionality.
1554 1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	102
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	103 Security Considerations for Calls and Screen Sharing
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	104 ----------------------------------------------------
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	105
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	106 When using Libervia's call feature, it's essential to consider certain privacy aspects:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	107
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	108 1. Sharing Your "Online Presence" and Address:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	109
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	110 Making or receiving a call not only shares your device's unique online address (similar to a unique phone number) but also informs others that you're currently online. This means people can see when you're active, much like noticing you're home when the lights are on.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	111
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	112 2. Privacy Implications:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	113
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	114 This information is standard when chatting with trusted contacts. However, with unfamiliar individuals, it might slightly reveal your activity pattern and general location.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	115
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	116 3. Safety Recommendations:
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	117
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	118 - Be Selective: Only initiate or accept calls from people you trust.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	119 - Network Usage: While the call feature is designed for use anywhere, including public networks like in restaurants or hotels, be mindful that unfamiliar networks might be less secure.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	120 - Stay Informed: If you have questions or concerns, you can join our community chat room for guidance. Visit `Libervia's Chat Room <xmpp:libervia@chat.jabberfr.org?join>`_.
4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	121
1554 1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	122 4. Screen Sharing Implications:
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	123
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	124 Sharing your desktop or a specific window offers another layer of accessibility to the person on the other side of the call. This means they can see everything displayed on the chosen screen, including personal files, notifications, and other sensitive information that might be accidentally displayed.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	125
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	126 5. Safety Recommendations for Screen Sharing:
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	127
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	128 - Review Before Sharing: Before starting a screen sharing session, close any unrelated applications or windows. Ensure no sensitive information, like passwords, private messages, or confidential documents, is visible.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	129 - Stay Aware: During a screen sharing session, remember that everything on your screen is visible to the other party. Avoid accessing personal files or confidential information.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	130 - Use With Trusted Contacts: As with audio and video calls, only use the screen sharing feature with individuals or groups you trust.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	131 - Understand Browser Permissions: The browser will typically ask you which screen, application, or window you'd like to share. Ensure you're only sharing what's intended. If in doubt, choose to share a specific application or window rather than the entire screen.
1dc23ba67f47 doc (user/calls): add screen sharing documentation: Goffi <goffi@goffi.org> parents: 1550 diff changeset	132
1550 4b0464b2a12b doc: add end-user A/V calls documentation: Goffi <goffi@goffi.org> parents: diff changeset	133 Always prioritize your privacy and be aware of the information you share while using the call feature.

Mercurial > libervia-web

annotate doc/user/calls.rst @ 1612:ebd538cb26cb