CommonCallAdapter interface

Paket:

@azure/communication-react

CallComposite Adapterschnittstelle.

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Methoden

joinCall(boolean)	Schließen Sie sich dem Anruf an, wobei das Mikrofon zunächst ein-/ausschaltet.
startCall(string[], StartCallOptions)	Starten Sie den Anruf.

Geerbte Methoden

askDevicePermission(PermissionConstraints)	Fragen Sie nach Berechtigungen für Geräte.
createStreamView(string, VideoStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Stream.
dispose()	Verwerfen des Zusammengesetzten
disposeStreamView(string, VideoStreamOptions)	Entsorgen Sie die HTML-Ansicht für einen Stream.
getState()	Abrufen des aktuellen Zustands
leaveCall(boolean)	Lassen Sie den Anruf
mute()	Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons
off("callEnded", CallEndedListener)	Unsubscribe-Funktion für das Ereignis "callEnded".
off("callIdChanged", CallIdChangedListener)	Unsubscribe-Funktion für das Ereignis "callIdChanged".
off("diagnosticChanged", DiagnosticChangedEventListner)	Unsubscribe-Funktion für das Ereignis "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Unsubscribe-Funktion für das Ereignis "displayNameChanged".
off("error", (e: AdapterError) => void)	Abmeldefunktion für das Ereignis "error".
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Unsubscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Abmeldefunktion für das Ereignis "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Abmeldefunktion für das Ereignis "isSpeakingChanged".
off("participantsJoined", ParticipantsJoinedListener)	Abmeldefunktion für das Ereignis "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Unsubscribe-Funktion für das Ereignis "participantsLeft".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Abmeldefunktion für das Ereignis "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Unsubscribe-Funktion für das Ereignis "selectedSpeakerChanged".
offStateChange((state: CallAdapterState) => void)	Beendet den Handler für stateChanged-Ereignisse.
on("callEnded", CallEndedListener)	Subscribe-Funktion für das "callEnded"-Ereignis.
on("callIdChanged", CallIdChangedListener)	Subscribe-Funktion für das Ereignis "callIdChanged".
on("diagnosticChanged", DiagnosticChangedEventListner)	Subscribe-Funktion für das Ereignis "diagnosticChanged". Dieses Ereignis wird immer dann ausgelöst, wenn eine Änderung in der benutzerseitigen Diagnose des laufenden Anrufs vorliegt.
on("displayNameChanged", DisplayNameChangedListener)	Subscribe-Funktion für das Ereignis "displayNameChanged".
on("error", (e: AdapterError) => void)	Subscribe-Funktion für das Fehlerereignis.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Subscribe-Funktion für das Ereignis "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Subscribe-Funktion für das Ereignis "isMutedChanged".
on("isSpeakingChanged", IsSpeakingChangedListener)	Subscribe-Funktion für das Ereignis "isSpeakingChanged".
on("participantsJoined", ParticipantsJoinedListener)	Subscribe-Funktion für das Ereignis "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Subscribe-Funktion für das Ereignis "participantsLeft".
on("selectedMicrophoneChanged", PropertyChangedEvent)	Subscribe-Funktion für das Ereignis "selectedMicrophoneChanged". Dieses Ereignis wird immer dann ausgelöst, wenn der Benutzer ein neues Mikrofongerät auswählt.
on("selectedSpeakerChanged", PropertyChangedEvent)	Subscribe-Funktion für das Ereignis "selectedSpeakerChanged". Dieses Ereignis wird immer dann ausgelöst, wenn der Benutzer ein neues Lautsprechergerät auswählt.
onStateChange((state: CallAdapterState) => void)	Abonniert den Handler für stateChanged-Ereignisse.
queryCameras()	Abfrage nach verfügbaren Kamerageräten.
queryMicrophones()	Abfrage nach verfügbaren Mikrofongeräten.
querySpeakers()	Abfrage nach verfügbaren Mikrofongeräten.
removeParticipant(string)	Entfernen Sie einen Teilnehmer aus dem Anruf.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Legen Sie die Kamera fest, die im Anruf verwendet werden soll.
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.
startCamera(VideoStreamOptions)	Kamera starten 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()	Kamera beenden Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist
stopScreenShare()	Beenden der Freigabe des Bildschirms
unmute()	Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal

Details zur Methode

joinCall(boolean)

Schließen Sie sich dem Anruf an, wobei das Mikrofon zunächst ein-/ausschaltet.

function joinCall(microphoneOn?: boolean)

Parameter

microphoneOn

boolean

Gibt an, ob das Mikrofon anfänglich aktiviert ist

startCall(string[], StartCallOptions)

Starten Sie den Anruf.

function startCall(participants: string[], options?: StartCallOptions)

Parameter

participants

string[]

Ein Array von Teilnehmer-IDs, an die teilnehmen soll

options

StartCallOptions

Details zur geerbten Methode

askDevicePermission(PermissionConstraints)

Fragen Sie nach Berechtigungen für Geräte.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parameter

constrain

PermissionConstraints

Definieren von Einschränkungen für den Zugriff auf lokale Geräte <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Gibt zurück

Promise<void>

Hinweise

Browserberechtigungsfenster wird angezeigt, wenn noch keine Berechtigungen erteilt wurden

Geerbt vonCallAdapterDeviceManagement.askDevicePermission

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

dispose()

Verwerfen des Zusammengesetzten

function dispose()

Geerbt vonDisposable.dispose

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

getState()

Abrufen des aktuellen Zustands

function getState(): CallAdapterState

Gibt zurück

CallAdapterState

Geerbt vonAdapterState.getState

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

off("callEnded", CallEndedListener)

Unsubscribe-Funktion für das Ereignis "callEnded".

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

Parameter

event

"callEnded"

listener

CallEndedListener

Geerbt vonCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Unsubscribe-Funktion für das Ereignis "callIdChanged".

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

Parameter

event

"callIdChanged"

listener

CallIdChangedListener

Geerbt vonCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Unsubscribe-Funktion für das Ereignis "diagnosticChanged".

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

Parameter

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Geerbt vonCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Unsubscribe-Funktion für das Ereignis "displayNameChanged".

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

Parameter

event

"displayNameChanged"

listener

DisplayNameChangedListener

Geerbt vonCallAdapterSubscribers.off

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

Abmeldefunktion für das Ereignis "error".

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

Parameter

event

"error"

listener

(e: AdapterError) => void

Geerbt vonCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Parameter

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Geerbt vonCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Abmeldefunktion für das Ereignis "isMutedChanged".

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

Parameter

event

"isMutedChanged"

listener

IsMutedChangedListener

Geerbt vonCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Abmeldefunktion für das Ereignis "isSpeakingChanged".

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

Parameter

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Geerbt vonCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Abmeldefunktion für das Ereignis "participantsJoined".

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

Parameter

event

"participantsJoined"

listener

ParticipantsJoinedListener

Geerbt vonCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Unsubscribe-Funktion für das Ereignis "participantsLeft".

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

Parameter

event

"participantsLeft"

listener

ParticipantsLeftListener

Geerbt vonCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Abmeldefunktion für das Ereignis "selectedMicrophoneChanged".

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

Parameter

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Geerbt vonCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das Ereignis "selectedSpeakerChanged".

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

Parameter

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Geerbt vonCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Beendet den Handler für stateChanged-Ereignisse.

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

Parameter

handler

(state: CallAdapterState) => void

Geerbt vonAdapterState.offStateChange

on("callEnded", CallEndedListener)

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

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

Parameter

event

"callEnded"

listener

CallEndedListener

Geerbt vonCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

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

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

Parameter

event

"callIdChanged"

listener

CallIdChangedListener

Hinweise

Das Ereignis wird ausgelöst, wenn callId des aktuellen Benutzers geändert wird.

Geerbt vonCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

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

Dieses Ereignis wird immer dann ausgelöst, wenn eine Änderung in der benutzerseitigen Diagnose des laufenden Anrufs vorliegt.

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

Parameter

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Geerbt vonCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

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

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

Parameter

event

"displayNameChanged"

listener

DisplayNameChangedListener

Geerbt vonCallAdapterSubscribers.on

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

Subscribe-Funktion für das Fehlerereignis.

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

Parameter

event

"error"

listener

(e: AdapterError) => void

Geerbt vonCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Parameter

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Geerbt vonCallAdapterSubscribers.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 Stummschaltungszustand des aktuellen Benutzers oder Remotebenutzers geändert hat.

Geerbt vonCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

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

Parameter

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Geerbt vonCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

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

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

Parameter

event

"participantsJoined"

listener

ParticipantsJoinedListener

Geerbt vonCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

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

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

Parameter

event

"participantsLeft"

listener

ParticipantsLeftListener

Geerbt vonCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

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

Parameter

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Geerbt vonCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

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

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

Parameter

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Geerbt vonCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Abonniert den Handler für stateChanged-Ereignisse.

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

Parameter

handler

(state: CallAdapterState) => void

Geerbt vonAdapterState.onStateChange

queryCameras()

Abfrage nach verfügbaren Kamerageräten.

function queryCameras(): Promise<VideoDeviceInfo[]>

Gibt zurück

Promise<VideoDeviceInfo[]>

Ein Array von Videogeräte-Informationsentitäten <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 Audiogeräte-Informationsentitäten <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

Geerbt vonCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Abfrage nach verfügbaren Mikrofongeräten.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Gibt zurück

Promise<AudioDeviceInfo[]>

Ein Array von Audiogeräte-Informationsentitäten <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

Geerbt vonCallAdapterDeviceManagement.querySpeakers

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

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 zur Auswahl, wählen Sie ein von queryCameras zurückgegebenes Gerät aus.

options

VideoStreamOptions

Optionen zum Steuern, wie der Kameradatenstrom gerendert wird <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parameter

sourceInfo

AudioDeviceInfo

Mikrofongerät zur Auswahl auswählen, wählen Sie ein von query zurückgegebenes Gerät ausMicrophones

Gibt zurück

Promise<void>

Geerbt vonCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parameter

sourceInfo

AudioDeviceInfo

Wählen Sie ein von querySpeakers zurückgegebenes Lautsprechergerät aus.

Gibt zurück

Promise<void>

Geerbt vonCallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

Kamera starten 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()

Kamera beenden 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()

Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal

function unmute(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallAdapterCallOperations.unmute