Call interface

Пакет:

@azure/communication-calling

Представляет вызов.

Extends

CallCommon

Свойства

info	Получение сведений об этом вызове.

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

callEndReason	Содержащий код или вложенный код, указывающий, как закончился этот вызов.
callerInfo	Сведения о вызывающем объекте, если этот вызов входящий.
direction	Получите направление вызова, будь то входящее или исходящее.
id	Получите уникальный идентификатор для этого вызова.
isIncomingAudioMuted	Включен ли локальный пользователь входящий звук.
isLocalVideoStarted	Включено ли локальное видео.
isMuted	Независимо от того, отключен ли локальный пользователь локально или удаленно.
isScreenSharingOn	Включен ли общий доступ к экрану.
kind	Получите тип объекта вызова.
lobby	Получите лобби собраний Teams.
localAudioStreams	Коллекция локальных аудиопотоков, отправляемых другим участникам вызова.
localVideoStreams	Коллекция локальных видеопотоков, отправляемых другим участникам вызова.
remoteAudioStreams	Коллекция удаленных аудиопотоков, полученных от вызова.
remoteParticipants	Коллекция удаленных участников этого вызова. В случае звонков с участниками сотни или более, в этой коллекции присутствуют только активные носители.
role	Получите роль локального пользователя в вызове.
state	Получите состояние этого вызова.
totalParticipantCount	Общее количество участников этого вызова.
transferorInfo	Инициатор передачи в случае сценариев передачи и пересылки.

Методы

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Добавьте участника в этот звонок.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Добавьте участника в этот звонок.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Добавьте приложение Teams в этот звонок.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Добавьте участника в этот звонок.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Добавьте участника в этот звонок.
removeParticipant(CommunicationIdentifier)	Удалите участника из этого вызова.

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

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций вызова в этом пакете, например: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Повесить звонок.
hold()	Поместите этот звонок на удержание.
mute()	Отключение локального микрофона.
muteAllRemoteParticipants()	Отключить отключение всех удаленных участников.
muteIncomingAudio()	Отключение входящего звука.
off("callerInfoChanged", PropertyChangedEvent)	Отмена подписки для события изменения сведений вызывающего абонента.
off("idChanged", PropertyChangedEvent)	Отмена подписки функции для события idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Функция подписки для событияIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Отмена подписки для события isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Функция подписки для события IsMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Отмена подписки для событияScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Функция отмены подписки для события localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Отмена подписки для события localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Отмена подписки для события mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Функция отмены подписки для события remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Функция отмены подписки для события remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Отмена подписки для события roleChanged.
off("stateChanged", PropertyChangedEvent)	Отмена подписки для события stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	отмена подписки функции для события totalParticipantCountChanged.
off("transferorInfoChanged", PropertyChangedEvent)	Отмена подписки для события изменения сведений вызывающего абонента.
on("callerInfoChanged", PropertyChangedEvent)	Функция подписки для измененных сведений о вызывающем объекте.
on("idChanged", PropertyChangedEvent)	Функция подписки для события idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Функция подписки для событияIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Функция подписки для события isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Функция подписки для события IsMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Функция подписки для событияScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Функция подписки для события localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Функция подписки для события localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Функция подписки для события mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Функция подписки для события remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Функция подписки для события remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Функция подписки для события roleChanged.
on("stateChanged", PropertyChangedEvent)	Функция подписки для события stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Функция подписки для события totalParticipantCountChanged.
on("transferorInfoChanged", PropertyChangedEvent)	Функция подписки для измененных сведений о вызывающем объекте.
resume()	Возобновите этот вызов, если он находится в состоянии LocalHold.
sendDtmf(DtmfTone)	Отправьте тон DTMF.
setConstraints(CallConstraints)	Задайте ограничения вызовов. Этот метод задает максимальные ограничения на основе указанных значений. Последние примененные ограничения будут меньше или равно значениям, указанным здесь для этого метода. Если задано значение 0, для этого ограничения не будет применено никаких ограничений. Если задано неопределенное значение, то для этого ограничения будет использоваться предыдущее значение.
startAudio(LocalAudioStream)	Запустите звук в вызове с пользовательским звуком. Источник LocalAudioStream должен быть mediaStream.
startScreenSharing()	Начните отправлять поток общего доступа к экранам в вызове. Браузер предложит выбрать экран, приложение или вкладку браузера. Отправка потока общего доступа к экранам не поддерживается в iOS или Android. Входящий поток общего доступа к экранам поддерживается в iOS и Android.
startScreenSharing(LocalVideoStream)	Начните отправлять поток общего доступа к необработанным экранам в вызове. Отправка необработанного общего доступа к экрану не поддерживается в iOS или Android. Входящий необработанный общий доступ к экрану поддерживается в iOS и Android.
startVideo(LocalVideoStream)	Начните отправлять видеопоток в вызове. Удаленные участники звонка получат видеопоток, чтобы он смог отобразить его в своих UIs.
stopAudio()	Остановите пользовательский звук в вызове и переключитесь на звуковое устройство диспетчера устройств по умолчанию.
stopScreenSharing()	Остановите локальный общий доступ к экрану.
stopScreenSharing(LocalVideoStream)	Остановите локальный общий доступ к экрану.
stopVideo(LocalVideoStream)	Остановите отправку видеопотока в вызове. Необходимо передать тот же объект LocalVideoStream, который использовался для запуска видео в API CallAgent.startCall(), API CallAgent.join(), ВходящийCall.accept() или API Call.startVideo().
unmute()	Распакуйте локальный микрофон.
unmuteIncomingAudio()	Отмените входящий звук.

