CallAdapter interface

Пакет:

@azure/communication-react

Интерфейс адаптера, характерный для удостоверения связи Azure, который расширяет CommonCallAdapter.

Extends

CommonCallAdapter

Унаследованные свойства

sendRealTimeText

Отправка текстовых сообщений в режиме реального времени

Методы

joinCall(boolean)	Присоединяйтесь к вызову с микрофоном изначально вкл./выкл.
joinCall(JoinCallOptions)	Присоединиться к вызову с помощью контейнера опций для установки начального состояния микрофона/камеры при присоединении к вызову true = включить устройство при присоединении к вызову false = выключить устройство при присоединении к вызову 'keep'/undefined = сохранить состояние устройства перед вызовом
startCall(CommunicationIdentifier[], StartCallOptions)	Запустите звонок.
startCall(string[], StartCallOptions)	Запустите звонок.

Наследуемые методы

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Добавьте участника в вызов.
askDevicePermission(PermissionConstraints)	Запрашивать разрешения устройств.
createStreamView(string, VideoStreamOptions)	Создайте html-представление для потока.
createTogetherModeStreamView(TogetherModeStreamOptions)	Создайте html-представление для потока.
dispose()	Удаление составного
disposeLocalVideoStreamView()	Удаление html-представления для локального видеопотока
disposeRemoteVideoStreamView(string)	Удаление html-представления для удаленного видеопотока
disposeScreenShareStreamView(string)	Удаление HTML-представления для потока демонстрации экрана
disposeStreamView(string, VideoStreamOptions)	Удалите html-представление для потока.
disposeTogetherModeStreamView()	Удалите html-представление для потока.
forbidAudio(string[])	Запретите озвучивание участников собрания Teams по идентификаторам пользователей.
forbidOthersAudio()	Запретить аудио собрания Teams.
forbidOthersVideo()	Запретить видео собрания Teams.
forbidVideo(string[])	Запретите участникам собрания Teams видео по их идентификаторам пользователей.
getState()	Получение текущего состояния
holdCall()	Держит вызов.
leaveCall(boolean)	Оставьте звонок
lowerHand()	Нижняя рука для текущего пользователя
mute()	Отключение текущего пользователя во время вызова или отключения микрофона локально
muteAllRemoteParticipants()	Отключить звук Все участники
muteParticipant(string)	Отключение звука участника
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Функция отписки для события 'breakoutRoomsUpdated'.
off("callEnded", CallEndedListener)	Отмена подписки функции для события callEnded.
off("callIdChanged", CallIdChangedListener)	Отмена подписки функции для события callIdChanged.
off("capabilitiesChanged", CapabilitiesChangedListener)	Функция отписки для события 'capabilitiesChanged'.
off("captionsReceived", CaptionsReceivedListener)	Функция отписки для события 'captionsReceived'.
off("diagnosticChanged", DiagnosticChangedEventListner)	Отмена подписки для события "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Отмена подписки для события displayNameChanged.
off("error", (e: AdapterError) => void)	Отмена подписки функции для события error.
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Функция отписки для события 'isCaptionLanguageChanged'.
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Функция отписки для события 'isCaptionsActiveChanged'.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Отмена подписки для события isLocalScreenSharingActiveChanged.
off("isMutedChanged", IsMutedChangedListener)	Отмена подписки для события IsMutedChanged.
off("isSpeakingChanged", IsSpeakingChangedListener)	Отмена подписки для события isSpeakingChanged.
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Функция отписки для события 'isSpokenLanguageChanged'.
off("mutedByOthers", PropertyChangedEvent)	Функция отписки для события 'mutedByOthers'.
off("participantsJoined", ParticipantsJoinedListener)	Отмена подписки функции для события "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Отмена подписки функции для события "participantsLeft".
off("realTimeTextReceived", RealTimeTextReceivedListener)	Функция отписки для события 'realTimeTextReceived'.
off("roleChanged", PropertyChangedEvent)	Функция отписки для события roleChanged.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Отмена подписки для события selectedMicrophoneChanged.
off("selectedSpeakerChanged", PropertyChangedEvent)	Отмена подписки функции для события selectedSpeakerChanged.
off("spotlightChanged", SpotlightChangedListener)	Функция отписки для события 'spotlightChanged'.
off("transferAccepted", TransferAcceptedListener)	Функция отписки для события 'transferRequested'.
offStateChange((state: CallAdapterState) => void)	Отменяет подписку обработчика на события stateChanged.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Функция подписки на событие 'breakoutRoomsUpdated'.
on("callEnded", CallEndedListener)	Функция подписки для события callEnded.
on("callIdChanged", CallIdChangedListener)	Функция подписки для события CallIdChanged.
on("capabilitiesChanged", CapabilitiesChangedListener)	Функция подписки на событие 'capabilitiesChanged'.
on("captionsReceived", CaptionsReceivedListener)	Функция подписки на событие 'captionsReceived'.
on("diagnosticChanged", DiagnosticChangedEventListner)	Функция подписки для события "diagnosticChanged". Это событие возникает всякий раз, когда возникает изменение системы диагностики пользователей по поводу текущего вызова.
on("displayNameChanged", DisplayNameChangedListener)	Функция подписки для события DisplayNameChanged.
on("error", (e: AdapterError) => void)	Функция подписки для события error.
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Функция subscribe для события 'isCaptionLanguageChanged'.
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Функция подписки на событие 'isCaptionsActiveChanged'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Функция подписки для события isLocalScreenSharingActiveChanged.
on("isMutedChanged", IsMutedChangedListener)	Функция подписки для события IsMutedChanged.
on("isSpeakingChanged", IsSpeakingChangedListener)	Функция подписки для события IsSpeakingChanged.
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Функция подписки на событие 'isSpokenLanguageChanged'.
on("mutedByOthers", PropertyChangedEvent)	Функция subscribe для события 'mutedByOthers'.
on("participantsJoined", ParticipantsJoinedListener)	Функция подписки для события "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Функция подписки для события "participantsLeft".
on("realTimeTextReceived", RealTimeTextReceivedListener)	Функция подписки на событие 'realTimeTextReceived'.
on("roleChanged", PropertyChangedEvent)	Функция подписки на событие roleChanged.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Функция подписки для события selectedMicrophoneChanged. Это событие запускается всякий раз, когда пользователь выбирает новое устройство микрофона.
on("selectedSpeakerChanged", PropertyChangedEvent)	Функция подписки для события selectedSpeakerChanged. Это событие запускается всякий раз, когда пользователь выбирает новое устройство говорящего.
on("spotlightChanged", SpotlightChangedListener)	Функция подписки на событие 'spotlightChanged'.
on("transferAccepted", TransferAcceptedListener)	Функция subscribe для события 'transferRequested'.
onReactionClick(Reaction)	Отправить эмодзи на реакцию
onStateChange((state: CallAdapterState) => void)	Подписывает обработчик на события stateChanged.
permitAudio(string[])	Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.
permitOthersAudio()	Разрешить аудиозапись собрания Teams.
permitOthersVideo()	Видео собрания Permission Teams.
permitVideo(string[])	Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.
queryCameras()	Запрос доступных устройств камеры.
queryMicrophones()	Запрос доступных устройств микрофона.
querySpeakers()	Запрос доступных акустических устройств.
raiseHand()	Поднять руку для текущего пользователя
removeParticipant(CommunicationIdentifier)	Удалите участника из вызова.
removeParticipant(string)	Удалите участника из вызова.
resumeCall()	Возобновляет вызов из состояния LocalHold .
returnFromBreakoutRoom()	Возврат к исходному вызову сессионного зала
sendDtmfTone(DtmfTone)	отправлять сигнал DTMF другому участнику вызова 1:1 по ТфОП
setCamera(VideoDeviceInfo, VideoStreamOptions)	Задайте камеру для использования в вызове.
setCaptionLanguage(string)	Функция для установки языка субтитров
setMicrophone(AudioDeviceInfo)	Задайте микрофон для использования в вызове.
setSpeaker(AudioDeviceInfo)	Задайте динамику для использования в вызове.
setSpokenLanguage(string)	Функция настройки разговорного языка
setTogetherModeSceneSize(number, number)	Пересчитайте положения сидения для режима «вместе».
startCamera(VideoStreamOptions)	Запуск камеры Этот метод начнет отрисовку локального представления камеры, если вызов неактивен
startCaptions(StartCaptionsAdapterOptions)	Функция запуска субтитров
startNoiseSuppressionEffect()	Запустите эффект шумоподавления.
startScreenShare()	Запустите общий доступ к экрану во время вызова.
startSpotlight(string[])	Запускайте Spotlight для локальных и удаленных участников по их идентификаторам пользователей. Если массив идентификаторов пользователей не передается, то действие выполняется с локальным участником.
startTogetherMode()	Запустите режим «Вместе».
startVideoBackgroundEffect(VideoBackgroundEffect)	Запустите эффект фона видео.
stopAllSpotlight()	Остановите все прожекторы
stopCamera()	Остановите камеру, чтобы остановить отображение локального представления камеры, если вызов неактивен
stopCaptions(StopCaptionsAdapterOptions)	Функция для остановки субтитров
stopNoiseSuppressionEffect()	Остановите эффект шумоподавления.
stopScreenShare()	Остановить общий доступ к экрану
stopSpotlight(string[])	Остановка Spotlight для локальных и удаленных участников по их идентификаторам пользователей. Если массив идентификаторов пользователей не передается, то действие выполняется с локальным участником.
stopVideoBackgroundEffects()	Остановите эффект фона видео.
submitSurvey(CallSurvey)	Отправка результатов опроса по окончании звонка
unmute()	Отключение текущего пользователя во время вызова или локального включения микрофона
updateBackgroundPickerImages(VideoBackgroundImage[])	Переопределите изображения в окне выбора фона для получения эффекта замены фона.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Обновите выбранный фоновый эффект видео.

