Поделиться через


CallWithChatAdapter interface

Extends

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

forbidAudio

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

forbidOthersAudio

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

forbidOthersVideo

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

forbidVideo

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

permitAudio

Разрешает аудио для указанных идентификаторов пользователей.

permitOthersAudio

разрешает воспроизведение звука для участников собрания Teams, за исключением локального пользователя.

permitOthersVideo

разрешает видео для участников собрания Teams, за исключением локального пользователя.

permitVideo

Разрешает видео для указанных идентификаторов пользователей.

sendDtmfTone

Отправка сигнала DTMF другому участнику звонка в режиме вызовов 1:1

sendRealTimeText

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

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

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

askDevicePermission(PermissionConstraints)

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

createStreamView(string, VideoStreamOptions)

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

createTogetherModeStreamView(TogetherModeStreamOptions)

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

deleteMessage(string)

Удаление сообщения в потоке.

dispose()

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

disposeLocalVideoStreamView()

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

disposeRemoteVideoStreamView(string)

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

disposeScreenShareStreamView(string)

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

disposeStreamView(string, VideoStreamOptions)

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

disposeTogetherModeStreamView()

Отрегулируйте представление HTML для потока togethermode.

downloadResourceToCache(ResourceDetails)
fetchInitialData()

Получение начального состояния адаптера чата.

Выполняет минимальное получение, необходимое для методов ChatComposite и API.

getState()

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

holdCall()

Переводит вызов в локальный холд.

joinCall(boolean)

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

joinCall(JoinCallOptions)

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

leaveCall(boolean)

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

loadPreviousChatMessages(number)

Загрузите дополнительные предыдущие сообщения в журнале потоков чата.

lowerHand()

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

mute()

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

muteAllRemoteParticipants()

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

muteParticipant(string)

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

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)

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

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)

Отправьте реакцию на текущую встречу.

onStateChange((state: CallWithChatAdapterState) => void)

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

queryCameras()

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

queryMicrophones()

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

querySpeakers()

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

raiseHand()

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

removeParticipant(CommunicationIdentifier)

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

removeParticipant(string)

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

removeResourceFromCache(ResourceDetails)
resumeCall()

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

returnFromBreakoutRoom()

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

sendMessage(string, SendMessageOptions)

Отправьте сообщение в потоке.

sendReadReceipt(string)

Отправьте квитанцию о чтении сообщения.

sendTypingIndicator()

Отправка индикатора ввода текста в потоке.

setCamera(VideoDeviceInfo, VideoStreamOptions)

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

setCaptionLanguage(string)

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

setMicrophone(AudioDeviceInfo)

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

setSpeaker(AudioDeviceInfo)

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

setSpokenLanguage(string)

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

setTogetherModeSceneSize(number, number)

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

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

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

startCall(string[], StartCallOptions)

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

startCamera(VideoStreamOptions)

Запустите камеру.

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

startCaptions(StartCaptionsAdapterOptions)

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

startNoiseSuppressionEffect()

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

startScreenShare()

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

startSpotlight(string[])

Стартовый прожектор

startTogetherMode()

Режим запуска вместе.

startVideoBackgroundEffect(VideoBackgroundEffect)

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

stopAllSpotlight()

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

stopCamera()

Остановите камеру.

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

stopCaptions(StopCaptionsAdapterOptions)

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

stopNoiseSuppressionEffect()

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

stopScreenShare()

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

stopSpotlight(string[])

Стоп-прожектор

stopVideoBackgroundEffects()

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

submitSurvey(CallSurvey)

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

unmute()

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

updateBackgroundPickerImages(VideoBackgroundImage[])

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

updateMessage(string, string, Record<string, string>)

Обновление содержимого сообщения.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Обновление выбранного фонового эффекта видео

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

forbidAudio

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

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

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

(userIds: string[]) => Promise<void>

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

forbidOthersAudio

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

forbidOthersAudio: () => Promise<void>

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

() => Promise<void>

Унаследовано отCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

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

forbidOthersVideo: () => Promise<void>

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

() => Promise<void>

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

forbidVideo

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

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

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

(userIds: string[]) => Promise<void>

Унаследовано отCallWithChatAdapterManagement.forbidVideo

permitAudio

Разрешает аудио для указанных идентификаторов пользователей.

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

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

(userIds: string[]) => Promise<void>

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

permitOthersAudio

разрешает воспроизведение звука для участников собрания Teams, за исключением локального пользователя.

permitOthersAudio: () => Promise<void>

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

() => Promise<void>

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

permitOthersVideo

разрешает видео для участников собрания Teams, за исключением локального пользователя.

