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


CallWithChatAdapterManagement interface

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

Свойства

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)

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

disposeLocalVideoStreamView()

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

disposeRemoteVideoStreamView(string)

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

disposeScreenShareStreamView(string)

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

disposeStreamView(string, VideoStreamOptions)

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

disposeTogetherModeStreamView()

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

downloadResourceToCache(ResourceDetails)
fetchInitialData()

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

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

holdCall()

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

joinCall(boolean)

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

joinCall(JoinCallOptions)

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

leaveCall(boolean)

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

loadPreviousChatMessages(number)

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

lowerHand()

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

mute()

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

muteAllRemoteParticipants()

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

muteParticipant(string)

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

onReactionClick(Reaction)

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

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>

forbidOthersAudio

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

forbidOthersAudio: () => Promise<void>

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

() => Promise<void>

forbidOthersVideo

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

forbidOthersVideo: () => Promise<void>

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

() => Promise<void>

forbidVideo

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

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

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

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

permitAudio

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

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

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

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

permitOthersAudio

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

permitOthersAudio: () => Promise<void>

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

() => Promise<void>

permitOthersVideo

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

permitOthersVideo: () => Promise<void>

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

() => Promise<void>

permitVideo

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

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

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

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

sendDtmfTone

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

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

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

(dtmfTone: DtmfTone) => Promise<void>

sendRealTimeText

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

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

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

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

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

addParticipant(CommunicationUserIdentifier)

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

Параметры

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

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

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

Параметры

participant
PhoneNumberIdentifier

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

Promise<void>

askDevicePermission(PermissionConstraints)

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

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

Параметры

constrain
PermissionConstraints

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

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

Promise<DeviceAccess>

Комментарии

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

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 для потока togethermode.

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

Параметры

options
TogetherModeStreamOptions

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

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

Комментарии

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

deleteMessage(string)

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

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

Параметры

messageId

string

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

Promise<void>

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)

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

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

Параметры

remoteUserId

string

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

options
VideoStreamOptions

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

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

Promise<void>

Комментарии

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

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

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

Promise<void>

Комментарии

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

downloadResourceToCache(ResourceDetails)

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

Параметры

resourceDetails
ResourceDetails

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

Promise<void>

fetchInitialData()

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

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

function fetchInitialData(): Promise<void>

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

Promise<void>

holdCall()

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

function holdCall(): Promise<void>

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

Promise<void>

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

leaveCall(boolean)

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

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

Параметры

forEveryone

boolean

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

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

Promise<void>

loadPreviousChatMessages(number)

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

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

Параметры

messagesToLoad

number

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

Promise<boolean>

Комментарии

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

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

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

Promise<void>

onReactionClick(Reaction)

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

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

Параметры

reaction
Reaction

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

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

Promise<void>

queryCameras()

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

function queryCameras(): Promise<VideoDeviceInfo[]>

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

Promise<VideoDeviceInfo[]>

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

Комментарии

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

queryMicrophones()

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

function queryMicrophones(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

Комментарии

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

querySpeakers()

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

function querySpeakers(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

Комментарии

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

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

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

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

Promise<void>

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Параметры

resourceDetails
ResourceDetails

resumeCall()

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

function resumeCall(): Promise<void>

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

Promise<void>

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

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

Promise<void>

sendMessage(string, SendMessageOptions)

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

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

Параметры

content

string

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

Promise<void>

sendReadReceipt(string)

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

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

Параметры

chatMessageId

string

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

Promise<void>

sendTypingIndicator()

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

function sendTypingIndicator(): Promise<void>

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

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

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

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

Параметры

sourceInfo
VideoDeviceInfo

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

options
VideoStreamOptions

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

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

Promise<void>

setCaptionLanguage(string)

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

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

Параметры

language

string

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

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

Promise<void>

setMicrophone(AudioDeviceInfo)

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

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

Параметры

sourceInfo
AudioDeviceInfo

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

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

Promise<void>

setSpeaker(AudioDeviceInfo)

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

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

Параметры

sourceInfo
AudioDeviceInfo

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

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

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

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

Комментарии

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

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

startCall(string[], StartCallOptions)

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

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

Параметры

participants

string[]

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

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

undefined | Call

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[])

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

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>

Параметры

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

Promise<void>

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

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

Promise<void>

stopScreenShare()

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

function stopScreenShare(): Promise<void>

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

Promise<void>

stopSpotlight(string[])

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

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[]

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

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>

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

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

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Параметры

selectedVideoBackground
VideoBackgroundEffect