CallWithChatAdapterManagement interface

Pakiet:

@azure/communication-react

Funkcje zarządzania bieżącym połączeniem za pomocą czatu.

Właściwości

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

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.
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.
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
onReactionClick(Reaction)	Wyślij reakcję na trwające spotkanie.
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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

Szczegóły metody

addParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Zwraca

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Dodaje nowego uczestnika do rozmowy.

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Zwraca

Promise<void>

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.

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.

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

deleteMessage(string)

Usuń komunikat w wątku.

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

Parametry

messageId

string

Zwraca

Promise<void>

disposeLocalVideoStreamView()

Usuwanie widoku HTML dla lokalnego strumienia wideo

function disposeLocalVideoStreamView(): Promise<void>

Zwraca

Promise<void>

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>

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

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.

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

downloadResourceToCache(ResourceDetails)

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

Parametry

resourceDetails

ResourceDetails

Zwraca

Promise<void>

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>

holdCall()

Umieszcza połączenie w blokadzie lokalnej.

function holdCall(): Promise<void>

Zwraca

Promise<void>

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

leaveCall(boolean)

Pozostaw połączenie.

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

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.

lowerHand()

Dolna ręka dla użytkownika lokalnego.

function lowerHand(): Promise<void>

Zwraca

Promise<void>

mute()

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

function mute(): Promise<void>

Zwraca

Promise<void>

muteAllRemoteParticipants()

Wyciszanie uczestnika

function muteAllRemoteParticipants(): Promise<void>

Zwraca

Promise<void>

muteParticipant(string)

Wyciszanie uczestnika

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

Parametry

userId

string

Zwraca

Promise<void>

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>

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

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

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

raiseHand()

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

function raiseHand(): Promise<void>

Zwraca

Promise<void>

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>

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

UserId uczestnika do usunięcia.

Zwraca

Promise<void>

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametry

resourceDetails

ResourceDetails

resumeCall()

Wznawia połączenie ze stanu LocalHold.

function resumeCall(): Promise<void>

Zwraca

Promise<void>

returnFromBreakoutRoom()

Powrót do punktu początkowego w oddzielnym pokoju

function returnFromBreakoutRoom(): Promise<void>

Zwraca

Promise<void>

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>

sendReadReceipt(string)

Wyślij potwierdzenie odczytu dla wiadomości.

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

Parametry

chatMessageId

string

Zwraca

Promise<void>

sendTypingIndicator()

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

function sendTypingIndicator(): Promise<void>

Zwraca

Promise<void>

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>

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>

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>

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>

setSpokenLanguage(string)

Funkcja ustawiania języka mówionego

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

Parametry

language

string

Język mówiony

Zwraca

Promise<void>

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

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

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

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>

startCaptions(StartCaptionsAdapterOptions)

Funkcja uruchamiania napisów

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

Parametry

options

StartCaptionsAdapterOptions

Opcje napisów początkowych

Zwraca

Promise<void>

startNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function startNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

startSpotlight(string[])

Rozpocznij w centrum uwagi

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

Parametry

userIds

string[]

Zwraca

Promise<void>

startTogetherMode()

Uruchom tryb razem.

function startTogetherMode(): Promise<void>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

startVideoBackgroundEffect(VideoBackgroundEffect)

Uruchom efekt tła wideo.

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

Parametry

videoBackgroundEffect

VideoBackgroundEffect

Zwraca

Promise<void>

stopAllSpotlight()

Wyłączanie wszystkich reflektorów punktowych

function stopAllSpotlight(): Promise<void>

Zwraca

Promise<void>

stopCamera()

Zatrzymaj aparat.

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

function stopCamera(): Promise<void>

Zwraca

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Funkcja zatrzymywania napisów

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

Parametry

options

StopCaptionsAdapterOptions

Zwraca

Promise<void>

stopNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function stopNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

stopScreenShare()

Zatrzymaj udostępnianie ekranu.

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

stopSpotlight(string[])

Zatrzymaj reflektor punktowy

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

Parametry

userIds

string[]

Zwraca

Promise<void>

stopVideoBackgroundEffects()

Zatrzymaj efekt tła wideo.

function stopVideoBackgroundEffects(): Promise<void>

Zwraca

Promise<void>

submitSurvey(CallSurvey)

Wyślij wynik ankiety na koniec rozmowy

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

Parametry

survey

CallSurvey

Zwraca

Promise<undefined | CallSurveyResponse>

unmute()

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

function unmute(): Promise<void>

Zwraca

Promise<void>

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.

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>

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualizowanie wybranego efektu tła wideo

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground

VideoBackgroundEffect