permitOthersVideo: () => Promise<void>

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

() => Promise<void>

Унаследовано отCallWithChatAdapterManagement.permitOthersVideo

permitVideo

Разрешает видео для указанных идентификаторов пользователей.

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

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

(userIds: string[]) => Promise<void>

Унаследовано отCallWithChatAdapterManagement.permitVideo

sendDtmfTone

Отправка сигнала DTMF другому участнику звонка в режиме вызовов 1:1

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

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

(dtmfTone: DtmfTone) => Promise<void>

наследуется отCallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

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

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

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

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

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

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

addParticipant(CommunicationUserIdentifier)

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

Параметры

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

Promise<void>

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

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

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

Параметры

participant
PhoneNumberIdentifier

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

Promise<void>

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

askDevicePermission(PermissionConstraints)

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

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

Параметры

constrain
PermissionConstraints

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

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

Promise<DeviceAccess>

Комментарии

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

унаследован отCallWithChatAdapterManagement.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>

Комментарии

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

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

createTogetherModeStreamView(TogetherModeStreamOptions)

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

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

Параметры

options
TogetherModeStreamOptions

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

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

Комментарии

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

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

deleteMessage(string)

Удаление сообщения в потоке.

function deleteMessage(messageId: string): Promise<void>

Параметры

messageId

string

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

Promise<void>

наследуется отCallWithChatAdapterManagement.deleteMessage

dispose()

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

function dispose()

Наследуется отDisposable_2.dispose

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

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

Promise<void>

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

disposeRemoteVideoStreamView(string)

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

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

Параметры

remoteUserId

string

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

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

Promise<void>

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

disposeScreenShareStreamView(string)

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

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

Параметры

remoteUserId

string

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

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

Promise<void>

Комментарии

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

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

disposeStreamView(string, VideoStreamOptions)

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

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

Параметры

remoteUserId

string

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

options
VideoStreamOptions

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

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

Promise<void>

Комментарии

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

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

disposeTogetherModeStreamView()

Отрегулируйте представление HTML для потока togethermode.

function disposeTogetherModeStreamView(): Promise<void>

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

Promise<void>

Комментарии

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

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

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Параметры

resourceDetails
ResourceDetails

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

Promise<void>

Наследуется отCallWithChatAdapterManagement.downloadResourceToCache

fetchInitialData()

Получение начального состояния адаптера чата.

Выполняет минимальное получение, необходимое для методов ChatComposite и API.

function fetchInitialData(): Promise<void>

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

Promise<void>

наследуется отCallWithChatAdapterManagement.fetchInitialData

getState()

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

function getState(): CallWithChatAdapterState

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

наследуется от адаптера адаптера.getState

holdCall()

Переводит вызов в локальный холд.

function holdCall(): Promise<void>

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

Promise<void>

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

joinCall(boolean)

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

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

Use joinCall(options?:JoinCallOptions) instead.

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

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

Параметры

microphoneOn

boolean

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

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

undefined | Call

наследуется отCallWithChatAdapterManagement.joinCall

joinCall(JoinCallOptions)

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

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

Параметры

options
JoinCallOptions

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

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

undefined | Call

наследуется отCallWithChatAdapterManagement.joinCall

leaveCall(boolean)

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

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

Параметры

forEveryone

boolean

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

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

Promise<void>

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

loadPreviousChatMessages(number)

Загрузите дополнительные предыдущие сообщения в журнале потоков чата.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Параметры

messagesToLoad

number

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

Promise<boolean>

Комментарии

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

наследуется отCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

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

function lowerHand(): Promise<void>

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

Promise<void>

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

mute()

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

function mute(): Promise<void>

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

Promise<void>

наследуется отCallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

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

function muteAllRemoteParticipants(): Promise<void>

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

Promise<void>

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

muteParticipant(string)

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

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

Параметры

userId

string

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

Promise<void>

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

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Параметры

event

"breakoutRoomsUpdated"

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

off("callEnded", CallEndedListener)

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

Параметры

event

"callEnded"

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

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

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

Параметры

event

"callError"

listener

(e: AdapterError) => void

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

off("callIdChanged", CallIdChangedListener)

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

Параметры

event

"callIdChanged"

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

off("callParticipantsJoined", ParticipantsJoinedListener)

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

Параметры

event

"callParticipantsJoined"

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

off("callParticipantsLeft", ParticipantsLeftListener)

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

Параметры

event

"callParticipantsLeft"

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

off("capabilitiesChanged", CapabilitiesChangedListener)

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

Параметры

event

"capabilitiesChanged"

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

off("captionsReceived", CaptionsReceivedListener)

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

Параметры

event

