Mercurial > libervia-web
changeset 1550:4b0464b2a12b
doc: add end-user A/V calls documentation:
rel 423
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 09 Aug 2023 00:22:18 +0200 |
parents | e47c24204449 |
children | 00d04f51787e |
files | doc/index.rst doc/user/calls.rst |
diffstat | 2 files changed, 69 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/index.rst Wed Aug 09 00:22:18 2023 +0200 +++ b/doc/index.rst Wed Aug 09 00:22:18 2023 +0200 @@ -22,6 +22,7 @@ :caption: Contents: installation.rst + user/calls.rst web_framework/quick_start.rst web_framework/css_framework.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/user/calls.rst Wed Aug 09 00:22:18 2023 +0200 @@ -0,0 +1,68 @@ +================= +Audio/Video Calls +================= + +Libervia provides the capability for one-to-one audio and video calls. This section will guide you on how to use this feature effectively. + +Accessing the Call Feature +-------------------------- + +1. Navigate to the main menu. +2. Select the "Calls" option. + +Initiating a Call +----------------- + +Upon entering the "Calls" page: + +1. An interface will display a search box at the top and a list of your contacts below. +2. To the right of the search box, there is a button labeled "Video Call," indicating that both audio and video will be enabled for the call. +3. To make an audio-only call, click the adjacent icon. The "Video Call" button will change to "Audio Call." +4. To start a call: + a. Enter a full JID into the search box, then click on either "Audio Call" or "Video Call." + b. Alternatively, directly click on a contact's name to initiate a call with them. + +*Note:* 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. + +Receiving a Call +---------------- + +*Currently, you must be on the "Calls" page to receive an incoming call. This limitation will be addressed in future updates.* + +Upon receiving a call: + +1. An audible ring will sound. +2. A dialog box will appear, prompting you to either **Answer** or **Reject** the incoming call. +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. + +During a Call +------------- + +The call interface offers the following features: + +1. **Fullscreen Mode:** The top right button allows you to expand the video feeds to cover the entire screen. +2. **Mute Options:** Two buttons at the bottom of the interface enable you to mute your audio or video. + - 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. + - 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. +3. **End Call:** Click the "Hang Up" button to conclude the call. + +Security Considerations for Calls +--------------------------------- + +When using Libervia's call feature, it's essential to consider certain privacy aspects: + +**1. Sharing Your "Online Presence" and Address:** + + 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. + +**2. Privacy Implications:** + + This information is standard when chatting with trusted contacts. However, with unfamiliar individuals, it might slightly reveal your activity pattern and general location. + +**3. Safety Recommendations:** + + - **Be Selective:** Only initiate or accept calls from people you trust. + - **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. + - **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>`_. + +Always prioritize your privacy and be aware of the information you share while using the call feature.