CommonCallAdapter interface

Ссылка

Пакет:: @azure/communication-react

CallComposite Интерфейс адаптера.

Extends: AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Методы

joinCall(boolean)	Присоединитесь к вызову с микрофоном, который изначально включен или выключен.
startCall(string[], StartCallOptions)	Начните звонок.

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

askDevicePermission(PermissionConstraints)	Запрашивать разрешения устройств.
createStreamView(string, VideoStreamOptions)	Создайте html-представление для потока.
dispose()	Удаление составного элемента
disposeStreamView(string, VideoStreamOptions)	Удалите представление HTML для потока.
getState()	Получение текущего состояния
leaveCall(boolean)	Выйти из звонка
mute()	Отключение звука текущего пользователя во время вызова или локальное отключение микрофона
off("callEnded", CallEndedListener)	Функция отмены подписки на событие callEnded.
off("callIdChanged", CallIdChangedListener)	Отмена подписки на событие callIdChanged.
off("diagnosticChanged", DiagnosticChangedEventListner)	Отмена подписки на событие diagnosticChanged.
off("displayNameChanged", DisplayNameChangedListener)	Отмена подписки на событие "displayNameChanged".
off("error", (e: AdapterError) => void)	Отмена подписки на событие error.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Отмена подписки на событие isLocalScreenSharingActiveChanged.
off("isMutedChanged", IsMutedChangedListener)	Функция отмены подписки для события isMutedChanged.
off("isSpeakingChanged", IsSpeakingChangedListener)	Функция отмены подписки для события isSpeakingChanged.
off("participantsJoined", ParticipantsJoinedListener)	Функция отмены подписки на событие "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Отмена подписки на событие "participantsLeft".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Отмена подписки на событие selectedMicrophoneChanged.
off("selectedSpeakerChanged", PropertyChangedEvent)	Отмена подписки на событие selectedSpeakerChanged.
offStateChange((state: CallAdapterState) => void)	Отменяет подписку обработчика на события stateChanged.
on("callEnded", CallEndedListener)	Функция subscribe для события callEnded.
on("callIdChanged", CallIdChangedListener)	Функция subscribe для события callIdChanged.
on("diagnosticChanged", DiagnosticChangedEventListner)	Функция подписки на событие diagnosticChanged. Это событие возникает всякий раз, когда пользователь сталкивается с изменением диагностика о текущем вызове.
on("displayNameChanged", DisplayNameChangedListener)	Функция subscribe для события displayNameChanged.
on("error", (e: AdapterError) => void)	Функция subscribe для события error.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Функция subscribe для события isLocalScreenSharingActiveChanged.
on("isMutedChanged", IsMutedChangedListener)	Функция subscribe для события isMutedChanged.
on("isSpeakingChanged", IsSpeakingChangedListener)	Функция subscribe для события isSpeakingChanged.
on("participantsJoined", ParticipantsJoinedListener)	Функция subscribe для события "участникиСвязь".
on("participantsLeft", ParticipantsLeftListener)	Функция subscribe для события "participantsLeft".
on("selectedMicrophoneChanged", PropertyChangedEvent)	Функция подписки на событие selectedMicrophoneChanged. Это событие срабатывает всякий раз, когда пользователь выбирает новое микрофонное устройство.
on("selectedSpeakerChanged", PropertyChangedEvent)	Функция subscribe для события selectedSpeakerChanged. Это событие возникает всякий раз, когда пользователь выбирает новое устройство динамиков.
onStateChange((state: CallAdapterState) => void)	Подписывает обработчик на события stateChanged.
queryCameras()	Запрос доступных устройств камеры.
queryMicrophones()	Запрос доступных микрофонных устройств.
querySpeakers()	Запрос доступных микрофонных устройств.
removeParticipant(string)	Удаление участника из вызова.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Задайте камеру для использования в вызове.
setMicrophone(AudioDeviceInfo)	Задайте микрофон для использования в вызове.
setSpeaker(AudioDeviceInfo)	Задайте динамик для использования в вызове.
startCamera(VideoStreamOptions)	Запуск камеры. Этот метод запускает отрисовку представления локальной камеры, когда вызов неактивен
startScreenShare()	Запустите общий доступ к экрану во время звонка.
stopCamera()	Остановка камеры. Этот метод прекращает отрисовку представления локальной камеры, если вызов неактивен
stopScreenShare()	Прекратить общий доступ к экрану
unmute()	Включение микрофона текущего пользователя во время вызова или локальное включение микрофона

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

joinCall(boolean)

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

function joinCall(microphoneOn?: boolean)

Параметры

microphoneOn: boolean

Включен ли микрофон изначально

startCall(string[], StartCallOptions)

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

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

Параметры

participants: string[]

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

options: StartCallOptions

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

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>

dispose()

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

function dispose()

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

disposeStreamView(string, VideoStreamOptions)

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

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

Параметры

remoteUserId: string

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

options: VideoStreamOptions

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

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

Promise<void>

getState()

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

function getState(): CallAdapterState

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

CallAdapterState

Наследуется отAdapterState.getState

leaveCall(boolean)

Выйти из звонка

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

Параметры

forEveryone: boolean

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

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

Promise<void>

Наследуется отCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

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

Promise<void>

Наследуется отCallAdapterCallOperations.mute

off("callEnded", CallEndedListener)

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

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

Параметры

event: "callEnded"

listener: CallEndedListener

Наследуется отCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Отмена подписки на событие callIdChanged.

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

Параметры

event: "callIdChanged"

listener: CallIdChangedListener

Наследуется отCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

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

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

Параметры

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

Наследуется отCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

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

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

Параметры

event: "displayNameChanged"

listener: DisplayNameChangedListener