"captionsReceived"

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

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

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

Параметры

event

"chatError"

listener

(e: AdapterError) => void

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

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Параметры

event

"chatInitialized"

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

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Параметры

event

"chatParticipantsAdded"

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

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Параметры

event

"chatParticipantsRemoved"

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

off("displayNameChanged", DisplayNameChangedListener)

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

Параметры

event

"displayNameChanged"

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

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Параметры

event

"isCaptionLanguageChanged"

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

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Параметры

event

"isCaptionsActiveChanged"

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

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Параметры

event

"isLocalScreenSharingActiveChanged"

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

off("isMutedChanged", IsMutedChangedListener)

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

Параметры

event

"isMutedChanged"

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

off("isSpeakingChanged", IsSpeakingChangedListener)

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

Параметры

event

"isSpeakingChanged"

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

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Параметры

event

"isSpokenLanguageChanged"

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

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Параметры

event

"messageDeleted"

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

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Параметры

event

"messageEdited"

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

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Параметры

event

"messageRead"

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

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Параметры

event

"messageReceived"

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

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Параметры

event

"messageSent"

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

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

Параметры

event

"realTimeTextReceived"

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

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

Параметры

event

"selectedMicrophoneChanged"

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

off("selectedSpeakerChanged", PropertyChangedEvent)

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

Параметры

event

"selectedSpeakerChanged"

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

off("spotlightChanged", SpotlightChangedListener)

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

Параметры

event

"spotlightChanged"

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

offStateChange((state: CallWithChatAdapterState) => void)

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

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

Параметры

handler

(state: CallWithChatAdapterState) => void

наследуется от адаптера адаптера.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Параметры

event

"breakoutRoomsUpdated"

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

on("callEnded", CallEndedListener)

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

Параметры

event

"callEnded"

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

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

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

Параметры

event

"callError"

listener

(e: AdapterError) => void

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

on("callIdChanged", CallIdChangedListener)

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

Параметры

event

"callIdChanged"

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

on("callParticipantsJoined", ParticipantsJoinedListener)

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

Параметры

event

"callParticipantsJoined"

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

on("callParticipantsLeft", ParticipantsLeftListener)

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

Параметры

event

"callParticipantsLeft"

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

on("capabilitiesChanged", CapabilitiesChangedListener)

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

Параметры

event

"capabilitiesChanged"

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

on("captionsReceived", CaptionsReceivedListener)

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

Параметры

event

"captionsReceived"

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

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

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

Параметры

event

"chatError"

listener

(e: AdapterError) => void

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

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Параметры

event

"chatInitialized"

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

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Параметры

event

"chatParticipantsAdded"

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

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Параметры

event

"chatParticipantsRemoved"

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

on("displayNameChanged", DisplayNameChangedListener)

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

Параметры

event

"displayNameChanged"

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

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Параметры

event

"isCaptionLanguageChanged"

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

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Параметры

event

"isCaptionsActiveChanged"

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

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Параметры

event

"isLocalScreenSharingActiveChanged"

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

on("isMutedChanged", IsMutedChangedListener)

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

Параметры

event

"isMutedChanged"

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

on("isSpeakingChanged", IsSpeakingChangedListener)

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

Параметры

event

"isSpeakingChanged"

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

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Параметры

event

"isSpokenLanguageChanged"

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

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Параметры

event

"messageDeleted"

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

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Параметры

event

"messageEdited"

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

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Параметры

event

"messageRead"

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

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Параметры

event

"messageReceived"

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

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Параметры

event

"messageSent"

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

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

Параметры

event

"realTimeTextReceived"

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

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Параметры

event

"selectedMicrophoneChanged"

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

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Параметры

event

"selectedSpeakerChanged"

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

on("spotlightChanged", SpotlightChangedListener)

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

Параметры

event

"spotlightChanged"

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

onReactionClick(Reaction)

Отправьте реакцию на текущую встречу.

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

Параметры

reaction
Reaction

Значение типа <xref:%40azure%2Fcommunication-calling%23Reaction>

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

Promise<void>

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

onStateChange((state: CallWithChatAdapterState) => void)

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

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

Параметры

handler

(state: CallWithChatAdapterState) => void

наследуется от адаптера адаптера.onStateChange

queryCameras()

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

function queryCameras(): Promise<VideoDeviceInfo[]>

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

Promise<VideoDeviceInfo[]>

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

Комментарии

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

наследуется отCallWithChatAdapterManagement.queryCameras

queryMicrophones()

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

