CallWithChatAdapter interface

Pakiet:

@azure/communication-react

CallWithChatComposite interfejs adaptera.

Rozszerzenie

CallWithChatAdapterManagement,AdapterState<CallWithChatAdapterState>,Disposable,CallWithChatAdapterSubscriptions

Właściwości dziedziczone

forbidAudio	Zabrania odtwarzania dźwięku dla określonych identyfikatorów użytkowników.
forbidOthersAudio	zabrania dźwięku dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.
forbidOthersVideo	Zabrania wideo dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.
forbidVideo	Blokuje wyświetlanie filmów dla określonych identyfikatorów użytkowników.
permitAudio	Zezwala na dźwięk dla określonych identyfikatorów użytkowników.
permitOthersAudio	zezwala na dźwięk dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.
permitOthersVideo	zezwala na wideo dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.
permitVideo	Zezwala na wyświetlanie filmów wideo dla określonych identyfikatorów użytkowników.
sendDtmfTone	Wysyłanie sygnału DTMF do innego uczestnika połączenia w połączeniach 1:1
sendRealTimeText	Wysyłanie tekstu w czasie rzeczywistym

Metody dziedziczone

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Dodaje nowego uczestnika do rozmowy.
askDevicePermission(PermissionConstraints)	Poproś o uprawnienia urządzeń.
createStreamView(string, VideoStreamOptions)	Utwórz widok HTML dla strumienia.
createTogetherModeStreamView(TogetherModeStreamOptions)	Utwórz widok html dla strumienia w trybie razem.
deleteMessage(string)	Usuń komunikat w wątku.
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()	Usuń widok html dla strumienia w trybie razem.
downloadResourceToCache(ResourceDetails)
fetchInitialData()	Pobierz stan początkowy dla karty czatu. Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.
getState()	Pobieranie bieżącego stanu
holdCall()	Umieszcza połączenie w blokadzie lokalnej.
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
leaveCall(boolean)	Pozostaw połączenie.
loadPreviousChatMessages(number)	Załaduj więcej poprzednich wiadomości w historii wątku czatu.
lowerHand()	Dolna ręka dla użytkownika lokalnego.
mute()	Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie.
muteAllRemoteParticipants()	Wyciszanie uczestnika
muteParticipant(string)	Wyciszanie uczestnika
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)	Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)	Wyślij reakcję na trwające spotkanie.
onStateChange((state: CallWithChatAdapterState) => void)	Subskrybuje program obsługi do zdarzeń stateChanged.
queryCameras()	Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.
queryMicrophones()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
querySpeakers()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
raiseHand()	Podnieś rękę dla użytkownika lokalnego.
removeParticipant(CommunicationIdentifier)	Usuń uczestnika z połączenia.
removeParticipant(string)	Usuń uczestnika z połączenia.
removeResourceFromCache(ResourceDetails)
resumeCall()	Wznawia połączenie ze stanu LocalHold.
returnFromBreakoutRoom()	Powrót do punktu początkowego w oddzielnym pokoju
sendMessage(string, SendMessageOptions)	Wyślij wiadomość w wątku.
sendReadReceipt(string)	Wyślij potwierdzenie odczytu dla wiadomości.
sendTypingIndicator()	Wyślij wskaźnik wpisywania w wątku.
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.
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Uruchom wywołanie.
startCall(string[], StartCallOptions)	Uruchom wywołanie.
startCamera(VideoStreamOptions)	Uruchom aparat. Ta metoda rozpocznie renderowanie lokalnego widoku aparatu, 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[])	Rozpocznij w centrum uwagi
startTogetherMode()	Uruchom tryb razem.
startVideoBackgroundEffect(VideoBackgroundEffect)	Uruchom efekt tła wideo.
stopAllSpotlight()	Wyłączanie wszystkich reflektorów punktowych
stopCamera()	Zatrzymaj aparat. Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne.
stopCaptions(StopCaptionsAdapterOptions)	Funkcja zatrzymywania napisów
stopNoiseSuppressionEffect()	Uruchom efekt tłumienia szumów.
stopScreenShare()	Zatrzymaj udostępnianie ekranu.
stopSpotlight(string[])	Zatrzymaj reflektor punktowy
stopVideoBackgroundEffects()	Zatrzymaj efekt tła wideo.
submitSurvey(CallSurvey)	Wyślij wynik ankiety na koniec rozmowy
unmute()	Anuluj wyciszenie 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.
updateMessage(string, string, Record<string, string>)	Aktualizowanie zawartości wiadomości.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Aktualizowanie wybranego efektu tła wideo

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

