CallWithChatAdapterManagement interface

Пакет:

@azure/communication-react

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

Методы

askDevicePermission(PermissionConstraints)	Запрашивать разрешения устройств.
createStreamView(string, VideoStreamOptions)	Создайте представление HTML для потока.
deleteMessage(string)	Удаление сообщения в потоке.
disposeStreamView(string, VideoStreamOptions)	Удалите представление HTML для потока.
fetchInitialData()	Получение начального состояния для адаптера чата. Выполняет минимальную выборку, необходимую для методов ChatComposite и API.
joinCall(boolean)	Присоединяйтесь к звонку с микрофоном, который изначально включен или выключен.
leaveCall(boolean)	Оставьте звонок.
loadPreviousChatMessages(number)	Загрузите другие предыдущие сообщения в журнале потоков чата.
mute()	Отключите микрофон текущего пользователя во время вызова или отключите микрофон локально.
queryCameras()	Запрос доступных устройств камеры.
queryMicrophones()	Запрос доступных устройств микрофона.
querySpeakers()	Запрос доступных устройств микрофона.
removeParticipant(string)	Удаление участника из вызова.
sendMessage(string, SendMessageOptions)	Отправка сообщения в потоке.
sendReadReceipt(string)	Отправка уведомления о прочтении сообщения.
sendTypingIndicator()	Отправка индикатора ввода в потоке.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Настройте камеру для использования в вызове.
setMicrophone(AudioDeviceInfo)	Задайте микрофон для использования в вызове.
setSpeaker(AudioDeviceInfo)	Настройте динамик для использования в вызове.
startCall(string[], StartCallOptions)	Начните вызов.
startCamera(VideoStreamOptions)	Запустите камеру. Этот метод начнет отрисовку представления локальной камеры, если вызов неактивен.
startScreenShare()	Начните делиться экраном во время звонка.
stopCamera()	Остановите камеру. Этот метод остановит отрисовку представления локальной камеры, если вызов неактивен.
stopScreenShare()	Прекратите общий доступ к экрану.
unmute()	Включите текущий пользователь во время вызова или включите микрофон локально.
updateMessage(string, string, Record<string, string>)	Обновление содержимого сообщения.

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

askDevicePermission(PermissionConstraints)

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

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

Параметры

constrain

PermissionConstraints

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

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

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>

Комментарии

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

deleteMessage(string)

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

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

Параметры

messageId

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>

Комментарии

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

fetchInitialData()

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

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

function fetchInitialData(): Promise<void>

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

Promise<void>

joinCall(boolean)

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

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

Параметры

microphoneOn

boolean

Указывает, включен ли микрофон изначально

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

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>

Комментарии

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

mute()

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

function mute(): Promise<void>

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

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()

removeParticipant(string)

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

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

Параметры

userId

string

UserId удаляемого участника.

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

Promise<void>

sendMessage(string, SendMessageOptions)

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

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

Параметры

content

string

options

SendMessageOptions

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

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

Выберите устройство камеры, возвращаемое запросомCameras

options

VideoStreamOptions

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

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

Promise<void>

setMicrophone(AudioDeviceInfo)

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

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

Параметры

sourceInfo

AudioDeviceInfo

Микрофон для выбора, выберите одно из них, возвращенное запросомMicrophones

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

Promise<void>

setSpeaker(AudioDeviceInfo)

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

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

Параметры

sourceInfo

AudioDeviceInfo

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

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

Promise<void>

startCall(string[], StartCallOptions)

Начните вызов.

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

Параметры

participants

string[]

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

options

StartCallOptions

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

undefined | Call

startCamera(VideoStreamOptions)

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

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

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

Параметры

options

VideoStreamOptions

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

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

Promise<void>

startScreenShare()

Начните делиться экраном во время звонка.

function startScreenShare(): Promise<void>

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

Promise<void>

stopCamera()

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

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

function stopCamera(): Promise<void>

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

Promise<void>

stopScreenShare()

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

function stopScreenShare(): Promise<void>

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

Promise<void>

unmute()

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

function unmute(): Promise<void>

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

Promise<void>

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

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

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

Параметры

messageId

string

content

string

metadata

Record<string, string>

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

Promise<void>