CallAdapterCallManagement interface
Warnung
Diese API ist nun veraltet.
CallAdapter interface will be flatten, consider using CallAdapter directly
Funktionalität für die Verwaltung des aktuellen Anrufs oder Starten eines neuen Anrufs
- 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. |
| create |
Erstellen Sie die HTML-Ansicht für einen Datenstrom. |
| create |
Erstellen Sie die HTML-Ansicht für einen Datenstrom. |
| 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. |
| 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 |
| on |
Reaktions-Emoji senden |
| 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. |
| 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 |
Funktion zum Festlegen der Untertitelsprache |
| 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): 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
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 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
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
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
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>
onReactionClick(Reaction)
Reaktions-Emoji senden
function onReactionClick(reaction: Reaction): Promise<void>
Parameter
- reaction
- Reaction
Gibt zurück
Promise<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
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
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>
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