CallAdapterCallManagement interface

Paket:

@azure/communication-react

Warnung

Diese API ist nun veraltet.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funktionen zum Verwalten des aktuellen Anrufs oder zum Starten eines neuen Anrufs

Extends

CallAdapterCallOperations

Methoden

joinCall(boolean)	Nehmen Sie an dem Anruf teil, wobei das Mikrofon anfänglich aktiviert/deaktiviert ist.
startCall(string[], StartCallOptions)	Starten Sie den Anruf.

Geerbte Methoden

createStreamView(string, VideoStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Stream.
disposeStreamView(string, VideoStreamOptions)	Entsorgen Sie die HTML-Ansicht für einen Stream.
leaveCall(boolean)	Lassen Sie den Anruf
mute()	Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons
removeParticipant(string)	Entfernen Sie einen Teilnehmer aus dem Anruf.
startCamera(VideoStreamOptions)	Starten der Kamera Diese Methode beginnt mit dem Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
startScreenShare()	Beginnen Sie mit der Freigabe des Bildschirms während eines Anrufs.
stopCamera()	Beenden der Kamera Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
stopScreenShare()	Beenden der Freigabe des Bildschirms
unmute()	Aufheben der Stummschaltung des aktuellen Benutzers während des Anrufs oder lokales Aktivieren des Mikrofons

Details zur Methode

joinCall(boolean)

Nehmen Sie an dem Anruf teil, wobei das Mikrofon anfänglich aktiviert/deaktiviert ist.

function joinCall(microphoneOn?: boolean): undefined | Call

Parameter

microphoneOn

boolean

Gibt an, ob das Mikrofon anfänglich aktiviert ist.

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 für die Teilnahme

options

StartCallOptions

Gibt zurück

undefined | Call

Details zur geerbten Methode

createStreamView(string, VideoStreamOptions)

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

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parameter

remoteUserId

string

ID des zu rendernden Teilnehmers, undefiniert lassen, um die lokale Kameraansicht zu erstellen

options

VideoStreamOptions

Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Gibt zurück

Promise<void | CreateVideoStreamViewResult>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

Geerbt vonCallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

Entsorgen Sie die HTML-Ansicht für einen Stream.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parameter

remoteUserId

string

ID des zu rendernden Teilnehmers, undefiniert lassen, um die lokale Kameraansicht zu entsorgen

options

VideoStreamOptions

Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Gibt zurück

Promise<void>

Hinweise

Diese Methode wird für zusammengesetzte Komponenten implementiert.

Geerbt vonCallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Lassen Sie den Anruf

function leaveCall(forEveryone?: boolean): Promise<void>

Parameter

forEveryone

boolean

Ob alle Teilnehmer beim Verlassen entfernt werden sollen

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.mute

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 vonCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Starten der Kamera Diese Methode beginnt mit dem Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.

function startCamera(options?: VideoStreamOptions): Promise<void>

Parameter

options

VideoStreamOptions

Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.startCamera

startScreenShare()

Beginnen Sie mit der Freigabe des Bildschirms während eines Anrufs.

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.startScreenShare

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

stopScreenShare()

Beenden der Freigabe des Bildschirms

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.stopScreenShare

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