Сведения об унаследованном свойстве

sendRealTimeText

Отправка текстовых сообщений в режиме реального времени

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Значение свойства

(text: string, isFinalized: boolean) => Promise<void>

Наследуется отCommonCallAdapter.sendRealTimeText

Сведения о методе

joinCall(boolean)

Предупреждение

Теперь этот API является нерекомендуемым.

Use joinCall(options?:JoinCallOptions) instead.

Присоединяйтесь к вызову с микрофоном изначально вкл./выкл.

function joinCall(microphoneOn?: boolean): undefined | Call

Параметры

microphoneOn

boolean

Если микрофон изначально включен

Возвращаемое значение

undefined | Call

joinCall(JoinCallOptions)

Присоединиться к вызову с помощью контейнера опций для установки начального состояния микрофона/камеры при присоединении к вызову true = включить устройство при присоединении к вызову false = выключить устройство при присоединении к вызову 'keep'/undefined = сохранить состояние устройства перед вызовом

function joinCall(options?: JoinCallOptions): undefined | Call

Параметры

options

JoinCallOptions

param для первоначальной установки микрофона/камеры вкл/выключения/использования состояния предварительного вызова.

Возвращаемое значение

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Запустите звонок.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | Call

Параметры

participants

CommunicationIdentifier[]