Сведения о свойстве

info

Получение сведений об этом вызове.

info: CallInfo

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

CallInfo

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

callEndReason

Содержащий код или вложенный код, указывающий, как закончился этот вызов.

callEndReason?: CallEndReason

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

CallEndReason

наследуется отCallCommon.callEndReason

callerInfo

Сведения о вызывающем объекте, если этот вызов входящий.

callerInfo: CallerInfo

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

CallerInfo

наследуется отCallCommon.callerInfo

direction

Получите направление вызова, будь то входящее или исходящее.

direction: CallDirection

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

CallDirection

унаследовано отCallCommon.direction

id

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

id: string

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

string

унаследовано отCallCommon.id

isIncomingAudioMuted

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

isIncomingAudioMuted: boolean

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

boolean

наследуется отCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Включено ли локальное видео.

isLocalVideoStarted: boolean

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

boolean

наследуется отCallCommon.isLocalVideoStarted

isMuted

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

isMuted: boolean

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

boolean

унаследован отCallCommon.isMuted

isScreenSharingOn

Включен ли общий доступ к экрану.

isScreenSharingOn: boolean

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

boolean

наследуется отCallCommon.isScreenSharingOn

kind

Получите тип объекта вызова.

kind: CallKind

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

CallKind

унаследовано отCallCommon.kind

lobby

Получите лобби собраний Teams.

lobby: Lobby

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

Lobby

унаследовано отCallCommon.lobby

localAudioStreams

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

localAudioStreams: readonly LocalAudioStream[]

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

readonly LocalAudioStream[]

наследуется отCallCommon.localAudioStreams

localVideoStreams

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

localVideoStreams: readonly LocalVideoStream[]

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

readonly LocalVideoStream[]

наследуется отCallCommon.localVideoStreams

remoteAudioStreams

Коллекция удаленных аудиопотоков, полученных от вызова.

remoteAudioStreams: readonly RemoteAudioStream[]

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

readonly RemoteAudioStream[]

наследуется отCallCommon.remoteAudioStreams

remoteParticipants

Коллекция удаленных участников этого вызова. В случае звонков с участниками сотни или более, в этой коллекции присутствуют только активные носители.

remoteParticipants: readonly RemoteParticipant[]

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

readonly RemoteParticipant[]

наследуется отCallCommon.remoteParticipants

role

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

role: ParticipantRole

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

ParticipantRole

наследуется отCallCommon.role

state

Получите состояние этого вызова.

state: CallState

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

CallState

наследуется отCallCommon.state

totalParticipantCount

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Общее количество участников этого вызова.

totalParticipantCount: number

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

number

наследуется отCallCommon.totalParticipantCount

transferorInfo

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Инициатор передачи в случае сценариев передачи и пересылки.

transferorInfo?: CallerInfo

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

CallerInfo

наследуется отCallCommon.transferorInfo

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

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

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

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Параметры

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

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

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

RemoteParticipant

Объект RemoteParticipant, связанный с успешно добавленным участником.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

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

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Параметры

identifier

CommunicationUserIdentifier

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

options

AddCommunicationUserOptions

Дополнительные параметры управления вызовом.

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

RemoteParticipant

Объект RemoteParticipant, связанный с успешно добавленным участником.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Добавьте приложение Teams в этот звонок.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Параметры

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

Идентификатор добавляемого приложения Teams.

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

RemoteParticipant

Объект RemoteParticipant, связанный с успешно добавленным приложением Teams.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

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

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Параметры

identifier

MicrosoftTeamsUserIdentifier

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

options

AddMicrosoftTeamsUserOptions

Дополнительные параметры управления вызовом.

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

RemoteParticipant

Объект RemoteParticipant, связанный с успешно добавленным участником.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Параметры

identifier

PhoneNumberIdentifier

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

