Visio/Jitsi~JitsiAdaptor(jitsi)

Gère les actions et les listeners avec l'api de Jitsi

new JitsiAdaptor(jitsi)

Lie la visio a jitsi
Parameters:
Name Type Description
jitsi external:JitsiMeetExternalAPI Jitsi Api

Members

package _jitsi :external:JitsiMeetExternalAPI

Api

package, nullable _password :string

Mot de passe de la visio

Methods

_add_listener(name, prop) → {module:Visio/Jitsi~JitsiAdaptor}

Ajoute un listener
Parameters:
Name Type Description
name string Nom du listener
prop string Nom du bnum event qui sera appelé
Returns:
module:Visio/Jitsi~JitsiAdaptor - Chaînage

package _init_listeners() → {module:Visio/Jitsi~JitsiAdaptor}

Initialise les listeners
Returns:
module:Visio/Jitsi~JitsiAdaptor - Chaînage

change_avatar(url)

Change l'url de l'avatar
Parameters:
Name Type Description
url string Url de l'avatar ou données de l'image

async get_available_devices() → {Promise:.<module:Visio/Jitsi~DevicesObject:>}

Récupère les inputs et outputs disponibles
Returns:
Promise:.<module:Visio/Jitsi~DevicesObject:>

async get_current_devices() → {Promise:.<module:Visio/Jitsi~CurrentDevicesObject:>}

Récupère les inputs et outputs séléctionnés

get_frame(optionsopt) → {HTMLIFrameElement|external:jQuery}

Récupère la frame qui contient Jitsi
Parameters:
Name Type Attributes Default Description
options Object <optional>
{}
Properties
Name Type Attributes Default Description
jquery boolean <optional>
true Si on récupère un objet jQuery ou HTMLIframeElement
Returns:
HTMLIFrameElement | external:jQuery

async get_micro_and_audio_devices() → {Promise:.<Array:.<module:Visio/Jitsi~DeviceEx:>>}

Récupère les input et les output audio.
Returns:
Promise:.<Array:.<module:Visio/Jitsi~DeviceEx:>>

async get_role() → {Promise:.<?module:Visio/Jitsi~EUserRole:>}

Récupère le rôle de l'utilisateur
Returns:
Promise:.<?module:Visio/Jitsi~EUserRole:>

async get_room_infos() → {Promise:.<module:Visio/Jitsi~Participant:>}

Récupère les données de la visio
Returns:
Promise:.<module:Visio/Jitsi~Participant:>
Deprecated:
  • Yes

async get_rooms_info() → {Promise:.<module:Visio/Jitsi~ResponseRooms:>}

Récupère les informations des salles
Returns:
Promise:.<module:Visio/Jitsi~ResponseRooms:>

async get_user_id() → {Promise:.<string:>}

Récupère l'id de l'utilisateur en cours
Returns:
Promise:.<string:>

async get_video_devices() → {Promise:.<Array:.<module:Visio/Jitsi~DeviceEx:>>}

Récupère les input videos.
Returns:
Promise:.<Array:.<module:Visio/Jitsi~DeviceEx:>>

hangup()

Arrête la visio

has_password() → {boolean}

Si un mot de passe a été défini
Returns:
boolean

initiate_private_chat(id)

Commencer un tchat privé
Parameters:
Name Type Description
id string Id du participant

async is_audio_muted() → {Promise:.<boolean:>}

Si le micro est désactivé
Returns:
Promise:.<boolean:>

async is_moderator() → {Promise:.<boolean:>}

Si l'utilisateur en cours est modérateur de la room ou non
Returns:
Promise:.<boolean:>

async is_participants_pane_open() → {Promise:.<boolean:>}

Check si la fenêtre des participants est ouverte ou non
Returns:
Promise:.<boolean:>

async is_video_muted() → {Promise:.<boolean:>}

Si la video est désactivée
Returns:
Promise:.<boolean:>

open_virtual_background()

Ouvre le gestionnaire d'arrière plan

resize_film_strip(new_size)

Redimensionne la liste des participants
Parameters:
Name Type Description
new_size number Nouvelle taille

send_message(text)

Envoi un message dans le tchat
Parameters:
Name Type Description
text string Message à envoyer

set_audio_device(label, id)

Change la sortie audio de la visio
Parameters:
Name Type Description
label string Nom du périphérique
id string id du périphérique

set_micro_device(label, id)

Change le micro de la visio
Parameters:
Name Type Description
label string Nom du périphérique
id string id du périphérique

set_participants_pane_state(state)

Affiche ou ferme la fenêtre des participants
Parameters:
Name Type Description
state boolean true = ouvert, false = fermé

async set_password(password)

Défini le nouveau mot de passe de la visio
Parameters:
Name Type Description
password string Mot de passe

set_video_device(label, id)

Change la caméra de la visio
Parameters:
Name Type Description
label string Nom du périphérique
id string id du périphérique

share_screen()

Active ou désactive le partage d'écran

show_notification(content, optionsopt)

Affiche une notification Jitsi
Parameters:
Name Type Attributes Default Description
content string Contenu du titre
options Object <optional>
{}
Properties
Name Type Attributes Default Description
uid string | undefined <optional>
Id de la notification
type string <optional>
'info' Type de notification
timeout string <optional>
'short' Temps d'affichage de la notification
See:

toggle_chat()

Affiche ou ferme le tchat

toggle_film_strip()

Active ou désactive la mosaïque
Deprecated:
  • Utilisez plutôt toggle_tile_view

toggle_hand()

Lève ou baisse la main

toggle_micro()

Change d'état le micro

async toggle_participants_pane() → {Promise:.<{old_state:boolean:, new_state:boolean:}>}

Affiche ou ferme la fenêtre des participants
Returns:
Promise:.<{old_state:boolean:, new_state:boolean:}> - Ancien et nouvel état

toggle_tile_view()

Active ou désactive la mosaïque

toggle_video()

Change d'état la caméra

Events

on_audio_mute_status_changed

Est appelé lorsque le micro est activé/désactivé
Type:

on_chat_updated

Est appelé lorsque le chat est ouvert/fermé et quand il y a des messages non-lu
Type:

on_film_strip_display_changed

Est appelé lorsque la liste des utilisateurs est affichée ou non
Type:

on_mouse_move

Est appelé lorsque la souris se déplace dans la frame de la visio
Type:

on_password_required

Est appelé lorsque la visio à besoin d'un mot de passe pour commencer
Type:

on_raise_hand_updated

Est appelé lorsqu'une personne lève ou baisse la main
Type:

on_ready_to_close

Est appelé lorsque la visio est complètement arretée
Type:

on_share_screen_status_changed

Est appelé lorsque l'écran est partagé ou non
Type:

on_tile_view_updated

Est appelé lorsque la mosaïque est activée/désactivée
Type:

on_video_conference_joined

Est appelé lorsqu'une personne rentre dans la visio
Type:

on_video_conference_left

Appelé lorsque l'on quitte
Type:

on_video_mute_status_changed

Est appelé lorsque la caméra est activé/désactivé
Type: