Документация

Документация по двум классам GuestVC и AdminVC с описанием методов

Class GuestVC

Класс для создание связи со стороны гостя

connect

Описание: Подключение к комнате

Тип	Параметры	Тип возвращаемых значений
метод	-	-

disconnect

Описание: Покинуть комнату

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

setVideoContainerForTestCamera

Описание: Установить контейнер для отображения камеры во время тестирования

Использовать до тестирования устройства

Тип	Параметры	Тип возвращаемых значений
метод	elem HTML	-

setCameraDevice

Описание: Установить камеру, как основное устройство

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

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

setMicroDevice

Описание: Установить микрофон, как основное устройство

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

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

setSoundDevice

Описание: Установить динамик, как основное устройство

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

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

getMicroDevicesList

Описание: Получить список доступных микрофонов в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getCameraDevicesList

Описание: Получить список доступных камер в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getSoundDevicesList

Описание: Получить список доступных динамиков в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getCurrentCameraDevice

Описание: Получить текущий установленный ID камеры (устройства)

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getCurrentSoundDevice

Описание: Получить текущий установленный ID динамика (устройства)

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getCurrentMicroDevice

Описание: Получить текущий установленный ID микрофона (устройства)

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

startTest

Описание: Начать тестирование устройств

Use before connecting to the session

Тип	Параметры	Тип возвращаемых значений
метод	-	-

stopTest

Описание: Остановить тестирование устройств

Use before connecting to the session

Тип	Параметры	Тип возвращаемых значений
метод	-	-

setElementHTMLMessages

Описание: Устанавливает HTML элемент для отображения чата

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	elem HTML	-

sendMsg

Описание: Отправка сообщения в чате

Тип	Параметры	Тип возвращаемых значений
метод	string - сообщение для отправки	-
	string - ID пользователя, которому адресуют сообщение (пример, @student1234 Привет!)

setClassStyleMsg

Описание: Задать классы для изменения стиля сообщений

Тип	Параметры	Тип возвращаемых значений
метод	{ own: "className", fromGuestToMe: "className", fromOwnerToMe: "className", fromMeToGuest: "className", guests: "className", roomOwner: "className" }	-
	own - для отображения собственных сообщений
	fromGuestToMe - сообщения от других гостей адресованное как личное сообщение (его не видят другие гости)
	fromOwnerToMe - сообщения от владельца комнаты адресованное как личное сообщение (его не видят другие пользователи)
	fromMeToGuest - сообщения адресованные как личное сообщение другим участникам комнаты
	guests - сообщения от гостей, отображается у всех
	roomOwner - сообщения от владельца комнаты, отображается у всех

setChatMode

Описание: Установить настройки чата для гостя

Тип	Параметры	Тип возвращаемых значений
метод	{ isDirect: true/false, isVisibleForAll: true/false }
	isDirect - можут ли гость использовать функцию личных сообщений true - может false - не может
	isVisibleForAll - может ли гость видеть сообщения других гостей адресованные всем true - может false - не может

Обязательно задайте значения для всех параметров при использовании данного метода или можете использовать не использовать данный метод, тогда будут использованы параметры по умолчанию

microOff

Описание: Выключить микро

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

microOn

Описание: Включить микро

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

localCameraOff

Описание: Выключить локальную камеру

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

localCameraOn

Описание: Включить локальную камеру

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

setUserName

Описание: Задать имя пользователя

Тип	Параметры	Тип возвращаемых значений
метод	string	-
	int

setUserID

Описание: Задать ID пользователя

Тип	Параметры	Тип возвращаемых значений
метод	string	-

getUserID

Описание: Получить ID пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getUsersList

Описание: Получить список ID пользователей находящихся в комнате

Тип	Параметры	Тип возвращаемых значений
метод	-	string array

setRoomID

Описание: Задать ID комнаты для подключения

Тип	Параметры	Тип возвращаемых значений
метод	string	-
	int

setUserSatusConnection

Описание: Установить статус подключения пользователя

Тип	Параметры	Тип возвращаемых значений
метод	bool	-

getUserStatusConnection

Описание: Получить текущий статус подключения пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	bool
		true - подключён
		false - отключён

setElementHTMLVideoContainerRemote

Описание: Установить HTML элемент для отображения удалённого видео потока

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	HTML elem for display remote screen	-
	HTML elem for display remote camera

setElementHTMLVideoContainerLocal

Описание: Установить HTML элемент для отображения локальной камеры

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	HTML элемент для отображения локальной камеры	-

setConnectBtnUI

