@vkontakte/calls-sdk

Enumerations

Enumeration	Description
MediaTrackKind	Тип трека
ChatRoomEventType	Тип команды зала ожидания
ConversationFeature	Возможности пользователя в звонке
ConversationOption	Опции звонка
FatalError	Типы ошибок
HangupType	Статус завершения звонка
MediaOption	Тип медиаустройства
MuteState	Разрешение на включение устройства
RecordRole	Роль участника в записи звонке. Если выставлена хотя бы на одном участнике, то в записи звонка видны только те участники звонка, у которых есть роль.
RoomsEventType	Тип обновления комнаты
UserRole	Роль участника в звонке
DebugMessageType	Тип отладочного сообщения
ParticipantStatus	Статус собеседника
FacingMode	Тип камеры мобильного устройства
ExternalIdType	Тип внешнего пользователя
MediaType	Тип пользовательского медиа

Classes

Class	Description
HangupReason	Сообщение о завершении звонка

Interfaces

Interface	Description
AddParticipantParams	Параметры добавления пользователя в звонок
CustomError	Дополнительное сообщение об ошибке
HangupReasonData	Сообщение о завершении звонка
JSONArray	JSON-совместимый массив
JSONObject	JSON-совместимый объект
IAsrStartParams	Параметры расшифровки звонка
IAsrStopParams	Параметры остановки расшифровки звонка
IAsrData	Параметры для установки информации по расшифровке звонка
ExternalId	Идентификатор внешнего пользователя
ExternalParticipantId	Идентификатор участника звонка
ExternalParticipant	Участник звонка
ExternalParticipantListChunk	Позиция в чанке
IFeedbackExternal	Реакции в звонке
IVideoDimentions	Размеры видео
IMoviePreview	Preview изображения ролика
IMovieMetaData	MetaData ролика
IAddMovieParams	Параметры для добавления ролика в Совместный Просмотр
ISharedMovieState	Состояние проигрываемого ролика
IUpdateMovieData	Параментры для обновления состояния ролика
ISharedMovieInfo	Информация по добавленному ролику в Совместный просмотр
ISharedMovieStoppedInfo	Информация по удоленному из Совместного Просмотра ролику
IOnRemoteMovieData	Информация по пришедшему стриму ролика в Совместном просмотре
IMuteParticipantParams	Состояние устройств пользователя установленное админом звонка
ParticipantListMarker	Маркер определяющий положение участника в списке
ParticipantStateMapped	Стейт участника звонка
Room	Комната
Rooms	Initial rooms state
RoomsUpdate	Обновление комнат
RoomParticipantUpdate	Информация об обновлении комнаты
ScreenCaptureSettings	Параметры захвата экрана
VmojiError	Ошибка включения vmoji

Type Aliases

Type Alias	Description
JSONType	JSON-совместимый тип данных
ParamsObject	Параметры инициализации
BrowserName	Известные браузеры
AudienceModeHandsResponse	Ответ на запрос getHandQueue
ConversationData	Данные текущего звонка
IFeaturesPerRole	Фичи звонка по ролям
ExternalParticipantListMarker	Маркер определяющий положение участника в списке
ExternalParticipantMarkers	Словарь сопоставляющий тип списка участников с маркером (положением участника в списке)
MediaModifiers	Настройки клиентского медиа
MediaSettings	Информация о текущих медиа настройках пользователя
MuteStates	Состояние устройств пользователя установленное админом звонка
CompositeUserId	Уникально идентифицирует пользователя или группу
ParticipantId	Уникально идентифицирует участника звонка (одному пользователю могут соответствовать несколько участников, в случае если пользователь зашёл в звонок с нескольких устройств) Включает композитный id и постфикс с номером устройства, если он не равен 0
ParticipantListType	Тип списка участников в звонке
ParticipantListMarkers	Маркеры определяющие положения участников в списке
ParticipantsStateList	Состояния участников звонка
ParticipantStateData	Список состояний в виде ключ-значение. Максимальная длина ключей и значений - 5 символов. Пустые значения будут пропущены
Layout	Лейаут собеседника в звонке
StopStream	Запрос остановки стрима
RequestKeyFrame	Request key frame from source. Should not be called often, negatively impacts video quality.
ParticipantLayout	Лейаут собеседника в звонке
ParticipantPriority	Приоритет собеседника в звонке
IRoomId	ID комнаты
WaitingHallResponse	Ответ на запрос getWaitingHall

