CallWithChatAdapter interface

Paket:: @azure/communication-react

CallWithChatComposite Adapterschnittstelle.

Extends: CallWithChatAdapterManagement,AdapterState<CallWithChatAdapterState>,Disposable,CallWithChatAdapterSubscriptions

Geerbte 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

Geerbte 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.
dispose()	Löschen des Zusammengesetzten
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.
getState()	Abrufen des aktuellen Zustands
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
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)	Gekündigt den Handler für stateChanged-Ereignisse.
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)	Reaktion auf laufende Besprechung senden.
onStateChange((state: CallWithChatAdapterState) => void)	Abonniert den Handler für stateChanged-Ereignisse.
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

Geerbte Eigenschaftsdetails

forbidAudio

Verbietet Audio für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

Geerbt vonCallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

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

forbidOthersAudio: () => Promise<void>

Eigenschaftswert

() => Promise<void>

Geerbt vonCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

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

forbidOthersVideo: () => Promise<void>

Eigenschaftswert

() => Promise<void>

Geerbt vonCallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

Verbietet Video für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

Geerbt vonCallWithChatAdapterManagement.forbidVideo

permitAudio

Erlaubt Audio für die angegebenen Benutzer-IDs.

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

Eigenschaftswert

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

Geerbt vonCallWithChatAdapterManagement.permitAudio

permitOthersAudio

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

permitOthersAudio: () => Promise<void>

Eigenschaftswert

() => Promise<void>

Geerbt vonCallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

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

permitOthersVideo: () => Promise<void>

Eigenschaftswert

() => Promise<void>

Geerbt vonCallWithChatAdapterManagement.permitOthersVideo

permitVideo

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

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

Eigenschaftswert

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

Geerbt vonCallWithChatAdapterManagement.permitVideo

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>

Geerbt vonCallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

Senden Sie Text in Echtzeit

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

Eigenschaftswert

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

Geerbt vonCallWithChatAdapterManagement.sendRealTimeText

Details zur geerbten Methode

addParticipant(CommunicationUserIdentifier)

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

Parameter

participant: CommunicationUserIdentifier

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.addParticipant

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>

Geerbt vonCallWithChatAdapterManagement.addParticipant

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.

geerbt vonCallWithChatAdapterManagement.askDevicePermission

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.

Geerbt vonCallWithChatAdapterManagement.createStreamView-

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.

Geerbt vonCallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Löschen sie eine Nachricht im Thread.

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

Parameter

messageId: string

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.deleteMessage

dispose()

Löschen des Zusammengesetzten

function dispose()

Geerbt vonDisposable_2.dispose

disposeLocalVideoStreamView()

Verwerfen der HTML-Ansicht für einen lokalen Videostream

