CallAdapter interface

Paket:: @azure/communication-react

Eine adapterspezifische Schnittstelle für Azure Communication Identity, die CommonCallAdapter-erweitert.

Extends: CommonCallAdapter

Geerbte Eigenschaften

Senden Sie Text in Echtzeit

Methoden

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
startCall(CommunicationIdentifier[], StartCallOptions)	Starten Sie den Anruf.
startCall(string[], StartCallOptions)	Starten Sie den Anruf.

Geerbte Methoden

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Fügen Sie dem Anruf einen 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 Datenstrom.
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 Datenstrom.
forbidAudio(string[])	Verbieten Sie Teams-Besprechungsteilnehmern Audioaufnahmen anhand ihrer Benutzer-IDs.
forbidOthersAudio()	Audio von Teams-Besprechungen verbieten.
forbidOthersVideo()	Besprechungen in Teams verbieten.
forbidVideo(string[])	Verbieten Sie Teams-Besprechungsteilnehmern das Video anhand ihrer Benutzer-IDs.
getState()	Abrufen des aktuellen Zustands
holdCall()	Hält den Anruf.
leaveCall(boolean)	Verlassen des Anrufs
lowerHand()	Untere Hand für den aktuellen Benutzer
mute()	Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons
muteAllRemoteParticipants()	Stummschalten Alle Teilnehmer
muteParticipant(string)	Stummschalten eines Teilnehmers
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Funktion zum Abbestellen des Ereignisses 'breakoutRoomsUpdated'.
off("callEnded", CallEndedListener)	Abmeldefunktion für das Ereignis "callEnded".
off("callIdChanged", CallIdChangedListener)	Gekündigte Funktion für das Ereignis "callIdChanged".
off("capabilitiesChanged", CapabilitiesChangedListener)	Abmeldefunktion für das Ereignis 'capabilitiesChanged'.
off("captionsReceived", CaptionsReceivedListener)	Abmeldefunktion für das Ereignis 'captionsReceived'.
off("diagnosticChanged", DiagnosticChangedEventListner)	Gekündigte Funktion für das Ereignis "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Abmeldefunktion für das Ereignis "displayNameChanged".
off("error", (e: AdapterError) => void)	Gekündigte Funktion für das Ereignis "error".
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Abmeldefunktion für das Ereignis 'isCaptionLanguageChanged'.
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Abmeldefunktion für das Ereignis 'isCaptionsActiveChanged'.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Gekündigte Funktion für das Ereignis "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Abmeldefunktion für das Ereignis "isSpeakingChanged".
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Funktion zum Abbestellen des Ereignisses 'isSpokenLanguageChanged'.
off("mutedByOthers", PropertyChangedEvent)	Abmeldefunktion für das Ereignis 'mutedByOthers'.
off("participantsJoined", ParticipantsJoinedListener)	Abmeldefunktion für das Ereignis "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Abmeldefunktion für das Ereignis "participantsLeft".
off("realTimeTextReceived", RealTimeTextReceivedListener)	Unsubscribe-Funktion für das Ereignis 'realTimeTextReceived'.
off("roleChanged", PropertyChangedEvent)	Abmeldefunktion für das Ereignis 'roleChanged'.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Gekündigte Funktion für das Ereignis "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Abmeldefunktion für das Ereignis "selectedSpeakerChanged".
off("spotlightChanged", SpotlightChangedListener)	Abmeldefunktion für das Ereignis 'spotlightChanged'.
off("transferAccepted", TransferAcceptedListener)	Unsubscribe-Funktion für das Ereignis 'transferRequested'.
offStateChange((state: CallAdapterState) => void)	Gekündigt den Handler für stateChanged-Ereignisse.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Abonnieren Sie die Funktion für das Ereignis 'breakoutRoomsUpdated'.
on("callEnded", CallEndedListener)	Abonnieren Sie die Funktion für das Ereignis "callEnded".
on("callIdChanged", CallIdChangedListener)	Abonnieren Sie die Funktion für das Ereignis 'callIdChanged'.
on("capabilitiesChanged", CapabilitiesChangedListener)	Subscribe-Funktion für das Ereignis 'capabilitiesChanged'.
on("captionsReceived", CaptionsReceivedListener)	Abonnieren-Funktion für das Ereignis 'captionsReceived'.
on("diagnosticChanged", DiagnosticChangedEventListner)	Abonnieren Sie die Funktion für das Ereignis "diagnosticChanged". Dieses Ereignis wird ausgelöst, wenn sich die Diagnose des Benutzers über den laufenden Anruf ändert.
on("displayNameChanged", DisplayNameChangedListener)	Abonnieren Sie die Funktion für das Ereignis "displayNameChanged".
on("error", (e: AdapterError) => void)	Abonnieren Sie die Funktion für das Ereignis "error".
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Subscribe-Funktion für das Ereignis 'isCaptionLanguageChanged'.
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Abonnieren Sie die Funktion für das Ereignis 'isCaptionsActiveChanged'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Subscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Subscribe-Funktion für das Ereignis "isMutedChanged".
on("isSpeakingChanged", IsSpeakingChangedListener)	Abonnieren Sie die Funktion für das Ereignis "isSpeakingChanged".
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Subscribe-Funktion für das Ereignis 'isSpokenLanguageChanged'.
on("mutedByOthers", PropertyChangedEvent)	Abonnieren Sie die Funktion für das Ereignis 'mutedByOthers'.
on("participantsJoined", ParticipantsJoinedListener)	Abonnieren Sie die Funktion für das Ereignis "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Abonnieren Sie die Funktion für das Ereignis "participantsLeft".
on("realTimeTextReceived", RealTimeTextReceivedListener)	Subscribe-Funktion für das Ereignis 'realTimeTextReceived'.
on("roleChanged", PropertyChangedEvent)	Subscribe-Funktion für das Ereignis 'roleChanged'.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Abonnieren Sie die Funktion für das Ereignis "selectedMicrophoneChanged". Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Mikrofongerät auswählt.
on("selectedSpeakerChanged", PropertyChangedEvent)	Abonnieren Sie die Funktion für das Ereignis "selectedSpeakerChanged". Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Lautsprechergerät auswählt.
on("spotlightChanged", SpotlightChangedListener)	Abonnieren Sie die Funktion für das Ereignis 'spotlightChanged'.
on("transferAccepted", TransferAcceptedListener)	Subscribe-Funktion für das Ereignis 'transferRequested'.
onReactionClick(Reaction)	Reaktions-Emoji senden
onStateChange((state: CallAdapterState) => void)	Abonniert den Handler für stateChanged-Ereignisse.
permitAudio(string[])	Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs.
permitOthersAudio()	Audio für Teams-Besprechungen zulassen.
permitOthersVideo()	Erlauben Sie Teams-Besprechungsvideo.
permitVideo(string[])	Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs.
queryCameras()	Fragen Sie nach verfügbaren Kamerageräten ab.
queryMicrophones()	Abfrage nach verfügbaren Mikrofongeräten.
querySpeakers()	Abfrage nach verfügbaren Lautsprechergeräten.
raiseHand()	Hand heben für aktuellen Benutzer
removeParticipant(CommunicationIdentifier)	Entfernen Sie einen Teilnehmer aus dem Anruf.
removeParticipant(string)	Entfernen Sie einen Teilnehmer aus dem Anruf.
resumeCall()	Setzt den Anruf aus einem `LocalHold` Status fort.
returnFromBreakoutRoom()	Zurück zum ursprünglichen Aufruf des Breakout-Raums
sendDtmfTone(DtmfTone)	Senden des DTMF-Tons an einen anderen Teilnehmer in einem 1:1-PSTN-Anruf
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.
startCamera(VideoStreamOptions)	Starten Sie die Kamera Diese Methode startet das 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[])	Starten Sie das Spotlight für lokale und Remote-Teilnehmer anhand ihrer Benutzer-IDs. Wenn kein Array von Benutzer-IDs übergeben wird, wird die Aktion für den lokalen Teilnehmer ausgeführt.
startTogetherMode()	Modus "Gemeinsam starten".
startVideoBackgroundEffect(VideoBackgroundEffect)	Starten Sie den Video-Hintergrundeffekt.
stopAllSpotlight()	Stoppen Sie alle Scheinwerfer
stopCamera()	Beenden der Kamera Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
stopCaptions(StopCaptionsAdapterOptions)	Funktion zum Stoppen von Untertiteln
stopNoiseSuppressionEffect()	Stoppen Sie den Rauschunterdrückungseffekt.
stopScreenShare()	Beenden der Freigabe des Bildschirms
stopSpotlight(string[])	Stoppen Sie das Spotlight für lokale und Remote-Teilnehmer anhand ihrer Benutzer-IDs. Wenn kein Array von Benutzer-IDs übergeben wird, wird die Aktion für den lokalen Teilnehmer ausgeführt.
stopVideoBackgroundEffects()	Stoppen Sie den Videohintergrundeffekt.
submitSurvey(CallSurvey)	Senden Sie das Ergebnis der Umfrage am Ende des Anrufs
unmute()	Aufheben der Stummschaltung des aktuellen Benutzers während des Anrufs oder lokales Aktivieren des Mikrofons
updateBackgroundPickerImages(VideoBackgroundImage[])	Überschreiben Sie die Hintergrundauswahlbilder, um den Hintergrundersetzungseffekt zu erzielen.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Aktualisieren Sie den ausgewählten Videohintergrundeffekt.