function queryMicrophones(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

Комментарии

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

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

querySpeakers()

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

function querySpeakers(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

Комментарии

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

наследуется отCallWithChatAdapterManagement.querySpeakers

raiseHand()

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

function raiseHand(): Promise<void>

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

Promise<void>

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

removeParticipant(CommunicationIdentifier)

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

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

Параметры

participant
CommunicationIdentifier

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

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

Promise<void>

унаследован отCallWithChatAdapterManagement.removeParticipant

removeParticipant(string)

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

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

Параметры

userId

string

UserId участника, который нужно удалить.

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

Promise<void>

унаследован отCallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Параметры

resourceDetails
ResourceDetails

Наследуется отCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

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

function resumeCall(): Promise<void>

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

Promise<void>

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

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

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

Promise<void>

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

sendMessage(string, SendMessageOptions)

Отправьте сообщение в потоке.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Параметры

content

string

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

Promise<void>

унаследовано отCallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Отправьте квитанцию о чтении сообщения.

function sendReadReceipt(chatMessageId: string): Promise<void>

Параметры

chatMessageId

string

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

Promise<void>

унаследовано отCallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Отправка индикатора ввода текста в потоке.

function sendTypingIndicator(): Promise<void>

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

Promise<void>

унаследован отCallWithChatAdapterManagement.sendTypingIndicator

setCamera(VideoDeviceInfo, VideoStreamOptions)

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

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

Параметры

sourceInfo
VideoDeviceInfo

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

options
VideoStreamOptions

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

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

Promise<void>

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

setCaptionLanguage(string)

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

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

Параметры

language

string

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

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

Promise<void>

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

setMicrophone(AudioDeviceInfo)

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

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

Параметры

sourceInfo
AudioDeviceInfo

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

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

Promise<void>

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

setSpeaker(AudioDeviceInfo)

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

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

Параметры

sourceInfo
AudioDeviceInfo

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

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

Promise<void>

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

setSpokenLanguage(string)

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

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

Параметры

language

string

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

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

Promise<void>

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

setTogetherModeSceneSize(number, number)

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

function setTogetherModeSceneSize(width: number, height: number)

Параметры

width

number

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

height

number

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

Комментарии

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

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

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

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

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

Параметры

participants

(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

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

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

undefined | Call

наследуется отCallWithChatAdapterManagement.startCall

startCall(string[], StartCallOptions)

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

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

Параметры

participants

string[]

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

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

undefined | Call

наследуется отCallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Запустите камеру.

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

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

Параметры

options
VideoStreamOptions

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

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

Promise<void>

наследуется отCallWithChatAdapterManagement.startCamera

startCaptions(StartCaptionsAdapterOptions)

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

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

Параметры

options
StartCaptionsAdapterOptions

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

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

Promise<void>

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

startNoiseSuppressionEffect()

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

function startNoiseSuppressionEffect(): Promise<void>

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

Promise<void>

наследуется отCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

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

function startScreenShare(): Promise<void>

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

Promise<void>

унаследован отCallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Стартовый прожектор

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

Параметры

userIds

string[]

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

Promise<void>

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

startTogetherMode()

Режим запуска вместе.

function startTogetherMode(): Promise<void>

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

Promise<void>

Комментарии

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

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

startVideoBackgroundEffect(VideoBackgroundEffect)

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

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

Параметры

videoBackgroundEffect
VideoBackgroundEffect

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

Promise<void>

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

stopAllSpotlight()

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

function stopAllSpotlight(): Promise<void>

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

Promise<void>

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

stopCamera()

Остановите камеру.

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

function stopCamera(): Promise<void>

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

Promise<void>

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

stopCaptions(StopCaptionsAdapterOptions)

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

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

Параметры

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

Promise<void>

Унаследовано отCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

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

Promise<void>

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

stopScreenShare()

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

function stopScreenShare(): Promise<void>

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

Promise<void>

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

stopSpotlight(string[])

Стоп-прожектор

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

Параметры

userIds

string[]

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

Promise<void>

Унаследовано отCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

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

function stopVideoBackgroundEffects(): Promise<void>

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

Promise<void>

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

submitSurvey(CallSurvey)

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

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

Параметры

survey
CallSurvey

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

Promise<undefined | CallSurveyResponse>

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

unmute()

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

function unmute(): Promise<void>

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

Promise<void>

наследуется отCallWithChatAdapterManagement.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Параметры

backgroundImages

VideoBackgroundImage[]

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

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

updateMessage(string, string, Record<string, string>)

Обновление содержимого сообщения.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

Параметры

messageId

string

content

string

options

Record<string, string>

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

Promise<void>

унаследован отCallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Обновление выбранного фонового эффекта видео

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Параметры

selectedVideoBackground
VideoBackgroundEffect

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