Массив для вызова <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>

options

StartCallOptions

Возвращаемое значение

undefined | Call

startCall(string[], StartCallOptions)

Запустите звонок.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

Параметры

participants

string[]

Массив идентификаторов участников для присоединения

options

StartCallOptions

Возвращаемое значение

undefined | Call

Сведения о наследуемом методе

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Параметры

participant

CommunicationUserIdentifier

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Добавьте участника в вызов.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Параметры

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.addParticipant

askDevicePermission(PermissionConstraints)

Запрашивать разрешения устройств.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

Параметры

constrain

PermissionConstraints

Определение ограничений для доступа к локальным устройствам <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Возвращаемое значение

Promise<DeviceAccess>

Комментарии

Откроется окно разрешений браузера, если разрешения еще не предоставлены

унаследовано отCommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Создайте html-представление для потока.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Параметры

remoteUserId

string

Идентификатор участника для отрисовки, оставьте его неопределенным, чтобы создать локальное представление камеры

options

VideoStreamOptions

Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Возвращаемое значение

Promise<void | CreateVideoStreamViewResult>

Комментарии

Этот метод реализуется для составного

наследуется отCommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Создайте html-представление для потока.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Параметры

options

TogetherModeStreamOptions

Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Возвращаемое значение

Promise<void | TogetherModeStreamViewResult>