forbidAudio

Zabrania odtwarzania dźwięku dla określonych identyfikatorów użytkowników.

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

Wartość właściwości

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

Odziedziczone poCallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

zabrania dźwięku dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.

forbidOthersAudio: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

Zabrania wideo dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.

forbidOthersVideo: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

Blokuje wyświetlanie filmów dla określonych identyfikatorów użytkowników.

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

Wartość właściwości

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

Odziedziczone poCallWithChatAdapterManagement.forbidVideo

permitAudio

Zezwala na dźwięk dla określonych identyfikatorów użytkowników.

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

Wartość właściwości

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

Odziedziczone poCallWithChatAdapterManagement.permitAudio

permitOthersAudio

zezwala na dźwięk dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.

permitOthersAudio: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

zezwala na wideo dla uczestników spotkania w usłudze Teams z wyjątkiem użytkownika lokalnego.

permitOthersVideo: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCallWithChatAdapterManagement.permitOthersVideo

permitVideo

Zezwala na wyświetlanie filmów wideo dla określonych identyfikatorów użytkowników.

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

Wartość właściwości

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

Odziedziczone poCallWithChatAdapterManagement.permitVideo

sendDtmfTone

Wysyłanie sygnału DTMF do innego uczestnika połączenia w połączeniach 1:1

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

Wartość właściwości

(dtmfTone: DtmfTone) => Promise<void>

Odziedziczone poCallWithChatAdapterManagement.sendDtmfTone

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 poCallWithChatAdapterManagement.sendRealTimeText

Szczegóły metody dziedziczonej

addParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Dodaje nowego uczestnika do rozmowy.

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.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

Jeśli uprawnienia nie zostały jeszcze przyznane, zostanie wyświetlone okno uprawnień przeglądarki.

dziedziczone zCallWithChatAdapterManagement.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 zCallWithChatAdapterManagement.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Utwórz widok html dla strumienia w trybie razem.

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 poCallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Usuń komunikat w wątku.

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

Parametry

messageId

string

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.deleteMessage

dispose()

Usuwanie złożonego

function dispose()

Odziedziczone poDisposable_2.dispose

disposeLocalVideoStreamView()

Usuwanie widoku HTML dla lokalnego strumienia wideo