function disposeLocalVideoStreamView(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.disposeLocalVideoStreamView

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>

Geerbt vonCallWithChatAdapterManagement.disposeRemoteVideoStreamView

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

Geerbt vonCallWithChatAdapterManagement.disposeScreenShareStreamView

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.

vonCallWithChatAdapterManagement.disposeStreamView

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.

Geerbt vonCallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

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

Parameter

resourceDetails: ResourceDetails

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.downloadResourceToCache

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>

geerbt vonCallWithChatAdapterManagement.fetchInitialData-

getState()

Abrufen des aktuellen Zustands

function getState(): CallWithChatAdapterState

Gibt zurück

CallWithChatAdapterState

vonAdapterState.getState geerbt

holdCall()

Legt den Aufruf in einen Localhold ein.

function holdCall(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.holdCall

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

geerbt vonCallWithChatAdapterManagement.joinCall

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

geerbt vonCallWithChatAdapterManagement.joinCall

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>

geerbt vonCallWithChatAdapterManagement.leaveCall

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.

geerbt vonCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Senken Sie die Hand für den lokalen Benutzer.

function lowerHand(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.lowerHand

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>

geerbt vonCallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Stummschalten eines Teilnehmers

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Stummschalten eines Teilnehmers

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

Parameter

userId: string

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parameter

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("callEnded", CallEndedListener)

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

Parameter

event: "callEnded"

listener: CallEndedListener

vonCallWithChatAdapterSubscriptions.off geerbt

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

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

Parameter

event: "callError"

listener: (e: AdapterError) => void

vonCallWithChatAdapterSubscriptions.off geerbt

off("callIdChanged", CallIdChangedListener)

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

Parameter

event: "callIdChanged"

listener: CallIdChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("callParticipantsJoined", ParticipantsJoinedListener)

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

Parameter

event: "callParticipantsJoined"

listener: ParticipantsJoinedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("callParticipantsLeft", ParticipantsLeftListener)

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

Parameter

event: "callParticipantsLeft"

listener: ParticipantsLeftListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("capabilitiesChanged", CapabilitiesChangedListener)

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

Parameter

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("captionsReceived", CaptionsReceivedListener)

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

Parameter

event: "captionsReceived"

listener: CaptionsReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

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

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

Parameter

event: "chatError"

listener: (e: AdapterError) => void

vonCallWithChatAdapterSubscriptions.off geerbt

off("chatInitialized", ChatInitializedListener)

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

Parameter

event: "chatInitialized"

listener: ChatInitializedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("chatParticipantsAdded", ParticipantsAddedListener)

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

Parameter

event: "chatParticipantsAdded"

listener: ParticipantsAddedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("chatParticipantsRemoved", ParticipantsRemovedListener)

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

Parameter

event: "chatParticipantsRemoved"

listener: ParticipantsRemovedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("displayNameChanged", DisplayNameChangedListener)

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

Parameter

event: "displayNameChanged"

listener: DisplayNameChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parameter

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parameter

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parameter

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isMutedChanged", IsMutedChangedListener)

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

Parameter

event: "isMutedChanged"

listener: IsMutedChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isSpeakingChanged", IsSpeakingChangedListener)

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

Parameter

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parameter

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("messageDeleted", MessageReceivedListener)

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

Parameter

event: "messageDeleted"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("messageEdited", MessageReceivedListener)

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

Parameter

event: "messageEdited"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("messageRead", MessageReadListener)

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

Parameter

event: "messageRead"

listener: MessageReadListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("messageReceived", MessageReceivedListener)

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

Parameter

event: "messageReceived"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("messageSent", MessageReceivedListener)

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

Parameter

event: "messageSent"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parameter

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

vonCallWithChatAdapterSubscriptions.off geerbt

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parameter

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

vonCallWithChatAdapterSubscriptions.off geerbt

off("selectedSpeakerChanged", PropertyChangedEvent)

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

Parameter

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

vonCallWithChatAdapterSubscriptions.off geerbt

off("spotlightChanged", SpotlightChangedListener)

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

Parameter

event: "spotlightChanged"

listener: SpotlightChangedListener

vonCallWithChatAdapterSubscriptions.off geerbt

offStateChange((state: CallWithChatAdapterState) => void)

Gekündigt den Handler für stateChanged-Ereignisse.

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

Parameter

handler: (state: CallWithChatAdapterState) => void

vonAdapterState.offStateChange geerbt

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parameter

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

vonCallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

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

Parameter

event: "callEnded"

listener: CallEndedListener

vonCallWithChatAdapterSubscriptions.on

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

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

Parameter

event: "callError"

listener: (e: AdapterError) => void

vonCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

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

Parameter

event: "callIdChanged"

listener: CallIdChangedListener

vonCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

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

Parameter

event: "callParticipantsJoined"

listener: ParticipantsJoinedListener

vonCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

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

Parameter

event: "callParticipantsLeft"

listener: ParticipantsLeftListener

vonCallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

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

Parameter

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

vonCallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

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

Parameter

event: "captionsReceived"

listener: CaptionsReceivedListener

vonCallWithChatAdapterSubscriptions.on

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

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

Parameter

event: "chatError"

listener: (e: AdapterError) => void

vonCallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

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

Parameter

event: "chatInitialized"

listener: ChatInitializedListener

vonCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

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

Parameter

event: "chatParticipantsAdded"

listener: ParticipantsAddedListener

vonCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

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

Parameter

event: "chatParticipantsRemoved"

listener: ParticipantsRemovedListener

vonCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

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

Parameter

event: "displayNameChanged"

listener: DisplayNameChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parameter

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parameter

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parameter

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

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

Parameter

event: "isMutedChanged"

listener: IsMutedChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

Parameter

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

vonCallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parameter

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

vonCallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

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

Parameter

event: "messageDeleted"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

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

Parameter

event: "messageEdited"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

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

Parameter

event: "messageRead"

listener: MessageReadListener

vonCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

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

Parameter

event: "messageReceived"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

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

Parameter

event: "messageSent"

listener: MessageReceivedListener

vonCallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parameter

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

vonCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parameter

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

vonCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Parameter

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

vonCallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

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

Parameter

event: "spotlightChanged"

listener: SpotlightChangedListener

vonCallWithChatAdapterSubscriptions.on

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>

Geerbt vonCallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Abonniert den Handler für stateChanged-Ereignisse.

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

Parameter

handler: (state: CallWithChatAdapterState) => void

vonAdapterState.onStateChange geerbt

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.

geerbt vonCallWithChatAdapterManagement.queryCameras

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.

geerbt vonCallWithChatAdapterManagement.queryMicrophones

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.

geerbt vonCallWithChatAdapterManagement.querySpeakers

raiseHand()

Heben Sie die Hand für den lokalen Benutzer.

function raiseHand(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.raiseHand

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>

Geerbt vonCallWithChatAdapterManagement.removeParticipant

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>

Geerbt vonCallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parameter

resourceDetails: ResourceDetails

Geerbt vonCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Setzt den Aufruf aus einem LocalHold-Zustand fort.

function resumeCall(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.returnFromBreakoutRoom

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>

geerbt vonCallWithChatAdapterManagement.sendMessage

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>

geerbt vonCallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Senden sie die Eingabeanzeige im Thread.

function sendTypingIndicator(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallWithChatAdapterManagement.sendTypingIndicator

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>

Geerbt vonCallWithChatAdapterManagement.setCamera

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>

Geerbt vonCallWithChatAdapterManagement.setCaptionLanguage

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>

geerbt vonCallWithChatAdapterManagement.setMicrophone

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>

geerbt vonCallWithChatAdapterManagement.setSpeaker

setSpokenLanguage(string)

Funktion zum Einstellen der gesprochenen Sprache

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

Parameter

language: string

gesprochene Sprache

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.setSpokenLanguage

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.

Geerbt vonCallWithChatAdapterManagement.setTogetherModeSceneSize

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

geerbt vonCallWithChatAdapterManagement.startCall

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

geerbt vonCallWithChatAdapterManagement.startCall

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>

geerbt vonCallWithChatAdapterManagement.startCamera

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>

Geerbt vonCallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function startNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

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

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Spotlight starten

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Gemeinsam starten-Modus.

function startTogetherMode(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

Geerbt vonCallWithChatAdapterManagement.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Starten Sie den Video-Hintergrundeffekt.

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

Parameter

videoBackgroundEffect: VideoBackgroundEffect

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Stoppen Sie alle Scheinwerfer

function stopAllSpotlight(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.stopAllSpotlight

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>

geerbt vonCallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funktion zum Stoppen von Untertiteln

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

Parameter

options: StopCaptionsAdapterOptions

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function stopNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Beenden Sie die Freigabe des Bildschirms.

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallWithChatAdapterManagement.stopScreenShare-

stopSpotlight(string[])

Stopp Spotlight

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Stoppen Sie den Videohintergrundeffekt.

function stopVideoBackgroundEffects(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallWithChatAdapterManagement.stopVideoBackgroundEffects

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>

Geerbt vonCallWithChatAdapterManagement.submitSurvey

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>

geerbt vonCallWithChatAdapterManagement.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages: VideoBackgroundImage[]

Array von benutzerdefinierten Hintergrundbildern.

Geerbt vonCallWithChatAdapterManagement.updateBackgroundPickerImages

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>

geerbt vonCallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualisieren des ausgewählten Videohintergrundeffekts

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground: VideoBackgroundEffect

Geerbt vonCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect

Freigeben über

CallWithChatAdapter interface

Geerbte Eigenschaften

Geerbte Methoden

Geerbte Eigenschaftsdetails

forbidAudio

Eigenschaftswert

forbidOthersAudio

Eigenschaftswert

forbidOthersVideo

Eigenschaftswert

forbidVideo

Eigenschaftswert

permitAudio

Eigenschaftswert

permitOthersAudio

Eigenschaftswert

permitOthersVideo

Eigenschaftswert

permitVideo

Eigenschaftswert

sendDtmfTone

Eigenschaftswert

sendRealTimeText

Eigenschaftswert

Details zur geerbten Methode

addParticipant(CommunicationUserIdentifier)

Parameter

Gibt zurück

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Parameter

Gibt zurück

askDevicePermission(PermissionConstraints)

Parameter

Gibt zurück

Hinweise

createStreamView(string, VideoStreamOptions)

Parameter

Gibt zurück

Hinweise

createTogetherModeStreamView(TogetherModeStreamOptions)

Parameter

Gibt zurück

Hinweise

deleteMessage(string)

Parameter

Gibt zurück

dispose()

disposeLocalVideoStreamView()

Gibt zurück

disposeRemoteVideoStreamView(string)

Parameter

Gibt zurück

disposeScreenShareStreamView(string)

Parameter

Gibt zurück

Hinweise

disposeStreamView(string, VideoStreamOptions)

Parameter

Gibt zurück

Hinweise

disposeTogetherModeStreamView()

Gibt zurück

Hinweise

downloadResourceToCache(ResourceDetails)

Parameter

Gibt zurück

fetchInitialData()

Gibt zurück

getState()

Gibt zurück

holdCall()

Gibt zurück

joinCall(boolean)

Parameter

Gibt zurück

joinCall(JoinCallOptions)

Parameter

Gibt zurück

leaveCall(boolean)