Variables

browser

const browser: {
  getCameras: () => MediaDeviceInfo[];
  getMicrophones: () => MediaDeviceInfo[];
  getOutput: () => MediaDeviceInfo[];
  getVideoFacingMode: () => FacingMode | null;
  hasCamera: () => boolean;
  hasMicrophone: () => boolean;
  getSavedCamera: () => MediaDeviceInfo | null;
  getSavedMicrophone: () => MediaDeviceInfo | null;
  getSavedOutput: () => MediaDeviceInfo | null;
  hasCameraPermission: () => boolean;
  hasMicrophonePermission: () => boolean;
  hasPermissions: (needVideo) => boolean;
  getUserMedia: (needVideo, needAudio, needEmptyTracks) => Promise<MediaStream>;
  getUserVideo: (deviceId?, resolution?) => Promise<MediaStream>;
  getUserAudio: (deviceId?) => Promise<MediaStream>;
  setResolution: (stream, resolution) => Promise<void>;
  isBrowserSupported: () => boolean;
  isScreenCapturingSupported: () => boolean;
  os: () => string;
  isMobile: () => boolean;
  browserName: () => string;
  browserVersion: () => string;
  baseChromeVersion: () => number;
  getAudioContext: () => AudioContext;
  isAudioShareSupported: () => boolean;
};

Информация о текущем браузере

Type Declaration

