CallAdapterCallOperations interface

Paket:

@azure/communication-react

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

Eigenschaften

sendRealTimeText

Senden Sie Text in Echtzeit

Methoden

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Fügen Sie dem Anruf einen Teilnehmer hinzu.
createStreamView(string, VideoStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Datenstrom.
createTogetherModeStreamView(TogetherModeStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Datenstrom.
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.
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
onReactionClick(Reaction)	Reaktions-Emoji senden
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.
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
setCaptionLanguage(string)	Funktion zum Festlegen der Untertitelsprache
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.

Details zur Eigenschaft

sendRealTimeText

Senden Sie Text in Echtzeit

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

Eigenschaftswert

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

Details zur Methode

addParticipant(CommunicationUserIdentifier)

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

Parameter

participant

CommunicationUserIdentifier

Gibt zurück

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Fü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>

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.

disposeLocalVideoStreamView()

Verwerfen der HTML-Ansicht für einen lokalen Videostream

function disposeLocalVideoStreamView(): Promise<void>

Gibt zurück

Promise<void>

disposeRemoteVideoStreamView(string)

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

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

Parameter

remoteUserId

string

Id des Teilnehmers, der entsorgt werden soll

Gibt zurück

Promise<void>

disposeScreenShareStreamView(string)

Verwerfen der HTML-Ansicht für einen Bildschirmfreigabestream

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

Parameter

remoteUserId

string

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

Gibt zurück

Promise<void>

Hinweise

Diese Methode ist für Composites implementiert

disposeStreamView(string, VideoStreamOptions)

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.

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>

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>

holdCall()

Hält den Anruf.

function holdCall(): Promise<void>

Gibt zurück

Promise<void>

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>

lowerHand()

Untere Hand für den aktuellen Benutzer

function lowerHand(): Promise<void>

Gibt zurück

Promise<void>

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>

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>

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>

raiseHand()

Hand heben für aktuellen Benutzer

function raiseHand(): Promise<void>

Gibt zurück

Promise<void>

removeParticipant(CommunicationIdentifier)

Entfernen Sie einen Teilnehmer aus dem Anruf.

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

Parameter

participant

CommunicationIdentifier

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

Gibt zurück

Promise<void>

removeParticipant(string)

Entfernen 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>

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>

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.

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>

startCaptions(StartCaptionsAdapterOptions)

Funktion zum Starten von Untertiteln

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

Parameter

options

StartCaptionsAdapterOptions

Optionen für Startuntertitel

Gibt zurück

Promise<void>

startNoiseSuppressionEffect()

Starten Sie den Rauschunterdrückungseffekt.

function startNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

startScreenShare()

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

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

startSpotlight(string[])

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>

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>

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>

stopCaptions(StopCaptionsAdapterOptions)

Funktion zum Stoppen von Untertiteln

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

Parameter

options

StopCaptionsAdapterOptions

Gibt zurück

Promise<void>

stopNoiseSuppressionEffect()

Stoppen Sie den Rauschunterdrückungseffekt.

function stopNoiseSuppressionEffect(): Promise<void>

Gibt zurück

Promise<void>

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>

stopVideoBackgroundEffects()

Stoppen Sie den Videohintergrundeffekt.

function stopVideoBackgroundEffects(): Promise<void>

Gibt zurück

Promise<void>

submitSurvey(CallSurvey)

Senden Sie das Ergebnis der Umfrage am Ende des Anrufs

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

Parameter

survey

CallSurvey

Gibt zurück

Promise<undefined | CallSurveyResponse>

unmute()

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

function unmute(): Promise<void>

Gibt zurück

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages

VideoBackgroundImage[]

Array von benutzerdefinierten Hintergrundbildern.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualisieren Sie den ausgewählten Videohintergrundeffekt.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground

VideoBackgroundEffect