hackaton-uikit-audio-controller v0.4.0

Быстрый старт

Установка

npm i hackaton-uikit-audio-controller

Использование

import { AudioController } from "hackaton-uikit-audio-controller";

const audioController = new AudioController("https://somebaseurl.com");

// ***

someConnectButton.addEventListener("click", async () => {
  if (audioController.isConnected()) {
    await audioController.disconnect();
  } else {
    audioController.connect();
  }
});

someMicrophoneButton.addEventListener("click", async () => {
  if (audioController.isSpeakEnabled()) {
    await audioController.speakOff();
  } else {
    await audioController.speakOn();
  }
});

Методы

AudioController(baseUrl: string, bufferSize?: number = 2048)

Основной конструктор класса

• baseUrl - URL адрес сокет-сервера
• bufferSize - размер буфера аудио пакетов

const audioController = new AudioController("https://somebaseurl.com", 2048);

isConnected(): boolean

Состояние подключения, true если подключение активно, false если нет.

const isConnected = audioController.isConnected();

connect(): Promise<void>

Процедура подключения к сокет-серверу.

audioController.connect();

disconnect(): Promise<void>

Процедура отключения от сокет-сервера.

Важно: после отключения от сервера, микрофон пользователя также отключается.

audioController.diconnect().then(() => {
  console.log("Disconnected");
});

isSpeakerEnabled(): boolean

Процедура получения статуса микрофона, true если микрофон в данный момент используется и данные передаются на сервер, false если микрофон не активен.

audioController.diconnect().then(() => {
  console.log("Disconnected");
});

getUsers() => Promise<string[]>

Функция получения подключенных пользователей, возвращает массив, состоящий из id сокетов пользователей.

audioController.getUsers().then((users) => {
  for (const user of users) {
    console.log(user);
  }
});

sendAudioSticker(sticker: string) => void

Функция отправки аудио стикеров

Доступные на данный момент стикеры: airhorn, boi, bruh, cricket, wow

audioController.sendAudioSticker("bruh");

Ивенты

Пример использования ивента

audioController.events.on(EventType, (data) => {
  console.log(data);
});

Типы ивентов

Ивент подключения юзера к серверу:

user_join: { id: string }

audioController.events.on("user_join", (user) => {
  someLocalList.push(user.id);
});

Ивент отключения юзера от сервера:

user_leave: { id: string }

Ивент приема звука от пользователя

user_speak: { id: string }

Ивент отключения юзера от сервера:

user_leave: { id: string }