Наследуется отCallAdapterSubscribers.off

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

Отмена подписки на событие error.

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

Параметры

event: "error"

listener: (e: AdapterError) => void

Наследуется отCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Параметры

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

Наследуется отCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

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

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

Параметры

event: "isMutedChanged"

listener: IsMutedChangedListener

Наследуется отCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

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

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

Параметры

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

Наследуется отCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

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

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

Параметры

event: "participantsJoined"

listener: ParticipantsJoinedListener

Наследуется отCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

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

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

Параметры

event: "participantsLeft"

listener: ParticipantsLeftListener

Наследуется отCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

Параметры

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

Наследуется отCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Отмена подписки на событие selectedSpeakerChanged.

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

Параметры

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

Наследуется отCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

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

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

Параметры

handler: (state: CallAdapterState) => void

Наследуется отAdapterState.offStateChange

on("callEnded", CallEndedListener)

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

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

Параметры

event: "callEnded"

listener: CallEndedListener

Наследуется отCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

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

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

Параметры

event: "callIdChanged"

listener: CallIdChangedListener

on("diagnosticChanged", DiagnosticChangedEventListner)

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

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

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

Параметры

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

Наследуется отCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

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

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

Параметры

event: "displayNameChanged"

listener: DisplayNameChangedListener

Наследуется отCallAdapterSubscribers.on

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

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

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

Параметры

event: "error"

listener: (e: AdapterError) => void

Наследуется отCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Параметры

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

Наследуется отCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

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

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

Параметры

event: "isMutedChanged"

listener: IsMutedChangedListener

on("isSpeakingChanged", IsSpeakingChangedListener)

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

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

Параметры

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

Наследуется отCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Функция subscribe для события "участникиСвязь".

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

Параметры

event: "participantsJoined"

listener: ParticipantsJoinedListener

Наследуется отCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

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

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

Параметры

event: "participantsLeft"

listener: ParticipantsLeftListener

Наследуется отCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

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

Параметры

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

Наследуется отCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

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

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

Параметры

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

Наследуется отCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

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

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

Параметры

handler: (state: CallAdapterState) => void

Наследуется отAdapterState.onStateChange

queryCameras()

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

function queryCameras(): Promise<VideoDeviceInfo[]>

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

Promise<VideoDeviceInfo[]>

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

queryMicrophones()

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

function queryMicrophones(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

querySpeakers()

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

function querySpeakers(): Promise<AudioDeviceInfo[]>

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

Promise<AudioDeviceInfo[]>

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

removeParticipant(string)

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

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

Параметры

userId: string

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

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

Promise<void>

Наследуется отCallAdapterCallOperations.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

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

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

Параметры

sourceInfo: VideoDeviceInfo

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

options: VideoStreamOptions

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

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

Promise<void>

Наследуется отCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

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

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

Параметры

sourceInfo: AudioDeviceInfo

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

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

Promise<void>

Наследуется отCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

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

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

Параметры

sourceInfo: AudioDeviceInfo

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

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

Promise<void>

Наследуется отCallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

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

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

Параметры

options: VideoStreamOptions

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

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

Promise<void>

Наследуется отCallAdapterCallOperations.startCamera

startScreenShare()

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

function startScreenShare(): Promise<void>

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

Promise<void>

Наследуется отCallAdapterCallOperations.startScreenShare

stopCamera()

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

function stopCamera(): Promise<void>

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

Promise<void>

Наследуется отCallAdapterCallOperations.stopCamera

stopScreenShare()

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

function stopScreenShare(): Promise<void>

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

Promise<void>

Наследуется отCallAdapterCallOperations.stopScreenShare

unmute()

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

function unmute(): Promise<void>

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

Promise<void>

Наследуется отCallAdapterCallOperations.unmute

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

CommonCallAdapter interface

Методы

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

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

joinCall(boolean)

Параметры

startCall(string[], StartCallOptions)

Параметры

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

askDevicePermission(PermissionConstraints)

Параметры

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

Комментарии

createStreamView(string, VideoStreamOptions)

Параметры

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

Комментарии

dispose()

disposeStreamView(string, VideoStreamOptions)

Параметры

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

Комментарии

getState()

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

leaveCall(boolean)

Параметры

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

mute()

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

off("callEnded", CallEndedListener)

Параметры

off("callIdChanged", CallIdChangedListener)

Параметры

off("diagnosticChanged", DiagnosticChangedEventListner)

Параметры

off("displayNameChanged", DisplayNameChangedListener)

Параметры

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

Параметры

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Параметры

off("isMutedChanged", IsMutedChangedListener)

Параметры

off("isSpeakingChanged", IsSpeakingChangedListener)

Параметры

off("participantsJoined", ParticipantsJoinedListener)

Параметры

off("participantsLeft", ParticipantsLeftListener)

Параметры

off("selectedMicrophoneChanged", PropertyChangedEvent)

Параметры

off("selectedSpeakerChanged", PropertyChangedEvent)

Параметры

offStateChange((state: CallAdapterState) => void)

Параметры

on("callEnded", CallEndedListener)

Параметры

on("callIdChanged", CallIdChangedListener)

Параметры

Комментарии

on("diagnosticChanged", DiagnosticChangedEventListner)

Параметры

on("displayNameChanged", DisplayNameChangedListener)

Параметры

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

Параметры

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Параметры

on("isMutedChanged", IsMutedChangedListener)

Параметры

Комментарии

on("isSpeakingChanged", IsSpeakingChangedListener)

Параметры

on("participantsJoined", ParticipantsJoinedListener)

Параметры

on("participantsLeft", ParticipantsLeftListener)

Параметры

on("selectedMicrophoneChanged", PropertyChangedEvent)

Параметры