Плагины

Обновлено 15 мая 2024

Плагины SaluteJazz SDK для Web дают доступ к вспомогательным функциям и не требуют обязательного подключения к SDK.

Плагины хранятся в пакете @salutejs/jazz-sdk-web-plugins. Список плагинов включает в себя:

• AudioOutputMixerPlugin — позволяет воспроизводить звук от участников конференции после успешного подключения к комнате участников конференции;
• VideoElementPoolPlugin — предназначен для работы с видео участников конференции;
• LogsPlugin — позволяет подписаться на события логов SDK.

Установка

Установите плагины с помощью менеджера зависимостей npm:

npm install -S @salutejs/jazz-sdk-web-plugins

Подключение

Плагины подключаются при подключении SDK:

import { createJazzWebSdk, JazzSdk } from '@salutejs/jazz-sdk-web';
import {
  audioOutputMixerPlugin,
  logsPlugin,
  videoElementPoolPlugin,
} from '@salutejs/jazz-sdk-web-plugins';

const jazzSdk: JazzSdk = await createJazzWebSdk({
  plugins: [
    videoElementPoolPlugin(),
    audioOutputMixerPlugin(),
    logsPlugin({
      logLevel: 'debug',
    }),
  ],
});

Так как плагины подключаются одновременно с SDK, ошибки, которые возникают при их инициализации, приводят к прекращению выполнения функции createJazzWebSdk.

Для обработки возможных ошибок используйте конструкцию try..catch:

import { createJazzWebSdk, JazzSdk } from '@salutejs/jazz-sdk-web';

try {
  const jazzSdk: JazzSdk = await createJazzWebSdk();
} catch (error) {}