function disposeLocalVideoStreamView(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

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 zCallWithChatAdapterManagement.disposeStreamView

disposeTogetherModeStreamView()

Usuń widok html dla strumienia w trybie razem.

function disposeTogetherModeStreamView(): Promise<void>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

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

Parametry

resourceDetails

ResourceDetails

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.downloadResourceToCache

fetchInitialData()

Pobierz stan początkowy dla karty czatu.

Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.

function fetchInitialData(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.fetchInitialData

getState()

Pobieranie bieżącego stanu

function getState(): CallWithChatAdapterState

Zwraca

CallWithChatAdapterState

dziedziczone zAdapterState.getState

holdCall()

Umieszcza połączenie w blokadzie lokalnej.

function holdCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.holdCall

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

dziedziczone zCallWithChatAdapterManagement.joinCall

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

dziedziczone zCallWithChatAdapterManagement.joinCall

leaveCall(boolean)

Pozostaw połączenie.

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.leaveCall

loadPreviousChatMessages(number)

Załaduj więcej poprzednich wiadomości w historii wątku czatu.

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

Parametry

messagesToLoad

number

Zwraca

Promise<boolean>

Uwagi

Ta metoda jest zwykle używana do kontrolowania przyrostowego pobierania/nieskończonego przewijania.

dziedziczone zCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Dolna ręka dla użytkownika lokalnego.

function lowerHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.lowerHand

mute()

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

function mute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Wyciszanie uczestnika

function muteAllRemoteParticipants(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Wyciszanie uczestnika

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

Parametry

userId

string

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parametry

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("callEnded", CallEndedListener)

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

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

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

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

Parametry

event

"callError"

listener

(e: AdapterError) => void

dziedziczone zCallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

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

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

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

Parametry

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

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

Parametry

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("capabilitiesChanged", CapabilitiesChangedListener)

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

Parametry

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("captionsReceived", CaptionsReceivedListener)

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

Parametry

event

"captionsReceived"

listener

CaptionsReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

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

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

Parametry

event

"chatError"

listener

(e: AdapterError) => void

dziedziczone zCallWithChatAdapterSubscriptions.off

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Parametry

event

"chatInitialized"

listener

ChatInitializedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametry

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametry

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parametry

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parametry

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parametry

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Parametry

event

"messageDeleted"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Parametry

event

"messageEdited"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Parametry

event

"messageRead"

listener

MessageReadListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Parametry

event

"messageReceived"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Parametry

event

"messageSent"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parametry

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCallWithChatAdapterSubscriptions.off

off("spotlightChanged", SpotlightChangedListener)

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

Parametry

event

"spotlightChanged"

listener

SpotlightChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

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

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

Parametry

handler

(state: CallWithChatAdapterState) => void

dziedziczone zAdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parametry

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

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

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

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

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

Parametry

event

"callError"

listener

(e: AdapterError) => void

dziedziczone zCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

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

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

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

Parametry

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

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

Parametry

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

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

Parametry

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

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

Parametry

event

"captionsReceived"

listener

CaptionsReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

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

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

Parametry

event

"chatError"

listener

(e: AdapterError) => void

dziedziczone zCallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Parametry

event

"chatInitialized"

listener

ChatInitializedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametry

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametry

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parametry

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parametry

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parametry

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Parametry

event

"messageDeleted"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Parametry

event

"messageEdited"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Parametry

event

"messageRead"

listener

MessageReadListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Parametry

event

"messageReceived"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Parametry

event

"messageSent"

listener

MessageReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parametry

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

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

Parametry

event

"spotlightChanged"

listener

SpotlightChangedListener

dziedziczone zCallWithChatAdapterSubscriptions.on

onReactionClick(Reaction)

Wyślij reakcję na trwające spotkanie.

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

Parametry

reaction

Reaction

Wartość typu <xref:%40azure%2Fcommunication-calling%23Reaction>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Subskrybuje program obsługi do zdarzeń stateChanged.

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

Parametry

handler

(state: CallWithChatAdapterState) => void

dziedziczone zAdapterState.onStateChange

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 zCallWithChatAdapterManagement.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 zCallWithChatAdapterManagement.queryMicrophones

querySpeakers()

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

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 zCallWithChatAdapterManagement.querySpeakers

raiseHand()

Podnieś rękę dla użytkownika lokalnego.

function raiseHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.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 zCallWithChatAdapterManagement.removeParticipant

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

UserId uczestnika do usunięcia.

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametry

resourceDetails

ResourceDetails

Odziedziczone poCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Wznawia połączenie ze stanu LocalHold.

function resumeCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

Powrót do punktu początkowego w oddzielnym pokoju

function returnFromBreakoutRoom(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.returnFromBreakoutRoom

sendMessage(string, SendMessageOptions)

Wyślij wiadomość w wątku.

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

Parametry

content

string

options

SendMessageOptions

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Wyślij potwierdzenie odczytu dla wiadomości.

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

Parametry

chatMessageId

string

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Wyślij wskaźnik wpisywania w wątku.

function sendTypingIndicator(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.sendTypingIndicator

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 zCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.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 zCallWithChatAdapterManagement.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 zCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.setTogetherModeSceneSize

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Uruchom wywołanie.

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

Parametry

participants

(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

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

options

StartCallOptions

Zwraca

undefined | Call

dziedziczone zCallWithChatAdapterManagement.startCall

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

dziedziczone zCallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Uruchom aparat.

Ta metoda rozpocznie renderowanie lokalnego widoku aparatu, 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 zCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function startNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Rozpocznij w centrum uwagi

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Uruchom tryb razem.

function startTogetherMode(): Promise<void>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCallWithChatAdapterManagement.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Uruchom efekt tła wideo.

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

Parametry

videoBackgroundEffect

VideoBackgroundEffect

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Wyłączanie wszystkich reflektorów punktowych

function stopAllSpotlight(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.stopAllSpotlight

stopCamera()

Zatrzymaj aparat.

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

function stopCamera(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funkcja zatrzymywania napisów

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

Parametry

options

StopCaptionsAdapterOptions

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function stopNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Zatrzymaj udostępnianie ekranu.

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.stopScreenShare

stopSpotlight(string[])

Zatrzymaj reflektor punktowy

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Zatrzymaj efekt tła wideo.

function stopVideoBackgroundEffects(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.submitSurvey

unmute()

Anuluj wyciszenie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie.

function unmute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.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 poCallWithChatAdapterManagement.updateBackgroundPickerImages

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

Aktualizowanie zawartości wiadomości.

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

Parametry

messageId

string

content

string

options

Record<string, string>

Zwraca

Promise<void>

dziedziczone zCallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualizowanie wybranego efektu tła wideo

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground

VideoBackgroundEffect

Odziedziczone poCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect