CallAdapter interface

Pakiet:

@azure/communication-react

Interfejs karty specyficzny dla tożsamości usługi Azure Communication, który rozszerza CommonCallAdapter.

Rozszerzenie

CommonCallAdapter

Właściwości dziedziczone

sendRealTimeText

Wysyłanie tekstu w czasie rzeczywistym

Metody

joinCall(boolean)	Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.
joinCall(JoinCallOptions)	Dołącz do rozmowy z torbą opcji, aby ustawić stan początkowy mikrofonu/kamery podczas dołączania do połączenia true = włącz urządzenie podczas dołączania do połączenia false = wyłącz urządzenie podczas dołączania do połączenia "zachowaj" / undefined = zachowaj stan sprzed połączenia
startCall(CommunicationIdentifier[], StartCallOptions)	Uruchom wywołanie.
startCall(string[], StartCallOptions)	Uruchom wywołanie.

Metody dziedziczone

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Dodaj uczestnika do połączenia.
askDevicePermission(PermissionConstraints)	Poproś o uprawnienia urządzeń.
createStreamView(string, VideoStreamOptions)	Utwórz widok HTML dla strumienia.
createTogetherModeStreamView(TogetherModeStreamOptions)	Utwórz widok HTML dla strumienia.
dispose()	Usuwanie złożonego
disposeLocalVideoStreamView()	Usuwanie widoku HTML dla lokalnego strumienia wideo
disposeRemoteVideoStreamView(string)	Usuwanie widoku html dla zdalnego strumienia wideo
disposeScreenShareStreamView(string)	Określanie położenia widoku html dla strumienia udziału ekranu
disposeStreamView(string, VideoStreamOptions)	Usuwanie widoku HTML dla strumienia.
disposeTogetherModeStreamView()	Usuwanie widoku HTML dla strumienia.
forbidAudio(string[])	Zabraniaj uczestnikom spotkania w usłudze Teams odtwarzania dźwięku według ich identyfikatorów użytkowników.
forbidOthersAudio()	Zabraniaj dźwięku podczas spotkań w usłudze Teams.
forbidOthersVideo()	Zabraniaj wideo ze spotkania w usłudze Teams.
forbidVideo(string[])	Nie zezwalaj uczestnikom spotkania w usłudze Teams na wideo według ich identyfikatorów użytkowników.
getState()	Pobieranie bieżącego stanu
holdCall()	Zawiesza połączenie.
leaveCall(boolean)	Opuść połączenie
lowerHand()	dolna ręka dla bieżącego użytkownika
mute()	Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie
muteAllRemoteParticipants()	Wyciszanie wszystkich uczestników
muteParticipant(string)	Wyciszanie uczestnika
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Funkcja rezygnacji z subskrypcji wydarzenia "breakoutRoomsUpdated".
off("callEnded", CallEndedListener)	Anuluj subskrypcję funkcji dla zdarzenia "callEnded".
off("callIdChanged", CallIdChangedListener)	Anuluj subskrypcję funkcji dla zdarzenia "callIdChanged".
off("capabilitiesChanged", CapabilitiesChangedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "capabilitiesChanged".
off("captionsReceived", CaptionsReceivedListener)	Funkcja rezygnacji z subskrypcji dla wydarzenia "captionsReceived".
off("diagnosticChanged", DiagnosticChangedEventListner)	Anuluj subskrypcję funkcji dla zdarzenia "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Anuluj subskrypcję funkcji dla zdarzenia "displayNameChanged".
off("error", (e: AdapterError) => void)	Anuluj subskrypcję funkcji dla zdarzenia "error".
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "isCaptionLanguageChanged".
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "isCaptionsActiveChanged".
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funkcja anuluj subskrypcję zdarzenia "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Funkcja anulowania subskrypcji zdarzenia "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Funkcja anuluj subskrypcję zdarzenia "isSpeakingChanged".
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "isSpokenLanguageChanged".
off("mutedByOthers", PropertyChangedEvent)	Funkcja rezygnacji z subskrypcji wydarzenia "mutedByOthers".
off("participantsJoined", ParticipantsJoinedListener)	Anuluj subskrypcję funkcji dla zdarzenia "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Anuluj subskrypcję funkcji dla zdarzenia "participantsLeft".
off("realTimeTextReceived", RealTimeTextReceivedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "realTimeTextReceived".
off("roleChanged", PropertyChangedEvent)	Funkcja rezygnacji z subskrypcji dla zdarzenia "roleChanged".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Funkcja anuluj subskrypcję zdarzenia "selectedSpeakerChanged".
off("spotlightChanged", SpotlightChangedListener)	Funkcja rezygnacji z subskrypcji dla wydarzenia "spotlightChanged".
off("transferAccepted", TransferAcceptedListener)	Funkcja rezygnacji z subskrypcji dla zdarzenia "transferRequested".
offStateChange((state: CallAdapterState) => void)	Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Funkcja subskrypcji dla wydarzenia "breakoutRoomsUpdated".
on("callEnded", CallEndedListener)	Subskrybuj funkcję zdarzenia "callEnded".
on("callIdChanged", CallIdChangedListener)	Funkcja subskrybuj zdarzenie "callIdChanged".
on("capabilitiesChanged", CapabilitiesChangedListener)	Subskrybuj funkcję dla zdarzenia "capabilitiesChanged".
on("captionsReceived", CaptionsReceivedListener)	Funkcja subskrypcji dla zdarzenia "captionsReceived".
on("diagnosticChanged", DiagnosticChangedEventListner)	Subskrybuj funkcję zdarzenia "diagnosticChanged". To zdarzenie jest uruchamiane za każdym razem, gdy wystąpi zmiana diagnostyki użytkownika na temat trwającego połączenia.
on("displayNameChanged", DisplayNameChangedListener)	Subskrybuj funkcję zdarzenia "displayNameChanged".
on("error", (e: AdapterError) => void)	Subskrybuj funkcję zdarzenia "error".
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Subskrybuj funkcję dla zdarzenia "isCaptionLanguageChanged".
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Funkcja subskrypcji dla zdarzenia "isCaptionsActiveChanged".
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funkcja subskrybuj zdarzenie "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Funkcja subskrybuj zdarzenie "isMutedChanged".
on("isSpeakingChanged", IsSpeakingChangedListener)	Funkcja subskrybuj zdarzenie "isSpeakingChanged".
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Subskrybuj funkcję dla zdarzenia "isSpokenLanguageChanged".
on("mutedByOthers", PropertyChangedEvent)	Funkcja subskrypcji dla wydarzenia 'mutedByOthers'.
on("participantsJoined", ParticipantsJoinedListener)	Subskrybuj funkcję zdarzenia "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Subskrybuj funkcję zdarzenia "participantsLeft".
on("realTimeTextReceived", RealTimeTextReceivedListener)	Funkcja subskrypcji dla zdarzenia 'realTimeTextReceived'.
on("roleChanged", PropertyChangedEvent)	Funkcja subskrypcji dla zdarzenia 'roleChanged'.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Funkcja subskrybuj zdarzenie "selectedMicrophoneChanged". To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mikrofonu.
on("selectedSpeakerChanged", PropertyChangedEvent)	Funkcja subskrybuj zdarzenie "selectedSpeakerChanged". To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mówiące.
on("spotlightChanged", SpotlightChangedListener)	Subskrybuj funkcję dla wydarzenia 'spotlightChanged'.
on("transferAccepted", TransferAcceptedListener)	Funkcja subskrypcji dla zdarzenia 'transferRequested'.
onReactionClick(Reaction)	Wyślij emotikon reakcji
onStateChange((state: CallAdapterState) => void)	Subskrybuje program obsługi do zdarzeń stateChanged.
permitAudio(string[])	Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.
permitOthersAudio()	Zezwalaj na dźwięk ze spotkania w usłudze Teams.
permitOthersVideo()	Zezwalaj na wideo ze spotkaniem w usłudze Teams.
permitVideo(string[])	Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.
queryCameras()	Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.
queryMicrophones()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
querySpeakers()	Zapytanie o dostępne głośniki.
raiseHand()	Podnieś rękę dla bieżącego użytkownika
removeParticipant(CommunicationIdentifier)	Usuń uczestnika z połączenia.
removeParticipant(string)	Usuń uczestnika z połączenia.
resumeCall()	Wznawia połączenie ze stanu LocalHold .
returnFromBreakoutRoom()	Powrót do punktu początkowego w oddzielnym pokoju
sendDtmfTone(DtmfTone)	wysyłanie sygnału dtmf do innego uczestnika połączenia PSTN 1:1
setCamera(VideoDeviceInfo, VideoStreamOptions)	Ustaw aparat do użycia w wywołaniu.
setCaptionLanguage(string)	Funkcja do ustawiania języka napisów
setMicrophone(AudioDeviceInfo)	Ustaw mikrofon do użycia w wywołaniu.
setSpeaker(AudioDeviceInfo)	Ustaw głośnik do użycia w wywołaniu.
setSpokenLanguage(string)	Funkcja ustawiania języka mówionego
setTogetherModeSceneSize(number, number)	Ponownie oblicz pozycje siedzące dla trybu razem.
startCamera(VideoStreamOptions)	Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne
startCaptions(StartCaptionsAdapterOptions)	Funkcja uruchamiania napisów
startNoiseSuppressionEffect()	Uruchom efekt tłumienia szumów.
startScreenShare()	Rozpocznij udostępnianie ekranu podczas połączenia.
startSpotlight(string[])	Uruchom funkcję W centrum uwagi dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.
startTogetherMode()	Rozpocznij razem tryb.
startVideoBackgroundEffect(VideoBackgroundEffect)	Uruchom efekt tła wideo.
stopAllSpotlight()	Wyłączanie wszystkich reflektorów punktowych
stopCamera()	Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne
stopCaptions(StopCaptionsAdapterOptions)	Funkcja zatrzymywania napisów
stopNoiseSuppressionEffect()	Zatrzymaj efekt tłumienia szumów.
stopScreenShare()	Zatrzymaj udostępnianie ekranu
stopSpotlight(string[])	Zatrzymaj funkcję Spotlight dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.
stopVideoBackgroundEffects()	Zatrzymaj efekt tła wideo.
submitSurvey(CallSurvey)	Wyślij wynik ankiety na koniec rozmowy
unmute()	Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie
updateBackgroundPickerImages(VideoBackgroundImage[])	Zastąp obrazy selektora tła, aby uzyskać efekt zastąpienia tła.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Zaktualizuj wybrany efekt tła wideo.

Szczegóły właściwości dziedziczonej

sendRealTimeText

Wysyłanie tekstu w czasie rzeczywistym

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

Wartość właściwości

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

Odziedziczone poCommonCallAdapter.sendRealTimeText

Szczegóły metody

joinCall(boolean)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use joinCall(options?:JoinCallOptions) instead.

Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.

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

Parametry

microphoneOn

boolean

Czy mikrofon jest początkowo włączony

Zwraca

undefined | Call

joinCall(JoinCallOptions)

Dołącz do rozmowy z torbą opcji, aby ustawić stan początkowy mikrofonu/kamery podczas dołączania do połączenia true = włącz urządzenie podczas dołączania do połączenia false = wyłącz urządzenie podczas dołączania do połączenia "zachowaj" / undefined = zachowaj stan sprzed połączenia

function joinCall(options?: JoinCallOptions): undefined | Call

Parametry

options

JoinCallOptions

param, aby początkowo włączyć/wyłączyć mikrofon/kamerę/użyć stanu przed połączeniem.

Zwraca

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Uruchom wywołanie.

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

Parametry

participants

CommunicationIdentifier[]

Tablica do <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> wywołania

options

StartCallOptions

Zwraca

undefined | Call

startCall(string[], StartCallOptions)

Uruchom wywołanie.

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

Parametry

participants

string[]

Tablica identyfikatorów uczestników do przyłączenia

options

StartCallOptions

Zwraca

undefined | Call

Szczegóły metody dziedziczonej

addParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Dodaj uczestnika do połączenia.

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.addParticipant

askDevicePermission(PermissionConstraints)

Poproś o uprawnienia urządzeń.

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

Parametry

constrain

PermissionConstraints

Definiowanie ograniczeń dotyczących uzyskiwania dostępu do urządzeń lokalnych <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Zwraca

Promise<DeviceAccess>

Uwagi

Zostanie wyświetlone okno uprawnień przeglądarki, jeśli uprawnienia nie zostały jeszcze przyznane

dziedziczone zCommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Utwórz widok HTML dla strumienia.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw go niezdefiniowany, aby utworzyć lokalny widok aparatu

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void | CreateVideoStreamViewResult>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Utwórz widok HTML dla strumienia.

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

Parametry

options

TogetherModeStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void | TogetherModeStreamViewResult>

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCommonCallAdapter.createTogetherModeStreamView

dispose()

Usuwanie złożonego

function dispose()

dziedziczone zCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Usuwanie widoku HTML dla lokalnego strumienia wideo

function disposeLocalVideoStreamView(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Usuwanie widoku html dla zdalnego strumienia wideo

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

Parametry

remoteUserId

string

Identyfikator uczestnika do rozporządzania

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Określanie położenia widoku html dla strumienia udziału ekranu

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

Parametry

remoteUserId

string

Identyfikator uczestnika, dla którego ma zostać usunięty widok strumienia udziału ekranu.

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla kompozytów

Odziedziczone poCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Usuwanie widoku HTML dla strumienia.

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

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw niezdefiniowany, aby usunąć widok aparatu lokalnego

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

Usuwanie widoku HTML dla strumienia.

function disposeTogetherModeStreamView(): Promise<void>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Zabraniaj uczestnikom spotkania w usłudze Teams odtwarzania dźwięku według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.forbidAudio

forbidOthersAudio()

Zabraniaj dźwięku podczas spotkań w usłudze Teams.

function forbidOthersAudio(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Zabraniaj wideo ze spotkania w usłudze Teams.

function forbidOthersVideo(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Nie zezwalaj uczestnikom spotkania w usłudze Teams na wideo według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.forbidVideo

getState()

Pobieranie bieżącego stanu

function getState(): CallAdapterState

Zwraca

CallAdapterState

dziedziczone zCommonCallAdapter.getState

holdCall()

Zawiesza połączenie.

function holdCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.holdCall

leaveCall(boolean)

Opuść połączenie

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.leaveCall

lowerHand()

dolna ręka dla bieżącego użytkownika

function lowerHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.lowerHand

mute()

Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie

function mute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.mute

muteAllRemoteParticipants()

Wyciszanie wszystkich uczestników

function muteAllRemoteParticipants(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Wyciszanie uczestnika

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

Parametry

userId

string

Identyfikator uczestnika, który ma zostać wyciszony

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Funkcja rezygnacji z subskrypcji wydarzenia "breakoutRoomsUpdated".

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametry

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

dziedziczone zCommonCallAdapter.off

off("callEnded", CallEndedListener)

Anuluj subskrypcję funkcji dla zdarzenia "callEnded".

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

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Anuluj subskrypcję funkcji dla zdarzenia "callIdChanged".

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

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

dziedziczone zCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "capabilitiesChanged".

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametry

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

dziedziczone zCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Funkcja rezygnacji z subskrypcji dla wydarzenia "captionsReceived".

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametry

event

"captionsReceived"

listener

CaptionsReceivedListener

dziedziczone zCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Anuluj subskrypcję funkcji dla zdarzenia "diagnosticChanged".

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

Parametry

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

dziedziczone zCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Anuluj subskrypcję funkcji dla zdarzenia "displayNameChanged".

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCommonCallAdapter.off

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

Anuluj subskrypcję funkcji dla zdarzenia "error".

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

Parametry

event

"error"

listener

(e: AdapterError) => void

dziedziczone zCommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "isCaptionLanguageChanged".

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametry

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

dziedziczone zCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "isCaptionsActiveChanged".

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametry

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

dziedziczone zCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funkcja anuluj subskrypcję zdarzenia "isLocalScreenSharingActiveChanged".

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

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Funkcja anulowania subskrypcji zdarzenia "isMutedChanged".

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

dziedziczone zCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Funkcja anuluj subskrypcję zdarzenia "isSpeakingChanged".

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "isSpokenLanguageChanged".

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametry

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

dziedziczone zCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Funkcja rezygnacji z subskrypcji wydarzenia "mutedByOthers".

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

Parametry

event

"mutedByOthers"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Anuluj subskrypcję funkcji dla zdarzenia "participantsJoined".

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

Parametry

event

"participantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Anuluj subskrypcję funkcji dla zdarzenia "participantsLeft".

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

Parametry

event

"participantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "realTimeTextReceived".

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametry

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

dziedziczone zCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Funkcja rezygnacji z subskrypcji dla zdarzenia "roleChanged".

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

Parametry

event

"roleChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia "selectedMicrophoneChanged".

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Funkcja anuluj subskrypcję zdarzenia "selectedSpeakerChanged".

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Funkcja rezygnacji z subskrypcji dla wydarzenia "spotlightChanged".

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametry

event

"spotlightChanged"

listener

SpotlightChangedListener

dziedziczone zCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Funkcja rezygnacji z subskrypcji dla zdarzenia "transferRequested".

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Parametry

event

"transferAccepted"

listener

TransferAcceptedListener

dziedziczone zCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.

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

Parametry

handler

(state: CallAdapterState) => void

dziedziczone zCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Funkcja subskrypcji dla wydarzenia "breakoutRoomsUpdated".

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametry

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

dziedziczone zCommonCallAdapter.on

on("callEnded", CallEndedListener)

Subskrybuj funkcję zdarzenia "callEnded".

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

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Funkcja subskrybuj zdarzenie "callIdChanged".

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

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

Uwagi

Zdarzenie zostanie wyzwolone po zmianie identyfikatora callId bieżącego użytkownika.

dziedziczone zCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Subskrybuj funkcję dla zdarzenia "capabilitiesChanged".

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametry

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

dziedziczone zCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Funkcja subskrypcji dla zdarzenia "captionsReceived".

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametry

event

"captionsReceived"

listener

CaptionsReceivedListener

dziedziczone zCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Subskrybuj funkcję zdarzenia "diagnosticChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy wystąpi zmiana diagnostyki użytkownika na temat trwającego połączenia.

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

Parametry

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

dziedziczone zCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Subskrybuj funkcję zdarzenia "displayNameChanged".

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCommonCallAdapter.on

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

Subskrybuj funkcję zdarzenia "error".

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

Parametry

event

"error"

listener

(e: AdapterError) => void

dziedziczone zCommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Subskrybuj funkcję dla zdarzenia "isCaptionLanguageChanged".

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametry

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

dziedziczone zCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Funkcja subskrypcji dla zdarzenia "isCaptionsActiveChanged".

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametry

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

dziedziczone zCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funkcja subskrybuj zdarzenie "isLocalScreenSharingActiveChanged".

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

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Funkcja subskrybuj zdarzenie "isMutedChanged".

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

Uwagi

Zdarzenie zostanie wyzwolone za każdym razem, gdy bieżący użytkownik lub stan wyciszenia użytkownika zdalnego uległ zmianie

dziedziczone zCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Funkcja subskrybuj zdarzenie "isSpeakingChanged".

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Subskrybuj funkcję dla zdarzenia "isSpokenLanguageChanged".

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametry

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

dziedziczone zCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Funkcja subskrypcji dla wydarzenia 'mutedByOthers'.

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

Parametry

event

"mutedByOthers"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Subskrybuj funkcję zdarzenia "participantsJoined".

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

Parametry

event

"participantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Subskrybuj funkcję zdarzenia "participantsLeft".

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

Parametry

event

"participantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Funkcja subskrypcji dla zdarzenia 'realTimeTextReceived'.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametry

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

dziedziczone zCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Funkcja subskrypcji dla zdarzenia 'roleChanged'.

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

Parametry

event

"roleChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Funkcja subskrybuj zdarzenie "selectedMicrophoneChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mikrofonu.

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Funkcja subskrybuj zdarzenie "selectedSpeakerChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mówiące.

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Subskrybuj funkcję dla wydarzenia 'spotlightChanged'.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametry

event

"spotlightChanged"

listener

SpotlightChangedListener

dziedziczone zCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Funkcja subskrypcji dla zdarzenia 'transferRequested'.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Parametry

event

"transferAccepted"

listener

TransferAcceptedListener

dziedziczone zCommonCallAdapter.on

onReactionClick(Reaction)

Wyślij emotikon reakcji

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

Parametry

reaction

Reaction

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Subskrybuje program obsługi do zdarzeń stateChanged.

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

Parametry

handler

(state: CallAdapterState) => void

dziedziczone zCommonCallAdapter.onStateChange

permitAudio(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.permitAudio

permitOthersAudio()

Zezwalaj na dźwięk ze spotkania w usłudze Teams.

function permitOthersAudio(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Zezwalaj na wideo ze spotkaniem w usłudze Teams.

function permitOthersVideo(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.permitVideo

queryCameras()

Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.

function queryCameras(): Promise<VideoDeviceInfo[]>

Zwraca

Promise<VideoDeviceInfo[]>

Tablica jednostek informacji o urządzeniu wideo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCommonCallAdapter.queryCameras

queryMicrophones()

Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCommonCallAdapter.queryMicrophones

querySpeakers()

Zapytanie o dostępne głośniki.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCommonCallAdapter.querySpeakers

raiseHand()

Podnieś rękę dla bieżącego użytkownika

function raiseHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.raiseHand

removeParticipant(CommunicationIdentifier)

Usuń uczestnika z połączenia.

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

Parametry

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> uczestnika, który ma zostać usunięty

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.removeParticipant

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

Identyfikator uczestnika do usunięcia

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.removeParticipant

resumeCall()

Wznawia połączenie ze stanu LocalHold .

function resumeCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Powrót do punktu początkowego w oddzielnym pokoju

function returnFromBreakoutRoom(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

wysyłanie sygnału dtmf do innego uczestnika połączenia PSTN 1:1

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

Parametry

dtmfTone

DtmfTone

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.sendDtmfTone

setCamera(VideoDeviceInfo, VideoStreamOptions)

Ustaw aparat do użycia w wywołaniu.

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

Parametry

sourceInfo

VideoDeviceInfo

Urządzenie aparatu do wyboru, wybierz jedno zwrócone przez queryCameras

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumienia aparatu <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.setCamera

setCaptionLanguage(string)

Funkcja do ustawiania języka napisów

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

Parametry

language

string

Język ustawiony dla podpisu

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Ustaw mikrofon do użycia w wywołaniu.

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

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mikrofonu do wyboru, wybierz jedno zwrócone przez zapytanieMicrophones

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.setMicrophone

setSpeaker(AudioDeviceInfo)

Ustaw głośnik do użycia w wywołaniu.

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

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mówiące do wyboru, wybierz jedno zwrócone przez querySpeakers

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.setSpeaker

setSpokenLanguage(string)

Funkcja ustawiania języka mówionego

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

Parametry

language

string

Język mówiony

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Ponownie oblicz pozycje siedzące dla trybu razem.

function setTogetherModeSceneSize(width: number, height: number)

Parametry

width

number

Szerokość kontenera

height

number

Wysokość kontenera

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCommonCallAdapter.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne

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

Parametry

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funkcja uruchamiania napisów

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

Parametry

options

StartCaptionsAdapterOptions

Opcje napisów początkowych

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function startNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.startScreenShare

startSpotlight(string[])

Uruchom funkcję W centrum uwagi dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.startSpotlight

startTogetherMode()

Rozpocznij razem tryb.

function startTogetherMode(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Uruchom efekt tła wideo.

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

Parametry

videoBackgroundEffect

VideoBackgroundEffect

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Wyłączanie wszystkich reflektorów punktowych

function stopAllSpotlight(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.stopAllSpotlight

stopCamera()

Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne

function stopCamera(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funkcja zatrzymywania napisów

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

Parametry

options

StopCaptionsAdapterOptions

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Zatrzymaj efekt tłumienia szumów.

function stopNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Zatrzymaj udostępnianie ekranu

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Zatrzymaj funkcję Spotlight dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Zatrzymaj efekt tła wideo.

function stopVideoBackgroundEffects(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCommonCallAdapter.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Wyślij wynik ankiety na koniec rozmowy

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

Parametry

survey

CallSurvey

Zwraca

Promise<undefined | CallSurveyResponse>

Odziedziczone poCommonCallAdapter.submitSurvey

unmute()

Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie

function unmute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Zastąp obrazy selektora tła, aby uzyskać efekt zastąpienia tła.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametry

backgroundImages

VideoBackgroundImage[]

Tablica niestandardowych obrazów tła.

Odziedziczone poCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Zaktualizuj wybrany efekt tła wideo.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground

VideoBackgroundEffect

Odziedziczone poCommonCallAdapter.updateSelectedVideoBackgroundEffect