CallAdapterCallOperations interface

Пакет:

@azure/communication-react

Функции управления текущим вызовом.

Свойства

sendRealTimeText

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

Методы

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Добавьте участника в вызов.
createStreamView(string, VideoStreamOptions)	Создайте html-представление для потока.
createTogetherModeStreamView(TogetherModeStreamOptions)	Создайте html-представление для потока.
disposeLocalVideoStreamView()	Удаление html-представления для локального видеопотока
disposeRemoteVideoStreamView(string)	Удаление html-представления для удаленного видеопотока
disposeScreenShareStreamView(string)	Удаление HTML-представления для потока демонстрации экрана
disposeStreamView(string, VideoStreamOptions)	Удалите html-представление для потока.
disposeTogetherModeStreamView()	Удалите html-представление для потока.
forbidAudio(string[])	Запретите озвучивание участников собрания Teams по идентификаторам пользователей.
forbidOthersAudio()	Запретить аудио собрания Teams.
forbidOthersVideo()	Запретить видео собрания Teams.
forbidVideo(string[])	Запретите участникам собрания Teams видео по их идентификаторам пользователей.
holdCall()	Держит вызов.
leaveCall(boolean)	Оставьте звонок
lowerHand()	Нижняя рука для текущего пользователя
mute()	Отключение текущего пользователя во время вызова или отключения микрофона локально
muteAllRemoteParticipants()	Отключить звук Все участники
muteParticipant(string)	Отключение звука участника
onReactionClick(Reaction)	Отправить эмодзи на реакцию
permitAudio(string[])	Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.
permitOthersAudio()	Разрешить аудиозапись собрания Teams.
permitOthersVideo()	Видео собрания Permission Teams.
permitVideo(string[])	Разрешите участникам собраний Teams озвучивать звук по их идентификаторам пользователей.
raiseHand()	Поднять руку для текущего пользователя
removeParticipant(CommunicationIdentifier)	Удалите участника из вызова.
removeParticipant(string)	Удалите участника из вызова.
resumeCall()	Возобновляет вызов из состояния LocalHold .
returnFromBreakoutRoom()	Возврат к исходному вызову сессионного зала
sendDtmfTone(DtmfTone)	отправлять сигнал DTMF другому участнику вызова 1:1 по ТфОП
setCaptionLanguage(string)	Функция для установки языка субтитров
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>

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

addParticipant(CommunicationUserIdentifier)

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

Параметры

participant

CommunicationUserIdentifier

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

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

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

Параметры

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

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

Promise<void>

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>

Комментарии

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

createTogetherModeStreamView(TogetherModeStreamOptions)

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

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

Параметры

options

TogetherModeStreamOptions

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

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

Promise<void | TogetherModeStreamViewResult>

Комментарии

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

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

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

Promise<void>

disposeRemoteVideoStreamView(string)

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

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

Параметры

remoteUserId

string

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

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

Promise<void>

disposeScreenShareStreamView(string)

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

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

Параметры

remoteUserId

string

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

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

Promise<void>

Комментарии

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

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>

Комментарии

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

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

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

Promise<void>

Комментарии

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

forbidAudio(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

forbidOthersAudio()

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

function forbidOthersAudio(): Promise<void>

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

Promise<void>

forbidOthersVideo()

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

function forbidOthersVideo(): Promise<void>

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

Promise<void>

forbidVideo(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

holdCall()

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

function holdCall(): Promise<void>

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

Promise<void>

leaveCall(boolean)

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

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

Параметры

forEveryone

boolean

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

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

Promise<void>

lowerHand()

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

function lowerHand(): Promise<void>

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

Promise<void>

mute()

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

function mute(): Promise<void>

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

Promise<void>

muteAllRemoteParticipants()

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

function muteAllRemoteParticipants(): Promise<void>

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

Promise<void>

muteParticipant(string)

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

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

Параметры

userId

string

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

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

Promise<void>

onReactionClick(Reaction)

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

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

Параметры

reaction

Reaction

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

Promise<void>

permitAudio(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

permitOthersAudio()

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

function permitOthersAudio(): Promise<void>

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

Promise<void>

permitOthersVideo()

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

function permitOthersVideo(): Promise<void>

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

Promise<void>

permitVideo(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

raiseHand()

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

function raiseHand(): Promise<void>

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

Promise<void>

removeParticipant(CommunicationIdentifier)

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

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

Параметры

participant

CommunicationIdentifier

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

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

Promise<void>

removeParticipant(string)

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

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

Параметры

userId

string

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

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

Promise<void>

resumeCall()

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

function resumeCall(): Promise<void>

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

Promise<void>

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

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

Promise<void>

sendDtmfTone(DtmfTone)

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

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

Параметры

dtmfTone

DtmfTone

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

Promise<void>

setCaptionLanguage(string)

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

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

Параметры

language

string

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

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

Promise<void>

setSpokenLanguage(string)

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

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

Параметры

language

string

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

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

Promise<void>

setTogetherModeSceneSize(number, number)

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

function setTogetherModeSceneSize(width: number, height: number)

Параметры

width

number

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

height

number

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

Комментарии

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

startCamera(VideoStreamOptions)

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

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

Параметры

options

VideoStreamOptions

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

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

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

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

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

Параметры

options

StartCaptionsAdapterOptions

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

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

Promise<void>

startNoiseSuppressionEffect()

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

function startNoiseSuppressionEffect(): Promise<void>

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

Promise<void>

startScreenShare()

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

function startScreenShare(): Promise<void>

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

Promise<void>

startSpotlight(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

startTogetherMode()

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

function startTogetherMode(): Promise<void>

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

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

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

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

Параметры

videoBackgroundEffect

VideoBackgroundEffect

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

Promise<void>

stopAllSpotlight()

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

function stopAllSpotlight(): Promise<void>

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

Promise<void>

stopCamera()

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

function stopCamera(): Promise<void>

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

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

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

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

Параметры

options

StopCaptionsAdapterOptions

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

Promise<void>

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

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

Promise<void>

stopScreenShare()

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

function stopScreenShare(): Promise<void>

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

Promise<void>

stopSpotlight(string[])

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

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

Параметры

userIds

string[]

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

Promise<void>

stopVideoBackgroundEffects()

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

function stopVideoBackgroundEffects(): Promise<void>

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

Promise<void>

submitSurvey(CallSurvey)

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

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

Параметры

survey

CallSurvey

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

Promise<undefined | CallSurveyResponse>

unmute()

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

function unmute(): Promise<void>

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

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Параметры

backgroundImages

VideoBackgroundImage[]

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

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

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

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Параметры

selectedVideoBackground

VideoBackgroundEffect