Name	Type	Default value	Description
getCameras()	() => MediaDeviceInfo[]	WebRTCUtils.getCameras	Возвращает все подключенные камеры Возвращает все подключенные камеры
getMicrophones()	() => MediaDeviceInfo[]	WebRTCUtils.getMicrophones	Возвращает все подключенные микрофоны Возвращает все подключенные микрофоны
getOutput()	() => MediaDeviceInfo[]	WebRTCUtils.getOutput	Возвращает все подключенные устройства вывода звука Возвращает все подключенные динамики
getVideoFacingMode()	() => FacingMode | null	WebRTCUtils.getVideoFacingMode	Возвращает тип используемой камеры (передняя или задняя) Возвращает тип используемой камеры (передняя или задняя)
hasCamera()	() => boolean	WebRTCUtils.hasCamera	Есть ли у пользователя камера Есть ли у пользователя камера
hasMicrophone()	() => boolean	WebRTCUtils.hasMicrophone	Есть ли у пользователя микрофон Есть ли у пользователя микрофон
getSavedCamera()	() => MediaDeviceInfo | null	WebRTCUtils.getSavedCamera	Возвращает сохраненную камеру пользователя, если она доступна Возвращает сохраненную камеру пользователя, если она доступна
getSavedMicrophone()	() => MediaDeviceInfo | null	WebRTCUtils.getSavedMicrophone	Возвращает сохраненный микрофон пользователя, если он доступен Возвращает сохраненный микрофон пользователя, если он доступен
getSavedOutput()	() => MediaDeviceInfo | null	WebRTCUtils.getSavedOutput	Возвращает сохраненное устройство вывода Возвращает сохраненное устройство вывода
hasCameraPermission()	() => boolean	WebRTCUtils.hasCameraPermission	Проверяет получен ли доступ к камере Проверяет получен ли доступ к камере
hasMicrophonePermission()	() => boolean	WebRTCUtils.hasMicrophonePermission	Проверяет получен ли доступ к микрофону Проверяет получен ли доступ к микрофону
hasPermissions()	(needVideo) => boolean	WebRTCUtils.hasPermissions	Проверяет получены ли разрешения, необходимые для текущего звонка Проверяет получены ли разрешения, необходимые для текущего звонка
getUserMedia()	(needVideo, needAudio, needEmptyTracks) => Promise<MediaStream>	WebRTCUtils.getUserMedia	Запрашивает камеру и микрофон пользователя Запрашивает камеру и микрофон пользователя
getUserVideo()	(deviceId?, resolution?) => Promise<MediaStream>	WebRTCUtils.getUserVideo	Запрашивает камеру пользователя Запрашивает камеру пользователя
getUserAudio()	(deviceId?) => Promise<MediaStream>	WebRTCUtils.getUserAudio	Запрашивает микрофон пользователя Запрашивает микрофон пользователя
setResolution()	(stream, resolution) => Promise<void>	WebRTCUtils.setResolution	Устанавливает размер видео в стриме Устанавливает размер видео в стриме
isBrowserSupported()	() => boolean	WebRTCUtils.isBrowserSupported	Проверяет поддержку WebRTC браузером Метод доступен до инициализации Проверяет поддержку WebRTC браузером
isScreenCapturingSupported()	() => boolean	WebRTCUtils.isScreenCapturingSupported	Проверяет поддержку трансляции экрана браузером Метод доступен до инициализации Проверяет поддержку шаринга экрана браузером
os()	() => string	WebRTCUtils.os	Имя операционной системы Метод доступен до инициализации Имя операционной системы
isMobile()	() => boolean	WebRTCUtils.isMobile	Мобильный браузер или нет Метод доступен до инициализации Мобильный браузер или нет
browserName()	() => string	WebRTCUtils.browserName	Имя браузера Метод доступен до инициализации Имя браузера
browserVersion()	() => string	WebRTCUtils.browserVersion	Версия браузера Метод доступен до инициализации Версия браузера
baseChromeVersion()	() => number	WebRTCUtils.baseChromeVersion	Если браузер основан на хроме - возвращает версию Метод доступен до инициализации Если браузер основан на хроме - возвращает версию
getAudioContext()	() => AudioContext	WebRTCUtils.getAudioContext	Возвращает AudioContext Возвращает AudioContext
isAudioShareSupported()	() => boolean	WebRTCUtils.isAudioShareSupported	Браузер поддерживает захват звука при трансляции экрана Метод доступен до инициализации Браузер поддерживает захват звука при трансляции экрана

---

utils

const utils: {
  participantMarkerCompare: (marker1, marker2) => number;
};

Вспомогательные функции

Type Declaration

Name	Type	Default value	Description
participantMarkerCompare()	(marker1, marker2) => number	Utils.participantMarkerCompare	Сравнивает маркеры для постраничного вывода участников звонка See https://wiki.odkl.ru/pages/viewpage.action?spaceKey=VIDEO&title=Signaling+API#SignalingAPI-Постраничныйвыводпартисипантов https://stash.odkl.ru/projects/ODKL/repos/odnoklassniki-webrtc/browse/src/main/java/one/webrtc/domain/conversation/ParticipantIndex.java#67-78

Functions