Geerbte Eigenschaftsdetails

sendRealTimeText

Senden Sie Text in Echtzeit

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

Eigenschaftswert

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

Geerbt vonCommonCallAdapter.sendRealTimeText

Details zur Methode

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

startCall(CommunicationIdentifier[], StartCallOptions)

Starten Sie den Anruf.

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

Parameter

participants: CommunicationIdentifier[]

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

Details zur geerbten Methode

addParticipant(CommunicationUserIdentifier)

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

Parameter

participant: CommunicationUserIdentifier

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Fügen Sie dem Anruf einen Teilnehmer hinzu.

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

Parameter

participant: PhoneNumberIdentifier

options: AddPhoneNumberOptions

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.createStreamView-

createTogetherModeStreamView(TogetherModeStreamOptions)

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

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

dispose()

Löschen des Zusammengesetzten

function dispose()

geerbt vonCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Verwerfen der HTML-Ansicht für einen lokalen Videostream

function disposeLocalVideoStreamView(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Warnung

Diese API ist nun veraltet.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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.

geerbt vonCommonCallAdapter.disposeStreamView-

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

Geerbt vonCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Verbieten Sie Teams-Besprechungsteilnehmern Audioaufnahmen anhand ihrer Benutzer-IDs.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.forbidAudio

forbidOthersAudio()

Audio von Teams-Besprechungen verbieten.

function forbidOthersAudio(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Besprechungen in Teams verbieten.

function forbidOthersVideo(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Verbieten Sie Teams-Besprechungsteilnehmern das Video anhand ihrer Benutzer-IDs.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.forbidVideo

getState()

Abrufen des aktuellen Zustands

function getState(): CallAdapterState

Gibt zurück

CallAdapterState

Geerbt vonCommonCallAdapter.getState

holdCall()

Hält den Anruf.

function holdCall(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.holdCall

leaveCall(boolean)

Verlassen des Anrufs

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 vonCommonCallAdapter.leaveCall

lowerHand()

Untere Hand für den aktuellen Benutzer

function lowerHand(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.lowerHand

mute()

Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons

function mute(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCommonCallAdapter.mute

muteAllRemoteParticipants()

Stummschalten Alle Teilnehmer

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Stummschalten eines Teilnehmers

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

Parameter

userId: string

ID des Teilnehmers, der stummgeschaltet werden soll

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Funktion zum Abbestellen des Ereignisses 'breakoutRoomsUpdated'.

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

Parameter

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

geerbt vonCommonCallAdapter.off

off("callEnded", CallEndedListener)

Abmeldefunktion für das Ereignis "callEnded".

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

Parameter

event: "callEnded"

listener: CallEndedListener

geerbt vonCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Gekündigte Funktion für das Ereignis "callIdChanged".

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

Parameter

event: "callIdChanged"

listener: CallIdChangedListener

geerbt vonCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Abmeldefunktion für das Ereignis 'capabilitiesChanged'.

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

Parameter

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

geerbt vonCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Abmeldefunktion für das Ereignis 'captionsReceived'.

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

Parameter

event: "captionsReceived"

listener: CaptionsReceivedListener

geerbt vonCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Gekündigte Funktion für das Ereignis "diagnosticChanged".

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

Parameter

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

geerbt vonCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Abmeldefunktion für das Ereignis "displayNameChanged".

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

Parameter

event: "displayNameChanged"

listener: DisplayNameChangedListener

geerbt vonCommonCallAdapter.off

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

Gekündigte Funktion für das Ereignis "error".

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

Parameter

event: "error"

listener: (e: AdapterError) => void

geerbt vonCommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Abmeldefunktion für das Ereignis 'isCaptionLanguageChanged'.

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

Parameter

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

geerbt vonCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Abmeldefunktion für das Ereignis 'isCaptionsActiveChanged'.

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

Parameter

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

geerbt vonCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged".

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

Parameter

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

geerbt vonCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Gekündigte Funktion für das Ereignis "isMutedChanged".

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

Parameter

event: "isMutedChanged"

listener: IsMutedChangedListener

geerbt vonCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Abmeldefunktion für das Ereignis "isSpeakingChanged".

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

Parameter

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

geerbt vonCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Funktion zum Abbestellen des Ereignisses 'isSpokenLanguageChanged'.

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

Parameter

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

geerbt vonCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Abmeldefunktion für das Ereignis 'mutedByOthers'.

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

Parameter

event: "mutedByOthers"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Abmeldefunktion für das Ereignis "participantsJoined".

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

Parameter

event: "participantsJoined"

listener: ParticipantsJoinedListener

geerbt vonCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Abmeldefunktion für das Ereignis "participantsLeft".

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

Parameter

event: "participantsLeft"

listener: ParticipantsLeftListener

geerbt vonCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Unsubscribe-Funktion für das Ereignis 'realTimeTextReceived'.

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

Parameter

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

geerbt vonCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Abmeldefunktion für das Ereignis 'roleChanged'.

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

Parameter

event: "roleChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Gekündigte Funktion für das Ereignis "selectedMicrophoneChanged".

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

Parameter

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Abmeldefunktion für das Ereignis "selectedSpeakerChanged".

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

Parameter

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Abmeldefunktion für das Ereignis 'spotlightChanged'.

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

Parameter

event: "spotlightChanged"

listener: SpotlightChangedListener

geerbt vonCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Unsubscribe-Funktion für das Ereignis 'transferRequested'.

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

Parameter

event: "transferAccepted"

listener: TransferAcceptedListener

geerbt vonCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

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

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

Parameter

handler: (state: CallAdapterState) => void

geerbt vonCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Abonnieren Sie die Funktion für das Ereignis 'breakoutRoomsUpdated'.

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

Parameter

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

geerbt vonCommonCallAdapter.on

on("callEnded", CallEndedListener)

Abonnieren Sie die Funktion für das Ereignis "callEnded".

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

Parameter

event: "callEnded"

listener: CallEndedListener

geerbt vonCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Abonnieren Sie die Funktion für das Ereignis 'callIdChanged'.

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

Parameter

event: "callIdChanged"

listener: CallIdChangedListener

Hinweise

Das Ereignis wird ausgelöst, wenn die CallId des aktuellen Benutzers geändert wurde.

geerbt vonCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Subscribe-Funktion für das Ereignis 'capabilitiesChanged'.

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

Parameter

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

geerbt vonCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Abonnieren-Funktion für das Ereignis 'captionsReceived'.

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

Parameter

event: "captionsReceived"

listener: CaptionsReceivedListener

geerbt vonCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Abonnieren Sie die Funktion für das Ereignis "diagnosticChanged".

Dieses Ereignis wird ausgelöst, wenn sich die Diagnose des Benutzers über den laufenden Anruf ändert.

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

Parameter

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

geerbt vonCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Abonnieren Sie die Funktion für das Ereignis "displayNameChanged".

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

Parameter

event: "displayNameChanged"

listener: DisplayNameChangedListener

geerbt vonCommonCallAdapter.on

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

Abonnieren Sie die Funktion für das Ereignis "error".

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

Parameter

event: "error"

listener: (e: AdapterError) => void

geerbt vonCommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Subscribe-Funktion für das Ereignis 'isCaptionLanguageChanged'.

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

Parameter

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

geerbt vonCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Abonnieren Sie die Funktion für das Ereignis 'isCaptionsActiveChanged'.

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

Parameter

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

geerbt vonCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Subscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged".

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

Parameter

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

geerbt vonCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Subscribe-Funktion für das Ereignis "isMutedChanged".

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

Parameter

event: "isMutedChanged"

listener: IsMutedChangedListener

Hinweise

Das Ereignis wird ausgelöst, wenn sich der status des aktuellen Benutzers oder des Remotebenutzers geändert hat.

geerbt vonCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Abonnieren Sie die Funktion für das Ereignis "isSpeakingChanged".

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

Parameter

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

geerbt vonCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Subscribe-Funktion für das Ereignis 'isSpokenLanguageChanged'.

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

Parameter

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

geerbt vonCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Abonnieren Sie die Funktion für das Ereignis 'mutedByOthers'.

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

Parameter

event: "mutedByOthers"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Abonnieren Sie die Funktion für das Ereignis "participantsJoined".

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

Parameter

event: "participantsJoined"

listener: ParticipantsJoinedListener

geerbt vonCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Abonnieren Sie die Funktion für das Ereignis "participantsLeft".

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

Parameter

event: "participantsLeft"

listener: ParticipantsLeftListener

geerbt vonCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Subscribe-Funktion für das Ereignis 'realTimeTextReceived'.

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

Parameter

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

geerbt vonCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das Ereignis 'roleChanged'.

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

Parameter

event: "roleChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Abonnieren Sie die Funktion für das Ereignis "selectedMicrophoneChanged".

Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Mikrofongerät auswählt.

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

Parameter

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Abonnieren Sie die Funktion für das Ereignis "selectedSpeakerChanged".

Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Lautsprechergerät auswählt.

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

Parameter

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

geerbt vonCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Abonnieren Sie die Funktion für das Ereignis 'spotlightChanged'.

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

Parameter

event: "spotlightChanged"

listener: SpotlightChangedListener

geerbt vonCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Subscribe-Funktion für das Ereignis 'transferRequested'.

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

Parameter

event: "transferAccepted"

listener: TransferAcceptedListener

geerbt vonCommonCallAdapter.on

onReactionClick(Reaction)

Reaktions-Emoji senden

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

Parameter

reaction: Reaction

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Abonniert den Handler für stateChanged-Ereignisse.

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

Parameter

handler: (state: CallAdapterState) => void

geerbt vonCommonCallAdapter.onStateChange

permitAudio(string[])

Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.permitAudio

permitOthersAudio()

Audio für Teams-Besprechungen zulassen.

function permitOthersAudio(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Erlauben Sie Teams-Besprechungsvideo.

function permitOthersVideo(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.permitVideo

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 vonCommonCallAdapter.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.

vonCommonCallAdapter.queryMicrophones

querySpeakers()

Abfrage nach verfügbaren Lautsprechergerä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.

vonCommonCallAdapter.querySpeakers geerbt

raiseHand()

Hand heben für aktuellen Benutzer

function raiseHand(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.removeParticipant

removeParticipant(string)

Entfernen Sie einen Teilnehmer aus dem Anruf.

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

Parameter

userId: string

ID des zu entfernenden Teilnehmers

Gibt zurück

Promise<void>

geerbt vonCommonCallAdapter.removeParticipant

resumeCall()

Setzt den Anruf aus einem LocalHold Status fort.

function resumeCall(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

Senden des DTMF-Tons an einen anderen Teilnehmer in einem 1:1-PSTN-Anruf

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

Parameter

dtmfTone: DtmfTone

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.sendDtmfTone

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 vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Starten Sie die Kamera Diese Methode startet das 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 vonCommonCallAdapter.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 vonCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function startNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

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

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.startScreenShare-

startSpotlight(string[])

Starten Sie das Spotlight für lokale und Remote-Teilnehmer anhand ihrer Benutzer-IDs. Wenn kein Array von Benutzer-IDs übergeben wird, wird die Aktion für den lokalen Teilnehmer ausgeführt.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.startSpotlight

startTogetherMode()

Modus "Gemeinsam starten".

function startTogetherMode(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Starten Sie den Video-Hintergrundeffekt.

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

Parameter

videoBackgroundEffect: VideoBackgroundEffect

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Stoppen Sie alle Scheinwerfer

function stopAllSpotlight(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.stopAllSpotlight

stopCamera()

Beenden der 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 vonCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funktion zum Stoppen von Untertiteln

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

Parameter

options: StopCaptionsAdapterOptions

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Stoppen Sie den Rauschunterdrückungseffekt.

function stopNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Beenden der Freigabe des Bildschirms

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.stopScreenShare-

stopSpotlight(string[])

Stoppen Sie das Spotlight für lokale und Remote-Teilnehmer anhand ihrer Benutzer-IDs. Wenn kein Array von Benutzer-IDs übergeben wird, wird die Aktion für den lokalen Teilnehmer ausgeführt.

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

Parameter

userIds: string[]

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Stoppen Sie den Videohintergrundeffekt.

function stopVideoBackgroundEffects(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.submitSurvey

unmute()

Aufheben der Stummschaltung des aktuellen Benutzers während des Anrufs oder lokales Aktivieren des Mikrofons

function unmute(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages: VideoBackgroundImage[]

Array von benutzerdefinierten Hintergrundbildern.

Geerbt vonCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualisieren Sie den ausgewählten Videohintergrundeffekt.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground: VideoBackgroundEffect

Geerbt vonCommonCallAdapter.updateSelectedVideoBackgroundEffect

Freigeben über

CallAdapter interface

Geerbte Eigenschaften

Methoden

Geerbte Methoden

Geerbte Eigenschaftsdetails

sendRealTimeText

Eigenschaftswert

Details zur Methode

joinCall(boolean)

Parameter

Gibt zurück

joinCall(JoinCallOptions)

Parameter

Gibt zurück

startCall(CommunicationIdentifier[], StartCallOptions)

Parameter

Gibt zurück

startCall(string[], StartCallOptions)

Parameter

Gibt zurück

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

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

forbidAudio(string[])

Parameter

Gibt zurück

forbidOthersAudio()

Gibt zurück

forbidOthersVideo()

Gibt zurück

forbidVideo(string[])

Parameter

Gibt zurück

getState()

Gibt zurück

holdCall()

Gibt zurück

leaveCall(boolean)

Parameter

Gibt zurück

lowerHand()

Gibt zurück

mute()

Gibt zurück

muteAllRemoteParticipants()

Gibt zurück