Комментарии

Этот метод реализуется для составного

Наследуется отCommonCallAdapter.createTogetherModeStreamView

dispose()

Удаление составного

function dispose()

унаследован отCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Удаление html-представления для локального видеопотока

function disposeLocalVideoStreamView(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Удаление html-представления для удаленного видеопотока

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Параметры

remoteUserId

string

ID участника для утилизации

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Удаление HTML-представления для потока демонстрации экрана

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Параметры

remoteUserId

string

Идентификатор участника, для которого будет распоряжаться просмотром потока демонстрации экрана.

Возвращаемое значение

Promise<void>

Комментарии

Этот метод реализован для композитных

Наследуется отCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Удалите html-представление для потока.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Параметры

remoteUserId

string

Идентификатор участника для отрисовки, оставьте его неопределенным, чтобы удалить представление локальной камеры

options

VideoStreamOptions

Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Возвращаемое значение

Promise<void>

Комментарии

Этот метод реализуется для составного

унаследовано отCommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

Удалите html-представление для потока.

function disposeTogetherModeStreamView(): Promise<void>

Возвращаемое значение

Promise<void>

Комментарии

Этот метод реализуется для составного

Наследуется отCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Запретите озвучивание участников собрания Teams по идентификаторам пользователей.

function forbidAudio(userIds: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.forbidAudio

forbidOthersAudio()

Запретить аудио собрания Teams.

function forbidOthersAudio(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Запретить видео собрания Teams.

function forbidOthersVideo(): Promise<void>

Возвращаемое значение

Promise<void>

Унаследовано отCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Запретите участникам собрания Teams видео по их идентификаторам пользователей.

function forbidVideo(userIds: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.forbidVideo

getState()

Получение текущего состояния

function getState(): CallAdapterState

Возвращаемое значение

CallAdapterState

унаследован отCommonCallAdapter.getState

holdCall()

Держит вызов.

function holdCall(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.holdCall

leaveCall(boolean)

Оставьте звонок

function leaveCall(forEveryone?: boolean): Promise<void>

Параметры

forEveryone

boolean

Удаление всех участников при выходе

Возвращаемое значение

Promise<void>

унаследовано отCommonCallAdapter.leaveCall

lowerHand()

Нижняя рука для текущего пользователя

function lowerHand(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.lowerHand

mute()

Отключение текущего пользователя во время вызова или отключения микрофона локально

function mute(): Promise<void>

Возвращаемое значение

Promise<void>

унаследовано отCommonCallAdapter.mute

muteAllRemoteParticipants()

Отключить звук Все участники

function muteAllRemoteParticipants(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Отключение звука участника

function muteParticipant(userId: string): Promise<void>

Параметры

userId

string

ID участника для отключения звука

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Функция отписки для события 'breakoutRoomsUpdated'.

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Параметры

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

наследуется отCommonCallAdapter.off

off("callEnded", CallEndedListener)

Отмена подписки функции для события callEnded.

function off(event: "callEnded", listener: CallEndedListener)

Параметры

event

"callEnded"

listener

CallEndedListener

наследуется отCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Отмена подписки функции для события callIdChanged.

function off(event: "callIdChanged", listener: CallIdChangedListener)

Параметры

event

"callIdChanged"

listener

CallIdChangedListener

наследуется отCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Функция отписки для события 'capabilitiesChanged'.

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Параметры

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

наследуется отCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Функция отписки для события 'captionsReceived'.

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Параметры

event

"captionsReceived"

listener

CaptionsReceivedListener

наследуется отCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Отмена подписки для события "diagnosticChanged".

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Параметры

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

наследуется отCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Отмена подписки для события displayNameChanged.

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Параметры

event

"displayNameChanged"

listener

DisplayNameChangedListener

наследуется отCommonCallAdapter.off

off("error", (e: AdapterError) => void)

Отмена подписки функции для события error.

function off(event: "error", listener: (e: AdapterError) => void)

Параметры

event

"error"

listener

(e: AdapterError) => void

наследуется отCommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Функция отписки для события 'isCaptionLanguageChanged'.

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Параметры

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

наследуется отCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Функция отписки для события 'isCaptionsActiveChanged'.

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Параметры

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

наследуется отCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Отмена подписки для события isLocalScreenSharingActiveChanged.

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Параметры

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

наследуется отCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Отмена подписки для события IsMutedChanged.

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Параметры

event

"isMutedChanged"

listener

IsMutedChangedListener

наследуется отCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Отмена подписки для события isSpeakingChanged.

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Параметры

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

наследуется отCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Функция отписки для события 'isSpokenLanguageChanged'.

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Параметры

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

наследуется отCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Функция отписки для события 'mutedByOthers'.

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

Параметры

event

"mutedByOthers"

listener

PropertyChangedEvent

наследуется отCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Отмена подписки функции для события "participantsJoined".

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Параметры

event

"participantsJoined"

listener

ParticipantsJoinedListener

наследуется отCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Отмена подписки функции для события "participantsLeft".

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Параметры

event

"participantsLeft"

listener

ParticipantsLeftListener

наследуется отCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Функция отписки для события 'realTimeTextReceived'.

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Параметры

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

наследуется отCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Функция отписки для события roleChanged.

function off(event: "roleChanged", listener: PropertyChangedEvent)

Параметры

event

"roleChanged"

listener

PropertyChangedEvent

наследуется отCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Отмена подписки для события selectedMicrophoneChanged.

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Параметры

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

наследуется отCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Отмена подписки функции для события selectedSpeakerChanged.

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Параметры

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

наследуется отCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Функция отписки для события 'spotlightChanged'.

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Параметры

event

"spotlightChanged"

listener

SpotlightChangedListener

наследуется отCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Функция отписки для события 'transferRequested'.

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Параметры

event

"transferAccepted"

listener

TransferAcceptedListener

наследуется отCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Отменяет подписку обработчика на события stateChanged.

function offStateChange(handler: (state: CallAdapterState) => void)

Параметры

handler

(state: CallAdapterState) => void

унаследовано отCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Функция подписки на событие 'breakoutRoomsUpdated'.

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Параметры

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

унаследован отCommonCallAdapter.on

on("callEnded", CallEndedListener)

Функция подписки для события callEnded.

function on(event: "callEnded", listener: CallEndedListener)

Параметры

event

"callEnded"

listener

CallEndedListener

унаследован отCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Функция подписки для события CallIdChanged.

function on(event: "callIdChanged", listener: CallIdChangedListener)

Параметры

event

"callIdChanged"

listener

CallIdChangedListener

Комментарии

Событие будет активировано при изменении идентификатора вызова текущего пользователя.

унаследован отCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Функция подписки на событие 'capabilitiesChanged'.

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Параметры

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

унаследован отCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Функция подписки на событие 'captionsReceived'.

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Параметры

event

"captionsReceived"

listener

CaptionsReceivedListener

унаследован отCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Функция подписки для события "diagnosticChanged".

Это событие возникает всякий раз, когда возникает изменение системы диагностики пользователей по поводу текущего вызова.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Параметры

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

унаследован отCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Функция подписки для события DisplayNameChanged.

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Параметры

event

"displayNameChanged"

listener

DisplayNameChangedListener

унаследован отCommonCallAdapter.on

on("error", (e: AdapterError) => void)

Функция подписки для события error.

function on(event: "error", listener: (e: AdapterError) => void)

Параметры

event

"error"

listener

(e: AdapterError) => void

унаследован отCommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Функция subscribe для события 'isCaptionLanguageChanged'.

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Параметры

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

унаследован отCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Функция подписки на событие 'isCaptionsActiveChanged'.

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Параметры

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

унаследован отCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Функция подписки для события isLocalScreenSharingActiveChanged.

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Параметры

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

унаследован отCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Функция подписки для события IsMutedChanged.

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Параметры

event

"isMutedChanged"

listener

IsMutedChangedListener

Комментарии

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

унаследован отCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Функция подписки для события IsSpeakingChanged.

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Параметры

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

унаследован отCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Функция подписки на событие 'isSpokenLanguageChanged'.

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Параметры

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

унаследован отCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Функция subscribe для события 'mutedByOthers'.

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

Параметры

event

"mutedByOthers"

listener

PropertyChangedEvent

унаследован отCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Функция подписки для события "participantsJoined".

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Параметры

event

"participantsJoined"

listener

ParticipantsJoinedListener

унаследован отCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Функция подписки для события "participantsLeft".

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Параметры

event

"participantsLeft"

listener

ParticipantsLeftListener

унаследован отCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Функция подписки на событие 'realTimeTextReceived'.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Параметры

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

унаследован отCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Функция подписки на событие roleChanged.

function on(event: "roleChanged", listener: PropertyChangedEvent)

Параметры

event

"roleChanged"

listener

PropertyChangedEvent

унаследован отCommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Функция подписки для события selectedMicrophoneChanged.

Это событие запускается всякий раз, когда пользователь выбирает новое устройство микрофона.

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Параметры

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

унаследован отCommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Функция подписки для события selectedSpeakerChanged.

Это событие запускается всякий раз, когда пользователь выбирает новое устройство говорящего.

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Параметры

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

унаследован отCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Функция подписки на событие 'spotlightChanged'.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Параметры

event

"spotlightChanged"

listener

SpotlightChangedListener

унаследован отCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Функция subscribe для события 'transferRequested'.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Параметры

event

"transferAccepted"

listener

TransferAcceptedListener

унаследован отCommonCallAdapter.on

onReactionClick(Reaction)

Отправить эмодзи на реакцию

function onReactionClick(reaction: Reaction): Promise<void>

Параметры

reaction

Reaction

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Подписывает обработчик на события stateChanged.

function onStateChange(handler: (state: CallAdapterState) => void)

Параметры

handler

(state: CallAdapterState) => void

унаследовано отCommonCallAdapter.onStateChange

permitAudio(string[])

Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.

function permitAudio(userIds: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.permitAudio

permitOthersAudio()

Разрешить аудиозапись собрания Teams.

function permitOthersAudio(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Видео собрания Permission Teams.

function permitOthersVideo(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.

function permitVideo(userIds: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.permitVideo

queryCameras()

Запрос доступных устройств камеры.

function queryCameras(): Promise<VideoDeviceInfo[]>

Возвращаемое значение

Promise<VideoDeviceInfo[]>

Массив сущностей сведений о видеоустройстве <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Комментарии

Этот метод должен вызываться после askDevicePermission()

унаследован отCommonCallAdapter.queryCameras

queryMicrophones()

Запрос доступных устройств микрофона.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Возвращаемое значение

Promise<AudioDeviceInfo[]>

Массив сущностей сведений о звуковом устройстве <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Комментарии

Этот метод должен вызываться после askDevicePermission()

наследуется отCommonCallAdapter.queryMicrophones

querySpeakers()

Запрос доступных акустических устройств.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Возвращаемое значение

Promise<AudioDeviceInfo[]>

Массив сущностей сведений о звуковом устройстве <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Комментарии

Этот метод должен вызываться после askDevicePermission()

Унаследованные отCommonCallAdapter.querySpeakers

raiseHand()

Поднять руку для текущего пользователя

function raiseHand(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.raiseHand

removeParticipant(CommunicationIdentifier)

Удалите участника из вызова.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Параметры

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> участника, подлежащего удалению

Возвращаемое значение

Promise<void>

наследуется отCommonCallAdapter.removeParticipant

removeParticipant(string)

Удалите участника из вызова.

function removeParticipant(userId: string): Promise<void>

Параметры

userId

string

Идентификатор удаляемого участника

Возвращаемое значение

Promise<void>

наследуется отCommonCallAdapter.removeParticipant

resumeCall()

Возобновляет вызов из состояния LocalHold .

function resumeCall(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Возврат к исходному вызову сессионного зала

function returnFromBreakoutRoom(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

отправлять сигнал DTMF другому участнику вызова 1:1 по ТфОП

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Параметры

dtmfTone

DtmfTone

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.sendDtmfTone

setCamera(VideoDeviceInfo, VideoStreamOptions)

Задайте камеру для использования в вызове.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Параметры

sourceInfo

VideoDeviceInfo

Устройство камеры для выбора, выберите один, возвращенный queryCameras

options

VideoStreamOptions

Параметры управления отображением потока камеры <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.setCamera

setCaptionLanguage(string)

Функция для установки языка субтитров

function setCaptionLanguage(language: string): Promise<void>

Параметры

language

string

Набор языков для субтитров

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Задайте микрофон для использования в вызове.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Параметры

sourceInfo

AudioDeviceInfo

Устройство микрофона для выбора, выберите один, возвращенный queryMicrophones

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.setMicrophone

setSpeaker(AudioDeviceInfo)

Задайте динамику для использования в вызове.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Параметры

sourceInfo

AudioDeviceInfo

Устройство говорящего, чтобы выбрать, выберите один, возвращенный querySpeakers

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.setSpeaker

setSpokenLanguage(string)

Функция настройки разговорного языка

function setSpokenLanguage(language: string): Promise<void>

Параметры

language

string

разговорный язык

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Пересчитайте положения сидения для режима «вместе».

function setTogetherModeSceneSize(width: number, height: number)

Параметры

width

number

Ширина контейнера

height

number

Высота контейнера

Комментарии

Этот метод реализуется для составного

Наследуется отCommonCallAdapter.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Запуск камеры Этот метод начнет отрисовку локального представления камеры, если вызов неактивен

function startCamera(options?: VideoStreamOptions): Promise<void>

Параметры

options

VideoStreamOptions

Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.startCamera

startCaptions(StartCaptionsAdapterOptions)

Функция запуска субтитров

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Параметры

options

StartCaptionsAdapterOptions

Варианты начальных субтитров

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Запустите эффект шумоподавления.

function startNoiseSuppressionEffect(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Запустите общий доступ к экрану во время вызова.

function startScreenShare(): Promise<void>

Возвращаемое значение

Promise<void>

наследуется отCommonCallAdapter.startScreenShare

startSpotlight(string[])

Запускайте Spotlight для локальных и удаленных участников по их идентификаторам пользователей. Если массив идентификаторов пользователей не передается, то действие выполняется с локальным участником.

function startSpotlight(userIds?: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.startSpotlight

startTogetherMode()

Запустите режим «Вместе».

function startTogetherMode(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Запустите эффект фона видео.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Параметры

videoBackgroundEffect

VideoBackgroundEffect

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Остановите все прожекторы

function stopAllSpotlight(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.stopAllSpotlight

stopCamera()

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

function stopCamera(): Promise<void>

Возвращаемое значение

Promise<void>

унаследовано отCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Функция для остановки субтитров

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Параметры

options

StopCaptionsAdapterOptions

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Остановите эффект шумоподавления.

function stopNoiseSuppressionEffect(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Остановить общий доступ к экрану

function stopScreenShare(): Promise<void>

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Остановка Spotlight для локальных и удаленных участников по их идентификаторам пользователей. Если массив идентификаторов пользователей не передается, то действие выполняется с локальным участником.

function stopSpotlight(userIds?: string[]): Promise<void>

Параметры

userIds

string[]

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Остановите эффект фона видео.

function stopVideoBackgroundEffects(): Promise<void>

Возвращаемое значение

Promise<void>

Наследуется отCommonCallAdapter.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Отправка результатов опроса по окончании звонка

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Параметры

survey

CallSurvey

Возвращаемое значение

Promise<undefined | CallSurveyResponse>

Наследуется отCommonCallAdapter.submitSurvey

unmute()

Отключение текущего пользователя во время вызова или локального включения микрофона

function unmute(): Promise<void>

Возвращаемое значение

Promise<void>

унаследован отCommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Переопределите изображения в окне выбора фона для получения эффекта замены фона.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Параметры

backgroundImages

VideoBackgroundImage[]

Массив пользовательских фоновых изображений.

Наследуется отCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Обновите выбранный фоновый эффект видео.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Параметры

selectedVideoBackground

VideoBackgroundEffect

Наследуется отCommonCallAdapter.updateSelectedVideoBackgroundEffect