CommonCallAdapter interface
CallComposite Adapterschnittstelle.
- Extends
Geerbte Eigenschaften
| send |
Senden Sie Text in Echtzeit |
Methoden
| join |
Treten Sie dem Anruf zunächst mit mikrofon ein/aus. |
| join |
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 |
| start |
Starten Sie den Anruf. |
| start |
Starten Sie den Anruf. |
Geerbte Methoden
| add |
|
| add |
Fügen Sie dem Anruf einen Teilnehmer hinzu. |
| ask |
Fragen Sie nach Berechtigungen von Geräten. |
| create |
Erstellen Sie die HTML-Ansicht für einen Datenstrom. |
| create |
Erstellen Sie die HTML-Ansicht für einen Datenstrom. |
| dispose() | Löschen des Zusammengesetzten |
| dispose |
Verwerfen der HTML-Ansicht für einen lokalen Videostream |
| dispose |
Verwerfen der HTML-Ansicht für einen Remote-Videostream |
| dispose |
Verwerfen der HTML-Ansicht für einen Bildschirmfreigabestream |
| dispose |
Verwerfen Sie die HTML-Ansicht für einen Datenstrom. |
| dispose |
Verwerfen Sie die HTML-Ansicht für einen Datenstrom. |
| forbid |
Verbieten Sie Teams-Besprechungsteilnehmern Audioaufnahmen anhand ihrer Benutzer-IDs. |
| forbid |
Audio von Teams-Besprechungen verbieten. |
| forbid |
Besprechungen in Teams verbieten. |
| forbid |
Verbieten Sie Teams-Besprechungsteilnehmern das Video anhand ihrer Benutzer-IDs. |
| get |
Abrufen des aktuellen Zustands |
| hold |
Hält den Anruf. |
| leave |
Verlassen des Anrufs |
| lower |
Untere Hand für den aktuellen Benutzer |
| mute() | Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons |
| mute |
Stummschalten Alle Teilnehmer |
| mute |
Stummschalten eines Teilnehmers |
| off("breakout |
Funktion zum Abbestellen des Ereignisses 'breakoutRoomsUpdated'. |
| off("call |
Abmeldefunktion für das Ereignis "callEnded". |
| off("call |
Gekündigte Funktion für das Ereignis "callIdChanged". |
| off("capabilities |
Abmeldefunktion für das Ereignis 'capabilitiesChanged'. |
| off("captions |
Abmeldefunktion für das Ereignis 'captionsReceived'. |
| off("diagnostic |
Gekündigte Funktion für das Ereignis "diagnosticChanged". |
| off("display |
Abmeldefunktion für das Ereignis "displayNameChanged". |
| off("error", (e: Adapter |
Gekündigte Funktion für das Ereignis "error". |
| off("is |
Abmeldefunktion für das Ereignis 'isCaptionLanguageChanged'. |
| off("is |
Abmeldefunktion für das Ereignis 'isCaptionsActiveChanged'. |
| off("is |
Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged". |
| off("is |
Gekündigte Funktion für das Ereignis "isMutedChanged". |
| off("is |
Abmeldefunktion für das Ereignis "isSpeakingChanged". |
| off("is |
Funktion zum Abbestellen des Ereignisses 'isSpokenLanguageChanged'. |
| off("muted |
Abmeldefunktion für das Ereignis 'mutedByOthers'. |
| off("participants |
Abmeldefunktion für das Ereignis "participantsJoined". |
| off("participants |
Abmeldefunktion für das Ereignis "participantsLeft". |
| off("real |
Unsubscribe-Funktion für das Ereignis 'realTimeTextReceived'. |
| off("role |
Abmeldefunktion für das Ereignis 'roleChanged'. |
| off("selected |
Gekündigte Funktion für das Ereignis "selectedMicrophoneChanged". |
| off("selected |
Abmeldefunktion für das Ereignis "selectedSpeakerChanged". |
| off("spotlight |
Abmeldefunktion für das Ereignis 'spotlightChanged'. |
| off("transfer |
Unsubscribe-Funktion für das Ereignis 'transferRequested'. |
| off |
Gekündigt den Handler für stateChanged-Ereignisse. |
| on("breakout |
Abonnieren Sie die Funktion für das Ereignis 'breakoutRoomsUpdated'. |
| on("call |
Abonnieren Sie die Funktion für das Ereignis "callEnded". |
| on("call |
Abonnieren Sie die Funktion für das Ereignis 'callIdChanged'. |
| on("capabilities |
Subscribe-Funktion für das Ereignis 'capabilitiesChanged'. |
| on("captions |
Abonnieren-Funktion für das Ereignis 'captionsReceived'. |
| on("diagnostic |
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("display |
Abonnieren Sie die Funktion für das Ereignis "displayNameChanged". |
| on("error", (e: Adapter |
Abonnieren Sie die Funktion für das Ereignis "error". |
| on("is |
Subscribe-Funktion für das Ereignis 'isCaptionLanguageChanged'. |
| on("is |
Abonnieren Sie die Funktion für das Ereignis 'isCaptionsActiveChanged'. |
| on("is |
Subscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged". |
| on("is |
Subscribe-Funktion für das Ereignis "isMutedChanged". |
| on("is |
Abonnieren Sie die Funktion für das Ereignis "isSpeakingChanged". |
| on("is |
Subscribe-Funktion für das Ereignis 'isSpokenLanguageChanged'. |
| on("muted |
Abonnieren Sie die Funktion für das Ereignis 'mutedByOthers'. |
| on("participants |
Abonnieren Sie die Funktion für das Ereignis "participantsJoined". |
| on("participants |
Abonnieren Sie die Funktion für das Ereignis "participantsLeft". |
| on("real |
Subscribe-Funktion für das Ereignis 'realTimeTextReceived'. |
| on("role |
Subscribe-Funktion für das Ereignis 'roleChanged'. |
| on("selected |
Abonnieren Sie die Funktion für das Ereignis "selectedMicrophoneChanged". Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Mikrofongerät auswählt. |
| on("selected |
Abonnieren Sie die Funktion für das Ereignis "selectedSpeakerChanged". Dieses Ereignis wird ausgelöst, wenn der Benutzer ein neues Lautsprechergerät auswählt. |
| on("spotlight |
Abonnieren Sie die Funktion für das Ereignis 'spotlightChanged'. |
| on("transfer |
Subscribe-Funktion für das Ereignis 'transferRequested'. |
| on |
Reaktions-Emoji senden |
| on |
Abonniert den Handler für stateChanged-Ereignisse. |
| permit |
Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs. |
| permit |
Audio für Teams-Besprechungen zulassen. |
| permit |
Erlauben Sie Teams-Besprechungsvideo. |
| permit |
Erlauben Sie Teams-Besprechungsteilnehmern Audio anhand ihrer Benutzer-IDs. |
| query |
Fragen Sie nach verfügbaren Kamerageräten ab. |
| query |
Abfrage nach verfügbaren Mikrofongeräten. |
| query |
Abfrage nach verfügbaren Lautsprechergeräten. |
| raise |
Hand heben für aktuellen Benutzer |
| remove |
Entfernen Sie einen Teilnehmer aus dem Anruf. |
| remove |
Entfernen Sie einen Teilnehmer aus dem Anruf. |
| resume |
Setzt den Anruf aus einem |
| return |
Zurück zum ursprünglichen Aufruf des Breakout-Raums |
| send |
Senden des DTMF-Tons an einen anderen Teilnehmer in einem 1:1-PSTN-Anruf |
| set |
Legen Sie die Kamera fest, die im Anruf verwendet werden soll. |
| set |
Funktion zum Festlegen der Untertitelsprache |
| set |
Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll. |
| set |
Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll. |
| set |
Funktion zum Einstellen der gesprochenen Sprache |
| set |
Berechnen Sie die Sitzpositionen für den Together-Modus neu. |
| start |
Starten Sie die Kamera Diese Methode startet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist. |
| start |
Funktion zum Starten von Untertiteln |
| start |
Starten Sie den Rauschunterdrückungseffekt. |
| start |
Starten Sie die Freigabe des Bildschirms während eines Anrufs. |
| start |
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. |
| start |
Modus "Gemeinsam starten". |
| start |
Starten Sie den Video-Hintergrundeffekt. |
| stop |
Stoppen Sie alle Scheinwerfer |
| stop |
Beenden der Kamera Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist. |
| stop |
Funktion zum Stoppen von Untertiteln |
| stop |
Stoppen Sie den Rauschunterdrückungseffekt. |
| stop |
Beenden der Freigabe des Bildschirms |
| stop |
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. |
| stop |
Stoppen Sie den Videohintergrundeffekt. |
| submit |
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 |
| update |
Überschreiben Sie die Hintergrundauswahlbilder, um den Hintergrundersetzungseffekt zu erzielen. |
| update |
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>
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)
Parameter
- microphoneOn
-
boolean
Gibt an, ob das Mikrofon anfänglich aktiviert ist.
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)
Parameter
- options
- JoinCallOptions
-Parameter, um das Mikrofon/die Kamera anfänglich ein/auszuschalten/den Precall-Status zu verwenden.
startCall(CommunicationIdentifier[], StartCallOptions)
Starten Sie den Anruf.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)
Parameter
- participants
Ein Array von <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> aufzurufendes Array
- options
- StartCallOptions
startCall(string[], StartCallOptions)
Starten Sie den Anruf.
function startCall(participants: string[], options?: StartCallOptions)
Parameter
- participants
-
string[]
Ein Array von Teilnehmer-IDs zur Teilnahme
- options
- StartCallOptions
Details zur geerbten Methode
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parameter
- participant
- CommunicationUserIdentifier
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.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.
createStreamView(string, VideoStreamOptions)
Erstellen Sie die HTML-Ansicht für einen Datenstrom.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>
Parameter
- remoteUserId
-
string
Id des zu rendernden Teilnehmers, lassen Sie ihn nicht definiert, um die lokale Kameraansicht zu erstellen.
- options
- VideoStreamOptions
Optionen zum Steuern, wie Videodatenströme <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions> gerendert werden
Gibt zurück
Promise<void | CreateVideoStreamViewResult>
Hinweise
Diese Methode wird für zusammengesetzte Komponenten implementiert.
createTogetherModeStreamView(TogetherModeStreamOptions)
Erstellen Sie die HTML-Ansicht für einen 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 vonCallAdapterCallOperations.createTogetherModeStreamView
dispose()
disposeLocalVideoStreamView()
Verwerfen der HTML-Ansicht für einen lokalen Videostream
function disposeLocalVideoStreamView(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.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.
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 vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.forbidAudio
forbidOthersAudio()
Audio von Teams-Besprechungen verbieten.
function forbidOthersAudio(): Promise<void>
Gibt zurück
Promise<void>
forbidOthersVideo()
Besprechungen in Teams verbieten.
function forbidOthersVideo(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.forbidVideo
getState()
Abrufen des aktuellen Zustands
function getState(): CallAdapterState
Gibt zurück
holdCall()
Hält den Anruf.
function holdCall(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.leaveCall
lowerHand()
Untere Hand für den aktuellen Benutzer
function lowerHand(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.lowerHand
mute()
Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons
function mute(): Promise<void>
Gibt zurück
Promise<void>
muteAllRemoteParticipants()
Stummschalten Alle Teilnehmer
function muteAllRemoteParticipants(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Funktion zum Abbestellen des Ereignisses 'breakoutRoomsUpdated'.
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parameter
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
Abmeldefunktion für das Ereignis "callEnded".
function off(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
off("callIdChanged", CallIdChangedListener)
Gekündigte Funktion für das Ereignis "callIdChanged".
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("capabilitiesChanged", CapabilitiesChangedListener)
Abmeldefunktion für das Ereignis 'capabilitiesChanged'.
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parameter
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
Abmeldefunktion für das Ereignis 'captionsReceived'.
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parameter
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("diagnosticChanged", DiagnosticChangedEventListner)
Gekündigte Funktion für das Ereignis "diagnosticChanged".
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)
Parameter
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
off("displayNameChanged", DisplayNameChangedListener)
Abmeldefunktion für das Ereignis "displayNameChanged".
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
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
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Abmeldefunktion für das Ereignis 'isCaptionLanguageChanged'.
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parameter
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Abmeldefunktion für das Ereignis 'isCaptionsActiveChanged'.
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parameter
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged".
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
Gekündigte Funktion für das Ereignis "isMutedChanged".
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
Abmeldefunktion für das Ereignis "isSpeakingChanged".
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Funktion zum Abbestellen des Ereignisses 'isSpokenLanguageChanged'.
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parameter
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("mutedByOthers", PropertyChangedEvent)
Abmeldefunktion für das Ereignis 'mutedByOthers'.
function off(event: "mutedByOthers", listener: PropertyChangedEvent)
Parameter
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
off("participantsJoined", ParticipantsJoinedListener)
Abmeldefunktion für das Ereignis "participantsJoined".
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
off("participantsLeft", ParticipantsLeftListener)
Abmeldefunktion für das Ereignis "participantsLeft".
function off(event: "participantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
Unsubscribe-Funktion für das Ereignis 'realTimeTextReceived'.
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parameter
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("roleChanged", PropertyChangedEvent)
Abmeldefunktion für das Ereignis 'roleChanged'.
function off(event: "roleChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
off("selectedMicrophoneChanged", PropertyChangedEvent)
Gekündigte Funktion für das Ereignis "selectedMicrophoneChanged".
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
Abmeldefunktion für das Ereignis "selectedSpeakerChanged".
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
Abmeldefunktion für das Ereignis 'spotlightChanged'.
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parameter
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
off("transferAccepted", TransferAcceptedListener)
Unsubscribe-Funktion für das Ereignis 'transferRequested'.
function off(event: "transferAccepted", listener: TransferAcceptedListener)
Parameter
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
offStateChange((state: CallAdapterState) => void)
Gekündigt den Handler für stateChanged-Ereignisse.
function offStateChange(handler: (state: CallAdapterState) => void)
Parameter
- handler
-
(state: CallAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Abonnieren Sie die Funktion für das Ereignis 'breakoutRoomsUpdated'.
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parameter
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
vonCallAdapterSubscribers.on geerbt
on("callEnded", CallEndedListener)
Abonnieren Sie die Funktion für das Ereignis "callEnded".
function on(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
vonCallAdapterSubscribers.on geerbt
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.
vonCallAdapterSubscribers.on geerbt
on("capabilitiesChanged", CapabilitiesChangedListener)
Subscribe-Funktion für das Ereignis 'capabilitiesChanged'.
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parameter
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
vonCallAdapterSubscribers.on geerbt
on("captionsReceived", CaptionsReceivedListener)
Abonnieren-Funktion für das Ereignis 'captionsReceived'.
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parameter
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
vonCallAdapterSubscribers.on geerbt
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
vonCallAdapterSubscribers.on geerbt
on("displayNameChanged", DisplayNameChangedListener)
Abonnieren Sie die Funktion für das Ereignis "displayNameChanged".
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
vonCallAdapterSubscribers.on geerbt
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
vonCallAdapterSubscribers.on geerbt
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Subscribe-Funktion für das Ereignis 'isCaptionLanguageChanged'.
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parameter
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
vonCallAdapterSubscribers.on geerbt
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Abonnieren Sie die Funktion für das Ereignis 'isCaptionsActiveChanged'.
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parameter
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
vonCallAdapterSubscribers.on geerbt
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Subscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged".
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
vonCallAdapterSubscribers.on geerbt
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.
vonCallAdapterSubscribers.on geerbt
on("isSpeakingChanged", IsSpeakingChangedListener)
Abonnieren Sie die Funktion für das Ereignis "isSpeakingChanged".
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
vonCallAdapterSubscribers.on geerbt
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Subscribe-Funktion für das Ereignis 'isSpokenLanguageChanged'.
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parameter
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
vonCallAdapterSubscribers.on geerbt
on("mutedByOthers", PropertyChangedEvent)
Abonnieren Sie die Funktion für das Ereignis 'mutedByOthers'.
function on(event: "mutedByOthers", listener: PropertyChangedEvent)
Parameter
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
vonCallAdapterSubscribers.on geerbt
on("participantsJoined", ParticipantsJoinedListener)
Abonnieren Sie die Funktion für das Ereignis "participantsJoined".
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
vonCallAdapterSubscribers.on geerbt
on("participantsLeft", ParticipantsLeftListener)
Abonnieren Sie die Funktion für das Ereignis "participantsLeft".
function on(event: "participantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
vonCallAdapterSubscribers.on geerbt
on("realTimeTextReceived", RealTimeTextReceivedListener)
Subscribe-Funktion für das Ereignis 'realTimeTextReceived'.
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parameter
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
vonCallAdapterSubscribers.on geerbt
on("roleChanged", PropertyChangedEvent)
Subscribe-Funktion für das Ereignis 'roleChanged'.
function on(event: "roleChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
vonCallAdapterSubscribers.on geerbt
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
vonCallAdapterSubscribers.on geerbt
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
vonCallAdapterSubscribers.on geerbt
on("spotlightChanged", SpotlightChangedListener)
Abonnieren Sie die Funktion für das Ereignis 'spotlightChanged'.
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parameter
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
vonCallAdapterSubscribers.on geerbt
on("transferAccepted", TransferAcceptedListener)
Subscribe-Funktion für das Ereignis 'transferRequested'.
function on(event: "transferAccepted", listener: TransferAcceptedListener)
Parameter
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
vonCallAdapterSubscribers.on geerbt
onReactionClick(Reaction)
Reaktions-Emoji senden
function onReactionClick(reaction: Reaction): Promise<void>
Parameter
- reaction
- Reaction
Gibt zurück
Promise<void>
onStateChange((state: CallAdapterState) => void)
Abonniert den Handler für stateChanged-Ereignisse.
function onStateChange(handler: (state: CallAdapterState) => void)
Parameter
- handler
-
(state: CallAdapterState) => void
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 vonCallAdapterCallOperations.permitAudio
permitOthersAudio()
Audio für Teams-Besprechungen zulassen.
function permitOthersAudio(): Promise<void>
Gibt zurück
Promise<void>
permitOthersVideo()
Erlauben Sie Teams-Besprechungsvideo.
function permitOthersVideo(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.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 vonCallAdapterDeviceManagement.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.
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.
raiseHand()
Hand heben für aktuellen Benutzer
function raiseHand(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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>
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>
resumeCall()
Setzt den Anruf aus einem LocalHold Status fort.
function resumeCall(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.resumeCall
returnFromBreakoutRoom()
Zurück zum ursprünglichen Aufruf des Breakout-Raums
function returnFromBreakoutRoom(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.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 vonCallAdapterDeviceManagement.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>
setMicrophone(AudioDeviceInfo)
Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parameter
- sourceInfo
- AudioDeviceInfo
Wählen Sie ein Mikrofongerät aus, das von queryMicrophones
Gibt zurück
Promise<void>
setSpeaker(AudioDeviceInfo)
Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parameter
- sourceInfo
- AudioDeviceInfo
Zu wählende Lautsprechergerät wählen Sie eine von querySpeakers
Gibt zurück
Promise<void>
Geerbt vonCallAdapterDeviceManagement.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>
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 vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.startCaptions
startNoiseSuppressionEffect()
Starten Sie den Rauschunterdrückungseffekt.
function startNoiseSuppressionEffect(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.startNoiseSuppressionEffect
startScreenShare()
Starten Sie die Freigabe des Bildschirms während eines Anrufs.
function startScreenShare(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.startSpotlight
startTogetherMode()
Modus "Gemeinsam starten".
function startTogetherMode(): Promise<void>
Gibt zurück
Promise<void>
startVideoBackgroundEffect(VideoBackgroundEffect)
Starten Sie den Video-Hintergrundeffekt.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parameter
- videoBackgroundEffect
- VideoBackgroundEffect
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.startVideoBackgroundEffect
stopAllSpotlight()
Stoppen Sie alle Scheinwerfer
function stopAllSpotlight(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Funktion zum Stoppen von Untertiteln
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parameter
- options
- StopCaptionsAdapterOptions
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.stopCaptions
stopNoiseSuppressionEffect()
Stoppen Sie den Rauschunterdrückungseffekt.
function stopNoiseSuppressionEffect(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.stopNoiseSuppressionEffect
stopScreenShare()
Beenden der Freigabe des Bildschirms
function stopScreenShare(): Promise<void>
Gibt zurück
Promise<void>
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 vonCallAdapterCallOperations.stopSpotlight
stopVideoBackgroundEffects()
Stoppen Sie den Videohintergrundeffekt.
function stopVideoBackgroundEffects(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.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 vonCallAdapterCallOperations.unmute
updateBackgroundPickerImages(VideoBackgroundImage[])
Überschreiben Sie die Hintergrundauswahlbilder, um den Hintergrundersetzungseffekt zu erzielen.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
Parameter
- backgroundImages
Array von benutzerdefinierten Hintergrundbildern.
Geerbt vonCallAdapterCallOperations.updateBackgroundPickerImages
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Aktualisieren Sie den ausgewählten Videohintergrundeffekt.
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parameter
- selectedVideoBackground
- VideoBackgroundEffect
Geerbt vonCallAdapterCallOperations.updateSelectedVideoBackgroundEffect