Function	Description
setVideoEffects	Устанавливает библиотеку видео эффектов
setAudioEffects	Устанавливает библиотеку аудио эффектов
setVmoji	Устанавливает библиотеку вимоджи
init	Инициализирует библиотеку
callTo	Начать звонок другому пользователю
processPush	Обработать пуш о входящем звонке
authorize	Авторизоваться для совершения звонков
acceptCall	Принять входящий звонок
declineCall	Отклонить входящий звонок
joinCall	Присоединиться к активному звонку
joinCallByLink	Присоединиться к звонку по ссылке
hangup	Завершить текущий разговор
addParticipant	Добавить собеседника в звонок
addParticipantInternal	-
removeParticipant	Удалить собеседника из звонка
removeParticipantInternal	-
changeDevice	Изменить камеру на фронтальную или заднюю (для мобильных устройств)
captureScreen	Включить/выключить захват экрана
captureVmoji	Включить/выключить передачу точек вимоджи
toggleLocalVideo	Включить или выключить свою камеру
toggleLocalAudio	Включить или выключить свой микрофон
setLocalResolution	Изменяет размеры локального видео
changePriorities	Изменяет качество отображаемых стримов - чем выше приоритет, тем лучше качество. Не нужно передавать огромные числа - из приоритетов (0, 1, 2, 3) последний получит максимальное качество, а первый худшее. Отрицательный приоритет выключит видео.
changeParticipantState	Изменяет состояния пользователя в звонке (например, "поднять руку" или "отошёл")
putHandsDown	Принудительно опустить руки участников в текущем сессионном зале админа
updateDisplayLayout	Изменяет лейаут. Также сообщает серверу каких участников звонка стримить на этот клиент
grantRoles	Выдать или забрать роли в звонке пользователю
muteParticipant	Выключить или выключить микрофон и/или камеру собеседнику (только если есть соответствующая роль)
pinParticipant	Закрепить/открепить выбранного собеседника у всех (только если есть соответствующая роль)
setMediaModifiers	Устанавливает настройки пользовательского медиа
enableVideoSuspend	Автоматическое отключения принимаемых видео-потоков в условиях плохого соединения
enableVideoSuspendSuggest	Режим, при котором будет предложено включить автоматическое отключение приёма видео в условиях плохого соединения
changeConversationOptions	Включить/выключить опции звонка
chatMessage	Отправить сообщение в чат
chatHistory	Получить историю сообщений чата
customData	Отправить произвольные данные собеседнику
startConversation	Создать токен комнаты для подключения по ссылке
startAudienceConversation	Создать токен комнаты в режиме Audience для подключения по ссылке
createJoinLink	Создать токен комнаты для подключения по ссылке к существующему звонку
removeJoinLink	Удалить токен комнаты для подключения по ссылке
getAnonymTokenByLink	Получить токен анонимной авторизации для подключения к звонку по ссылке
setVolume	Устанавливает громкость звука собеседников
forceRelayPolicy	Не использовать прямое P2P соединение, чтобы не отправлять в ICE-кандидатах персональные IP-адреса
startStream	Начать трансляцию звонка
stopStream	Завершить трансляцию звонка
publishStream	Опубликовать трансляцию звонка
recordSetConf	Устанавливает роль участника в запись звонка Если хотя бы у одного участника звонка выставлена роль, то в записи звонка будут видны только те участники, у кого есть роль.
getStreamInfo	Получить информацию о трансляции звонка
addMovie	Добавляет видео/лайв в звонок
updateMovie	Изменить видео/лайв в звонке
removeMovie	Удалить видео/лайв из звонка
updateRooms	Обновить сессионные залы
activateRooms	Активировать сессионные залы
switchRoom	Cменить сессионный зал
removeRooms	Удалить сессионные залы
setStatisticsInterval	Устанавливает интервал обновления статистики и вызова onStatistics
debug	Включить режим отладки
debugMessage	Добавить сообщение в отладочный лог
uploadDebugLogs	Отправляет клиенские логи по conversationId на сервер OK
changeVideoEffect	Эффект локального видео
changeAudioEffect	Эффект локального аудио
setVmojiSvg	Позволяет установить svg аватар для участника звонка
setVmojiFill	Позволяет установить цвет фона собственного vmoji
getWaitingHall	Получить состояние зала ожидания
getAudienceModeHands	Получить список слушателей, запросивших повышение в комнате в режиме Audience
promoteParticipant	Разрешить/запретить пользователю войти из зала ожидания/стать спикером комнаты в режиме Audience
requestPromotion	Запросить/отозвать запрос на получение права стать спикером в комнате в режиме Audience
acceptPromotion	Согласиться/отказаться стать спикером в комнате в режиме Audience.
logClientEvent	Логирует клиентское событие статистики
removeHistoryRecords	Удаляет записи истории звонков
startAsr	Начинает текстовую расшифровку звонка
stopAsr	Заканчивает текстовую расшифровку звонка
requestAsr	Запрашивает/отключает реал-тайм расшифровку звонка
version	Версия SDK