SaluteJazz SDK для Web
SaluteJazz SDK для Web — это набор модулей для интеграции с сервисом видеоконференций SaluteJazz, который позволяет:
- создавать комнаты для онлайн-конференций;
- настраивать название комнаты и доступы участников;
- управлять аудио- и видеопотоками всех участников конференции.
Для интеграции с се рвисом видеоконференций вам будет нужен ключ SaluteJazz SDK, который обеспечит безопасность клиент-серверного взаимодействия приложений.
Пример использования ключа вы найдете в разделе Авторизация.
Приложение, демонстрирующее функциональность SDK, вы можете найти в github-репозитории.
Установка
Установите SaluteJazz SDK для Web с помощью менеджера зависимостей npm:
npm install -S @salutejs/jazz-sdk-web
Плагины
Плагины SaluteJazz SDK для Web расширяют возможности SDK, но их использование необязательно.
Плагины подключаются при инициализации SDK.
Вы можете установить плагины с помощью менеджера зависимостей npm:
npm install -S @salutejs/jazz-sdk-web-plugins
Функциональность SDK
SaluteJazz SDK для Web предоставляет доступ к следующей функциональности:
-
Авторизация
- Локальный вход в учетную запись по токену без бэкенда с обработкой возможных ошибок.
- Создание ключа SaluteJazz SDK.
- Выход из учетной записи.
- Получение данных авторизованного пользователя.
-
Работа с локальными устройствами
- Получение списка локальных устройств ввода-вывода аудио и видео.
- Выбор основного устройства ввода-вывода аудио и видео.
- Добавление фильтров для видео потоков.
-
Управление конференциями
- Создание конференции типа meeting. Действует только для авторизованных пользователей.
- Получение данных конференции, в которой есть комната.
- Подключение к комнате авторизованного пользователя.
-
Работа с комнатой
- Проверки подключения к комнате и обработка возникающих ошибок.
- Получение списка участников и информации о них (имя, роль и др.).
- Получение аудио- и видеоданных всех участников.
- Включение и выключение микрофона и камеры.
- Включение и выключение демонстрации экрана.
- Отображение доминантного пользователя (активный говорящий).
- Возможность отключить у себя звука от всех участников.
- Обработка выхода участника из конференции.
- Запрос разрешений на демонстрацию экрана, включение микрофона и камеры.
-
Администрирование конференции
- Отключение звука и видео у всех участников.
- Завершение конференции для всех участников.
- Настройка разрешений комнаты: включение микрофона и камеры, демонстрация экрана.
- Настройка параметров комнаты.
- Управление запросами разрешений от пользователей.
- Исключение пользователя из конференции.
- Настройки лобби при создании комнаты.
-
Работа с реакциями
- Отправка реакции.
- Получение реакций каждым участником конференции.
-
Подъем руки
- Возможность поднять руку.
- Получение каждым участником конференции события подъема руки определенного участника.