CallWithChatAdapterManagement interface

Paket:

@azure/communication-react

Funktionalität für die Verwaltung des aktuellen Anrufs mit Chat.

Eigenschaften

forbidAudio	Verbietet Audio für die angegebenen Benutzer-IDs.
forbidOthersAudio	Verbietet Audio für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.
forbidOthersVideo	Verbietet Video für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.
forbidVideo	Verbietet Video für die angegebenen Benutzer-IDs.
permitAudio	Erlaubt Audio für die angegebenen Benutzer-IDs.
permitOthersAudio	Ermöglicht Audio für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.
permitOthersVideo	Ermöglicht Videos für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.
permitVideo	Lässt Video für die angegebenen Benutzer-IDs zu.
sendDtmfTone	Senden Sie DTMF-Ton in 1:1-Anrufen an einen anderen Teilnehmer des Anrufs
sendRealTimeText	Senden Sie Text in Echtzeit

Methoden

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Fügt dem Anruf einen neuen Teilnehmer hinzu.
askDevicePermission(PermissionConstraints)	Fragen Sie nach Berechtigungen von Geräten.
createStreamView(string, VideoStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Datenstrom.
createTogetherModeStreamView(TogetherModeStreamOptions)	Erstellen Sie die HTML-Ansicht für einen togethermode-Stream.
deleteMessage(string)	Löschen sie eine Nachricht im Thread.
disposeLocalVideoStreamView()	Verwerfen der HTML-Ansicht für einen lokalen Videostream
disposeRemoteVideoStreamView(string)	Verwerfen der HTML-Ansicht für einen Remote-Videostream
disposeScreenShareStreamView(string)	Verwerfen der HTML-Ansicht für einen Bildschirmfreigabestream
disposeStreamView(string, VideoStreamOptions)	Verwerfen Sie die HTML-Ansicht für einen Datenstrom.
disposeTogetherModeStreamView()	Verwerfen Sie die HTML-Ansicht für einen togethermode-Stream.
downloadResourceToCache(ResourceDetails)
fetchInitialData()	Ruft den Anfangszustand für den Chatadapter ab. Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.
holdCall()	Legt den Aufruf in einen Localhold ein.
joinCall(boolean)	Treten Sie dem Anruf zunächst mit mikrofon ein/aus.
joinCall(JoinCallOptions)	Mit Optionen am Anruf teilnehmen zum Festlegen des Anfangszustands des Mikrofons/der Kamera beim Beitritt zum Anruf true = Gerät beim Beitritt zum Anruf einschalten false = Gerät ausschalten, wenn dem Anruf beigetreten wird 'behalten'/undefiniert = den Status des Geräts vor dem Anruf beibehalten
leaveCall(boolean)	Verlassen Sie den Anruf.
loadPreviousChatMessages(number)	Laden Sie weitere vorherige Nachrichten im Chatthreadverlauf.
lowerHand()	Senken Sie die Hand für den lokalen Benutzer.
mute()	Schalten Sie den aktuellen Benutzer während des Anrufs stumm, oder deaktivieren Sie das Mikrofon lokal.
muteAllRemoteParticipants()	Stummschalten eines Teilnehmers
muteParticipant(string)	Stummschalten eines Teilnehmers
onReactionClick(Reaction)	Reaktion auf laufende Besprechung senden.
queryCameras()	Fragen Sie nach verfügbaren Kamerageräten ab.
queryMicrophones()	Abfrage nach verfügbaren Mikrofongeräten.
querySpeakers()	Abfrage nach verfügbaren Mikrofongeräten.
raiseHand()	Heben Sie die Hand für den lokalen Benutzer.
removeParticipant(CommunicationIdentifier)	Entfernen Sie einen Teilnehmer aus dem Anruf.
removeParticipant(string)	Entfernen eines Teilnehmers aus einem Anruf.
removeResourceFromCache(ResourceDetails)
resumeCall()	Setzt den Aufruf aus einem LocalHold-Zustand fort.
returnFromBreakoutRoom()	Zurück zum ursprünglichen Aufruf des Breakout-Raums
sendMessage(string, SendMessageOptions)	Senden Sie eine Nachricht im Thread.
sendReadReceipt(string)	Senden sie eine Lesebestätigung für eine Nachricht.
sendTypingIndicator()	Senden sie die Eingabeanzeige im Thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Legen Sie die Kamera fest, die im Anruf verwendet werden soll.
setCaptionLanguage(string)	Funktion zum Festlegen der Untertitelsprache
setMicrophone(AudioDeviceInfo)	Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll.
setSpeaker(AudioDeviceInfo)	Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll.
setSpokenLanguage(string)	Funktion zum Einstellen der gesprochenen Sprache
setTogetherModeSceneSize(number, number)	Berechnen Sie die Sitzpositionen für den Together-Modus neu.
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Starten Sie den Anruf.
startCall(string[], StartCallOptions)	Starten Sie den Anruf.
startCamera(VideoStreamOptions)	Starten Sie die Kamera. Diese Methode beginnt mit dem Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
startCaptions(StartCaptionsAdapterOptions)	Funktion zum Starten von Untertiteln
startNoiseSuppressionEffect()	Starten Sie den Rauschunterdrückungseffekt.
startScreenShare()	Starten Sie die Freigabe des Bildschirms während eines Anrufs.
startSpotlight(string[])	Spotlight starten
startTogetherMode()	Gemeinsam starten-Modus.
startVideoBackgroundEffect(VideoBackgroundEffect)	Starten Sie den Video-Hintergrundeffekt.
stopAllSpotlight()	Stoppen Sie alle Scheinwerfer
stopCamera()	Beenden Sie die Kamera. Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
stopCaptions(StopCaptionsAdapterOptions)	Funktion zum Stoppen von Untertiteln
stopNoiseSuppressionEffect()	Starten Sie den Rauschunterdrückungseffekt.
stopScreenShare()	Beenden Sie die Freigabe des Bildschirms.
stopSpotlight(string[])	Stopp Spotlight
stopVideoBackgroundEffects()	Stoppen Sie den Videohintergrundeffekt.
submitSurvey(CallSurvey)	Senden Sie das Ergebnis der Umfrage am Ende des Anrufs
unmute()	Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal.
updateBackgroundPickerImages(VideoBackgroundImage[])	Überschreiben Sie die Hintergrundauswahlbilder, um den Hintergrundersetzungseffekt zu erzielen.
updateMessage(string, string, Record<string, string>)	Aktualisieren eines Nachrichteninhalts.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Aktualisieren des ausgewählten Videohintergrundeffekts

Details zur Eigenschaft

forbidAudio

Verbietet Audio für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

forbidOthersAudio

Verbietet Audio für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.

forbidOthersAudio: () => Promise<void>

Eigenschaftswert

() => Promise<void>

forbidOthersVideo

Verbietet Video für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.

forbidOthersVideo: () => Promise<void>

Eigenschaftswert

() => Promise<void>

forbidVideo

Verbietet Video für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

permitAudio

Erlaubt Audio für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

permitOthersAudio

Ermöglicht Audio für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.

permitOthersAudio: () => Promise<void>

Eigenschaftswert

() => Promise<void>

permitOthersVideo

Ermöglicht Videos für Teams-Besprechungsteilnehmer mit Ausnahme des lokalen Benutzers.

permitOthersVideo: () => Promise<void>

Eigenschaftswert

() => Promise<void>

permitVideo

Lässt Video für die angegebenen Benutzer-IDs zu.

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

Eigenschaftswert

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

sendDtmfTone

Senden Sie DTMF-Ton in 1:1-Anrufen an einen anderen Teilnehmer des Anrufs

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

Eigenschaftswert

(dtmfTone: DtmfTone) => Promise<void>

sendRealTimeText

Senden Sie Text in Echtzeit

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

Eigenschaftswert

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

Details zur Methode

addParticipant(CommunicationUserIdentifier)

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

Parameter

participant

CommunicationUserIdentifier

Gibt zurück

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Fügt dem Anruf einen neuen Teilnehmer hinzu.

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

Parameter

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Gibt zurück

Promise<void>

askDevicePermission(PermissionConstraints)

Fragen Sie nach Berechtigungen von Geräten.

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

Parameter

constrain

PermissionConstraints

Definieren von Einschränkungen für den Zugriff auf lokale Geräte <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Gibt zurück

Promise<DeviceAccess>

Hinweise

Das Browserberechtigungsfenster wird eingeblennt, wenn noch keine Berechtigungen erteilt werden.

createStreamView(string, VideoStreamOptions)

Erstellen Sie die HTML-Ansicht für einen Datenstrom.

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

Parameter

remoteUserId

string

Id des zu rendernden Teilnehmers, lassen Sie ihn nicht definiert, um die lokale Kameraansicht zu erstellen.

options

VideoStreamOptions

Optionen zum Steuern, wie Videodatenströme <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions> gerendert werden

Gibt zurück

Promise<void | CreateVideoStreamViewResult>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

createTogetherModeStreamView(TogetherModeStreamOptions)

Erstellen Sie die HTML-Ansicht für einen togethermode-Stream.

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

Parameter

options

TogetherModeStreamOptions

Optionen zum Steuern, wie Videodatenströme <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions> gerendert werden

Gibt zurück

Promise<void | TogetherModeStreamViewResult>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

deleteMessage(string)

Löschen sie eine Nachricht im Thread.

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

Parameter

messageId

string

Gibt zurück

Promise<void>

disposeLocalVideoStreamView()

Verwerfen der HTML-Ansicht für einen lokalen Videostream

function disposeLocalVideoStreamView(): Promise<void>

Gibt zurück

Promise<void>

disposeRemoteVideoStreamView(string)

Verwerfen der HTML-Ansicht für einen Remote-Videostream

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

Parameter

remoteUserId

string

Id des Teilnehmers, der entsorgt werden soll

Gibt zurück

Promise<void>

disposeScreenShareStreamView(string)

Verwerfen der HTML-Ansicht für einen Bildschirmfreigabestream

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

Parameter

remoteUserId

string

ID des Teilnehmers, für den die Streamansicht der Bildschirmfreigabe verworfen werden soll.

Gibt zurück

Promise<void>

Hinweise

Diese Methode ist für Composites implementiert

disposeStreamView(string, VideoStreamOptions)

Verwerfen Sie die HTML-Ansicht für einen Datenstrom.

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

Parameter

remoteUserId

string

Id des zu rendernden Teilnehmers, lassen Sie ihn nicht definiert, um die lokale Kameraansicht zu löschen.

options

VideoStreamOptions

Optionen zum Steuern, wie Videodatenströme <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions> gerendert werden

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

disposeTogetherModeStreamView()

Verwerfen Sie die HTML-Ansicht für einen togethermode-Stream.

function disposeTogetherModeStreamView(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

downloadResourceToCache(ResourceDetails)

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

Parameter

resourceDetails

ResourceDetails

Gibt zurück

Promise<void>

fetchInitialData()

Ruft den Anfangszustand für den Chatadapter ab.

Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.

function fetchInitialData(): Promise<void>

Gibt zurück

Promise<void>

holdCall()

Legt den Aufruf in einen Localhold ein.

function holdCall(): Promise<void>

Gibt zurück

Promise<void>

joinCall(boolean)

Warnung

Diese API ist nun veraltet.

Use joinCall(options?:JoinCallOptions) instead.

Treten Sie dem Anruf zunächst mit mikrofon ein/aus.

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

Parameter

microphoneOn

boolean

Gibt an, ob das Mikrofon anfänglich aktiviert ist.

Gibt zurück

undefined | Call

joinCall(JoinCallOptions)

Mit Optionen am Anruf teilnehmen zum Festlegen des Anfangszustands des Mikrofons/der Kamera beim Beitritt zum Anruf true = Gerät beim Beitritt zum Anruf einschalten false = Gerät ausschalten, wenn dem Anruf beigetreten wird 'behalten'/undefiniert = den Status des Geräts vor dem Anruf beibehalten

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

Parameter

options

JoinCallOptions

-Parameter, um das Mikrofon/die Kamera anfänglich ein/auszuschalten/den Precall-Status zu verwenden.

Gibt zurück

undefined | Call

leaveCall(boolean)

Verlassen Sie den Anruf.

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

Parameter

forEveryone

boolean

Gibt an, ob alle Teilnehmer beim Verlassen entfernt werden sollen.

Gibt zurück

Promise<void>

loadPreviousChatMessages(number)

Laden Sie weitere vorherige Nachrichten im Chatthreadverlauf.

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

Parameter

messagesToLoad

number

Gibt zurück

Promise<boolean>

Hinweise

Diese Methode wird in der Regel verwendet, um den inkrementellen Abruf/unendlichen Bildlauf zu steuern.

lowerHand()

Senken Sie die Hand für den lokalen Benutzer.

function lowerHand(): Promise<void>

Gibt zurück

Promise<void>

mute()

Schalten Sie den aktuellen Benutzer während des Anrufs stumm, oder deaktivieren Sie das Mikrofon lokal.

function mute(): Promise<void>

Gibt zurück

Promise<void>

muteAllRemoteParticipants()

Stummschalten eines Teilnehmers

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

muteParticipant(string)

Stummschalten eines Teilnehmers

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

Parameter

userId

string

Gibt zurück

Promise<void>

onReactionClick(Reaction)

Reaktion auf laufende Besprechung senden.

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

Parameter

reaction

Reaction

Ein Wert vom Typ <xref:%40azure%2Fcommunication-calling%23Reaction>

Gibt zurück

Promise<void>

queryCameras()

Fragen Sie nach verfügbaren Kamerageräten ab.

function queryCameras(): Promise<VideoDeviceInfo[]>

Gibt zurück

Promise<VideoDeviceInfo[]>

Ein Array von Entitäten für Videogeräteinformationen <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

queryMicrophones()

Abfrage nach verfügbaren Mikrofongeräten.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Gibt zurück

Promise<AudioDeviceInfo[]>

Ein Array von Informationseinheiten für Audiogeräte <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

querySpeakers()

Abfrage nach verfügbaren Mikrofongeräten.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Gibt zurück

Promise<AudioDeviceInfo[]>

Ein Array von Informationseinheiten für Audiogeräte <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

raiseHand()

Heben Sie die Hand für den lokalen Benutzer.

function raiseHand(): Promise<void>

Gibt zurück

Promise<void>

removeParticipant(CommunicationIdentifier)

Entfernen Sie einen Teilnehmer aus dem Anruf.

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

Parameter

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> des Teilnehmers, der entfernt werden soll

Gibt zurück

Promise<void>

removeParticipant(string)

Entfernen eines Teilnehmers aus einem Anruf.

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

Parameter

userId

string

UserId des zu entfernenden Teilnehmers.

Gibt zurück

Promise<void>

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parameter

resourceDetails

ResourceDetails

resumeCall()

Setzt den Aufruf aus einem LocalHold-Zustand fort.

function resumeCall(): Promise<void>

Gibt zurück

Promise<void>

returnFromBreakoutRoom()

Zurück zum ursprünglichen Aufruf des Breakout-Raums

function returnFromBreakoutRoom(): Promise<void>

Gibt zurück

Promise<void>

sendMessage(string, SendMessageOptions)

Senden Sie eine Nachricht im Thread.

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

Parameter

content

string

options

SendMessageOptions

Gibt zurück

Promise<void>

sendReadReceipt(string)

Senden sie eine Lesebestätigung für eine Nachricht.

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

Parameter

chatMessageId

string

Gibt zurück

Promise<void>

sendTypingIndicator()

Senden sie die Eingabeanzeige im Thread.

function sendTypingIndicator(): Promise<void>

Gibt zurück

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

Legen Sie die Kamera fest, die im Anruf verwendet werden soll.

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

Parameter

sourceInfo

VideoDeviceInfo

Kameragerät auswählen, wählen Sie eine von queryCameras

options

VideoStreamOptions

Optionen zum Steuern der Darstellung des Kameradatenstroms <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Gibt zurück

Promise<void>

setCaptionLanguage(string)

Funktion zum Festlegen der Untertitelsprache

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

Parameter

language

string

Sprache für Untertitel eingestellt

Gibt zurück

Promise<void>

setMicrophone(AudioDeviceInfo)

Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll.

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

Parameter

sourceInfo

AudioDeviceInfo

Wählen Sie ein Mikrofongerät aus, das von queryMicrophones

Gibt zurück

Promise<void>

setSpeaker(AudioDeviceInfo)

Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll.

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

Parameter

sourceInfo

AudioDeviceInfo

Zu wählende Lautsprechergerät wählen Sie eine von querySpeakers

Gibt zurück

Promise<void>

setSpokenLanguage(string)

Funktion zum Einstellen der gesprochenen Sprache

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

Parameter

language

string

gesprochene Sprache

Gibt zurück

Promise<void>

setTogetherModeSceneSize(number, number)

Berechnen Sie die Sitzpositionen für den Together-Modus neu.

function setTogetherModeSceneSize(width: number, height: number)

Parameter

width

number

Breite des Behälters

height

number

Höhe des Behälters

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

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

Starten Sie den Anruf.

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

Parameter

participants

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

Ein Array von <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> aufzurufendes Array

options

StartCallOptions

Gibt zurück

undefined | Call

startCall(string[], StartCallOptions)

Starten Sie den Anruf.

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

Parameter

participants

string[]

Ein Array von Teilnehmer-IDs zur Teilnahme

options

StartCallOptions

Gibt zurück

undefined | Call

startCamera(VideoStreamOptions)

Starten Sie die Kamera.

Diese Methode beginnt mit dem Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.

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

Parameter

options

VideoStreamOptions

Optionen zum Steuern, wie Videodatenströme <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions> gerendert werden

Gibt zurück

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Funktion zum Starten von Untertiteln

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

Parameter

options

StartCaptionsAdapterOptions

Optionen für Startuntertitel

Gibt zurück

Promise<void>

startNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function startNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

startScreenShare()

Starten Sie die Freigabe des Bildschirms während eines Anrufs.

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

startSpotlight(string[])

Spotlight starten

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

Parameter

userIds

string[]

Gibt zurück

Promise<void>

startTogetherMode()

Gemeinsam starten-Modus.

function startTogetherMode(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

startVideoBackgroundEffect(VideoBackgroundEffect)

Starten Sie den Video-Hintergrundeffekt.

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

Parameter

videoBackgroundEffect

VideoBackgroundEffect

Gibt zurück

Promise<void>

stopAllSpotlight()

Stoppen Sie alle Scheinwerfer

function stopAllSpotlight(): Promise<void>

Gibt zurück

Promise<void>

stopCamera()

Beenden Sie die Kamera.

Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.

function stopCamera(): Promise<void>

Gibt zurück

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Funktion zum Stoppen von Untertiteln

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

Parameter

options

StopCaptionsAdapterOptions

Gibt zurück

Promise<void>

stopNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function stopNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

stopScreenShare()

Beenden Sie die Freigabe des Bildschirms.

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

stopSpotlight(string[])

Stopp Spotlight

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

Parameter

userIds

string[]

Gibt zurück

Promise<void>

stopVideoBackgroundEffects()

Stoppen Sie den Videohintergrundeffekt.

function stopVideoBackgroundEffects(): Promise<void>

Gibt zurück

Promise<void>

submitSurvey(CallSurvey)

Senden Sie das Ergebnis der Umfrage am Ende des Anrufs

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

Parameter

survey

CallSurvey

Gibt zurück

Promise<undefined | CallSurveyResponse>

unmute()

Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal.

function unmute(): Promise<void>

Gibt zurück

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Überschreiben Sie die Hintergrundauswahlbilder, um den Hintergrundersetzungseffekt zu erzielen.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages

VideoBackgroundImage[]

Array von benutzerdefinierten Hintergrundbildern.

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

Aktualisieren eines Nachrichteninhalts.

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

Parameter

messageId

string

content

string

options

Record<string, string>

Gibt zurück

Promise<void>

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualisieren des ausgewählten Videohintergrundeffekts

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground

VideoBackgroundEffect