Описание: Установить колбэки для изменения состояния кнопки подключения

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	callback для отображения подключения	-
	callback для отображения отключения

getInstance

Описание: Получить экземпляр класса GuestVC

Тип	Параметры	Тип возвращаемых значений
метод	-	GuestVC

detect2g

Описание: Определить 2G сеть и предупредить пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	-

sendDataToContentView

Описание: Отправить любые данные владельцу комнаты для отображения их в content view

Тип	Параметры	Тип возвращаемых значений
метод	structure	-
	{ head: "заголовок кастомного события" content: "привет, мир!" }	-

setGuestAudibility

Описание: Установить будут ли гости слышать друг друга в комнате

Тип	Параметры	Тип возвращаемых значений
метод	bool	-
	true- гости слышат друг друга
	false - гости не слышат друг друга

getGuestAudibility

Описание: Получить значение будут ли пользователи слышать друг друга в комнате

Тип	Параметры	Return
метод	-	bool
		true - гости слышат друг друга
		false - гости не слышат друг друга

setLocalVideoConstraints

Описание: Установить ширину, высоту и частоту кадров для исходящего видео

Тип	Параметры	Return
метод	-	int - ширина
		int - высота
		int - частота кадров

onUserStatusChanged

Описание: Обработчик событий, который обрабатывает изменение статуса подключения других участников

Должен быть добавлен в конце кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onRoomFull

Описание: Обработчик событий, который срабатывает если комната к которой подключаются уже заполнена

Должен быть добавлен в конц кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onStream

Описание: Обработчик событий, который срабатывает если событие связанно поток

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onMediaError

Описание: Обработчик событий, который срабатывает при ошибке

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onMessage

Описание: Обработчик событий сообщений от других подключённых точек (peers)

Тип	Параметры	Тип возвращаемых значений
обработчик событий	callback	-

Class AdminVC

Класс для создания связи со стороны владельца

setVideoContainerForTestCamera

Описание: Установить контейнер для отображения камеры во время тестирования

Использовать до тестирования устройства

Тип	Параметры	Тип возвращаемых значений
метод	elem HTML	-

setCameraDevice

Описание: Установить камеру, как основное устройство

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

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

setMicroDevice

Описание: Установить микрофон, как основное устройство

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

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

setSoundDevice

Описание: Установить динамик, как основное устройство

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

Тип	Параметры	Тип возвращаемых значений
метод	string - ID устройства	-

getMicroDevicesList

Описание: Получить список ID доступных микрофонов в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getCameraDevicesList

Описание: Получить список ID доступных камер в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getSoundDevicesList

Описание: Получить список ID доступных динамиков в системе

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

Тип	Параметры	Тип возвращаемых значений
метод	-	objects array
		{ deviceId: "", label: "" }

getCurrentCameraDevice

Описание: Получить текущий установленный ID камеры

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getCurrentSoundDevice

Описание: Получить текущий установленный ID динамика

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getCurrentMicroDevice

Описание: Получить текущий установленный ID микрофона

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

Тип	Параметры	Тип возвращаемых значений
метод	-	string

startTest

Описание: Начать тестирование устройств

Use before connecting to the session

Тип	Параметры	Тип возвращаемых значений
метод	-	-

stopTest

Описание: Остановить тестирование устройств

Use before connecting to the session

Тип	Параметры	Тип возвращаемых значений
метод	-	-

setMaxGuestCount

Описание: Установить максимальное количество гостей в комнате

Тип	Параметры	Тип возвращаемых значений
метод	int	-

setElementsHTMLVideoContainerRemote

Описание: Установить HTML элементы для отображения удалённых видео потоков

Должен быть вызван до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	HTML элементы для отображения удалённой камеры (количество элементов должно быть равно максимальному количеству гостей)	-

setElementsHTMLVideoContainerLocal

Описание: Установка HTML элементы для отображения локальной камеры и экрана

Должен быть вызван до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	HTML эелемент для отображения локальной камеры	-
	HTML элемент для отображения экрана

setContentViewContainer

Описание: Установить HTML элемент откуда будут копироваться дочерние элементы для отправки другим пользователям комнаты

Данный метод необходимо вызвать до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	HTML elem	-

setElementHTMLMessages

Описание: Устанавливает HTML элемент для отображения чата

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	elem HTML	-

sendMsg

Описание: Отправка сообщения в чате

Тип	Параметры	Тип возвращаемых значений
метод	string - сообщение для отправки	-
	string - ID пользователя, которому адресуют сообщение (пример, @student1234 Привет!)

setClassStyleMsg