options

AddPhoneNumberOptions

Дополнительные параметры управления вызовом ТСОП. Например, при задании номера телефона вызывающего абонента в вызове ТСОП.

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

RemoteParticipant

Объект RemoteParticipant, связанный с успешно добавленным участником.

removeParticipant(CommunicationIdentifier)

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

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

Параметры

identifier

CommunicationIdentifier

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

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

Promise<void>

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

dispose()

function dispose()

наследуется отCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций вызова в этом пакете, например:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

Параметры

factory

CallFeatureFactory<TFeature>

Фабрика для конструктора функций вызова, предоставляющего расширенный API.

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

TFeature

унаследовано отCallCommon.feature

hangUp(HangUpOptions)

Повесить звонок.

function hangUp(options?: HangUpOptions): Promise<void>

Параметры

options

HangUpOptions

Параметры hangUp.

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

Promise<void>

унаследовано отCallCommon.hangUp

hold()

Поместите этот звонок на удержание.

function hold(): Promise<void>

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

Promise<void>

унаследовано отCallCommon.hold

mute()

Отключение локального микрофона.

function mute(): Promise<void>

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

Promise<void>

унаследован отCallCommon.mute

muteAllRemoteParticipants()

Отключить отключение всех удаленных участников.

function muteAllRemoteParticipants(): Promise<void>

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

Promise<void>

унаследовано отCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Отключение входящего звука.

function muteIncomingAudio(): Promise<void>

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

Promise<void>

наследуется отCallCommon.muteIncomingAudio

off("callerInfoChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Отмена подписки для события изменения сведений вызывающего абонента.

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

Параметры

event

"callerInfoChanged"

listener

PropertyChangedEvent

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

off("idChanged", PropertyChangedEvent)

Отмена подписки функции для события idChanged.

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

Параметры

event

"idChanged"

имя события.

listener

PropertyChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

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

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

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

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

Параметры

event

"isIncomingAudioMutedChanged"

имя события.

listener

PropertyChangedEvent

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

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

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Отмена подписки для события isLocalVideoStartedChanged.

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

Параметры

event

"isLocalVideoStartedChanged"

имя события.

listener

PropertyChangedEvent

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

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

off("isMutedChanged", PropertyChangedEvent)

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

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

Параметры

event

"isMutedChanged"

имя события.

listener

PropertyChangedEvent

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

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

off("isScreenSharingOnChanged", PropertyChangedEvent)

Отмена подписки для событияScreenSharingChanged.

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

Параметры

event

"isScreenSharingOnChanged"

имя события.

listener

PropertyChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

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

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

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

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Параметры

event

"localAudioStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<LocalAudioStream>

обратный вызов fn, который использовался для подписки на это событие.

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

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Отмена подписки для события localVideoStreamsUpdated.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Параметры

event

"localVideoStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<LocalVideoStream>

обратный вызов fn, который использовался для подписки на это событие.

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

off("mutedByOthers", PropertyChangedEvent)

Отмена подписки для события mutedByOthers.

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

Параметры

event

"mutedByOthers"

имя события.

listener

PropertyChangedEvent

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

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

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

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

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Параметры

event

"remoteAudioStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<RemoteAudioStream>

обратный вызов fn, который использовался для подписки на это событие.

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

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

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

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Параметры

event

"remoteParticipantsUpdated"

имя события.

listener

CollectionUpdatedEvent<RemoteParticipant>

обратный вызов fn, который использовался для подписки на это событие.

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

off("roleChanged", PropertyChangedEvent)

Отмена подписки для события roleChanged.

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

Параметры

event

"roleChanged"

имя события.

listener

PropertyChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

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

off("stateChanged", PropertyChangedEvent)

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

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

Параметры

event

"stateChanged"

имя события.

listener

PropertyChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

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

off("totalParticipantCountChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

отмена подписки функции для события totalParticipantCountChanged.

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

Параметры

event

"totalParticipantCountChanged"

имя события.

listener

PropertyChangedEvent

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

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

off("transferorInfoChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Отмена подписки для события изменения сведений вызывающего абонента.

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

Параметры

event

"transferorInfoChanged"

listener

PropertyChangedEvent

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

on("callerInfoChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Функция подписки для измененных сведений о вызывающем объекте.

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

Параметры

event

"callerInfoChanged"

listener

PropertyChangedEvent

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

on("idChanged", PropertyChangedEvent)

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

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

Параметры

event

"idChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

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

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

Параметры

event

"isIncomingAudioMutedChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("isLocalVideoStartedChanged", PropertyChangedEvent)

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

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

Параметры

event

"isLocalVideoStartedChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("isMutedChanged", PropertyChangedEvent)

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

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

Параметры

event

"isMutedChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("isScreenSharingOnChanged", PropertyChangedEvent)

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

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

Параметры

event

"isScreenSharingOnChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

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

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Параметры

event

"localAudioStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<LocalAudioStream>

обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.

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

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

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

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Параметры

event

"localVideoStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<LocalVideoStream>

обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.

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

on("mutedByOthers", PropertyChangedEvent)

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

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

Параметры

event

"mutedByOthers"

имя события.

listener

PropertyChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

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

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

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

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Параметры

event

"remoteAudioStreamsUpdated"

имя события.

listener

CollectionUpdatedEvent<RemoteAudioStream>

обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.

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

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

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

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Параметры

event

"remoteParticipantsUpdated"

имя события.

listener

CollectionUpdatedEvent<RemoteParticipant>

обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.

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

on("roleChanged", PropertyChangedEvent)

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

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

Параметры

event

"roleChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("stateChanged", PropertyChangedEvent)

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

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

Параметры

event

"stateChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("totalParticipantCountChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

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

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

Параметры

event

"totalParticipantCountChanged"

имя события.

listener

PropertyChangedEvent

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

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

on("transferorInfoChanged", PropertyChangedEvent)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Функция подписки для измененных сведений о вызывающем объекте.

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

Параметры

event

"transferorInfoChanged"

listener

PropertyChangedEvent

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

resume()

Возобновите этот вызов, если он находится в состоянии LocalHold.

function resume(): Promise<void>

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

Promise<void>

наследуется отCallCommon.resume

sendDtmf(DtmfTone)

Отправьте тон DTMF.

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

Параметры

dtmfTone

DtmfTone

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

Promise<void>

наследуется отCallCommon.sendDtmf

setConstraints(CallConstraints)

Задайте ограничения вызовов. Этот метод задает максимальные ограничения на основе указанных значений. Последние примененные ограничения будут меньше или равно значениям, указанным здесь для этого метода. Если задано значение 0, для этого ограничения не будет применено никаких ограничений. Если задано неопределенное значение, то для этого ограничения будет использоваться предыдущее значение.

function setConstraints(constraints: CallConstraints): Promise<void>

Параметры

constraints

CallConstraints

Объект, представляющий ограничения вызова для задания

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

Promise<void>

унаследовано отCallCommon.setConstraints

startAudio(LocalAudioStream)

Запустите звук в вызове с пользовательским звуком. Источник LocalAudioStream должен быть mediaStream.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

Параметры

localAudioStream

LocalAudioStream

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

Promise<void>

наследуется отCallCommon.startAudio

startScreenSharing()

• Начните отправлять поток общего доступа к экранам в вызове. Браузер предложит выбрать экран, приложение или вкладку браузера.
• Отправка потока общего доступа к экранам не поддерживается в iOS или Android.
• Входящий поток общего доступа к экранам поддерживается в iOS и Android.

function startScreenSharing(): Promise<void>

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

Promise<void>

наследуется отCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

• Начните отправлять поток общего доступа к необработанным экранам в вызове.
• Отправка необработанного общего доступа к экрану не поддерживается в iOS или Android.
• Входящий необработанный общий доступ к экрану поддерживается в iOS и Android.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Параметры

localVideoStream

LocalVideoStream

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

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

Promise<void>

наследуется отCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Начните отправлять видеопоток в вызове. Удаленные участники звонка получат видеопоток, чтобы он смог отобразить его в своих UIs.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

Параметры

localVideoStream

LocalVideoStream

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

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

Promise<void>

унаследован отCallCommon.startVideo

stopAudio()

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

function stopAudio()

унаследовано отCallCommon.stopAudio

stopScreenSharing()

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

function stopScreenSharing(): Promise<void>

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

Promise<void>

наследуется отCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

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

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Параметры

localVideoStream

LocalVideoStream

Поток общего доступа к локальному экрану для остановки потоковой передачи.

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

Promise<void>

наследуется отCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Остановите отправку видеопотока в вызове. Необходимо передать тот же объект LocalVideoStream, который использовался для запуска видео в API CallAgent.startCall(), API CallAgent.join(), ВходящийCall.accept() или API Call.startVideo().

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

Параметры

localVideoStream

LocalVideoStream

Локальный видеопоток для остановки потоковой передачи.

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

Promise<void>

унаследован отCallCommon.stopVideo

unmute()

Распакуйте локальный микрофон.

function unmute(): Promise<void>

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

Promise<void>

унаследовано отCallCommon.unmute

unmuteIncomingAudio()

Отмените входящий звук.

function unmuteIncomingAudio(): Promise<void>

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

Promise<void>

наследуется отCallCommon.unmuteIncomingAudio