Описание: Задать классы для изменения стиля сообщений

Тип	Параметры	Тип возвращаемых значений
метод	{ own: "className", fromGuestToMe: "className", fromMeToGuest: "className", fromGuestToGuest: "className", guests: "className", }	-
	own - для отображения собственных сообщений
	fromGuestToMe - сообщения от других гостей адресованное как личное сообщение (его не видят другие гости)
	fromMeToGuest - сообщения адресованные как личное сообщение другим участникам комнаты
	fromGuestToGuest - сообщения адресованные как личное сообщение от гостя к гостю
	guests - сообщения от гостей, отображается у всех

setChatMode

Описание: Установить настройки чата для гостя

Тип	Параметры	Тип возвращаемых значений
метод	{ isDirect: true/false, isVisibleGuestForOwner: true/false }
	isDirect - может ли владелец комнаты использовать функцию личных сообщений true - может false - не может
	isVisibleGuestForOwner - может ли гость видеть сообщения адресованные как личные сообщения от гостя к гостю true - может false - не может

Обязательно задайте значения для всех параметров при использовании данного метода или можете использовать не использовать данный метод, тогда будут использованы параметры по умолчанию

setConnectBtnUI

Описание: Установить колбэки для изменения состояния кнопки подключения

Должен быть вызван до подключения к комнате

Тип	Параметры	Тип возвращаемых значений
метод	callback для отображения подключения	-
	callback для отображения отключения

setVideoRecordingConfig

Описание: Задать настройки для записи экрана

Тип	Параметры	Тип возвращаемых значений
метод	{ type: "video", mimeType: "video/webm", resolution: { width: 1280, height: 720 }, frameRate: 30, bitrate: 128000, }	-

setUserSatusConnection

Описание: Установить статус подключения пользователя

Тип	Параметры	Тип возвращаемых значений
метод	bool	-
	true - подключён
	false - отключён

getUserStatusConnection

Описание: Получить статус подключения пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	bool
		true - подключён
		false- отключён

setRoomID

Описание: Задать ID комнаты для подключения

Тип	Параметры	Тип возвращаемых значений
метод	string	-
	int

setUserID

Описание: Задать ID пользователя

Тип	Параметры	Тип возвращаемых значений
метод	string	-

getUserID

Описание: получить ID пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	string

getUsersList

Описание: Получить список ID пользователей находящихся в комнате

Тип	Параметры	Тип возвращаемых значений
метод	-	string array

setUserName

Описание: Задать имя пользователя

Тип	Параметры	Тип возвращаемых значений
метод	string	-
	int

microOff

Описание: Выключить микрофон

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

microOn

Описание: Включить микрофон

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
method	-	-

screenShareOn

Описание: Включить захват экрана

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

screenShareOff

Описание: Выключить захват экрана

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

localCameraOff

Описание: Выключить локальную камеру

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

localCameraOn

Описание: Включить локальную камеру

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

detect2g

Описание: Определить 2G сеть и предупредить пользователя

Тип	Параметры	Тип возвращаемых значений
метод	-	-

sendDataToContentView

Описание: Отправить любые данные гостям для отображения их в content view

Тип	Параметры	Тип возвращаемых значений
метод	structure	-
	{ head: "заголовок кастомного события" content: "привет, мир!" }	-

disconnect

Описание: Отключения и удаление комнаты

Данный метод можно вызвать в любом месте кода, но после вызова экземпляра класса

Тип	Параметры	Тип возвращаемых значений
метод	-	-

connect

Описание: Создать комнату

Тип	Параметры	Тип возвращаемых значений
метод	-	-

getInstance

Описание: Получить экземпляр класса AdminVC

Тип	Параметры	Тип возвращаемых значений
метод	-	AdminVC

changeVideoConstraints

Описание: Отправить запрос на изменение настроек видео

Тип	Параметры	Тип возвращаемых значений
метод	-	int - ширина
		int - высота
		int - частота кадров

onUserStatusChanged

Описание: Обработчик событий, который срабатывает при изменении статуса подключения других пользователей

Должен быть добавлен в конце кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onStream

Описание: Обработчик событий, который обрабатывает все события связанные с потоками

Должен быть добавлен в конце кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onMediaError

Описание: Обработчик событий, который обрабатывает все ошибки связанный потоками

Должен быть добавлен в конце кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	-	-

onMessage

Описание: Обработчик событий сообщений от других подключённых точек (peers)

Должен быть добавлен в конце кода

Тип	Параметры	Тип возвращаемых значений
обработчик событий	callback	-