CallAdapter interface

Paket:

@azure/communication-react

Eine adapterspezifische Schnittstelle für Die Azure-Kommunikationsidentität, die CommonCallAdapter erweitert.

Extends

CommonCallAdapter

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

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)	Anruf verlassen
mute()	Stummschalten des aktuellen Benutzers während des Anrufs oder lokales Deaktivieren des Mikrofons
off("callEnded", CallEndedListener)	Abmeldefunktion für das "callEnded"-Ereignis.
off("callIdChanged", CallIdChangedListener)	Unsubscribe-Funktion für das "callIdChanged"-Ereignis.
off("diagnosticChanged", DiagnosticChangedEventListner)	Unsubscribe-Funktion für das "diagnosticChanged"-Ereignis.
off("displayNameChanged", DisplayNameChangedListener)	Unsubscribe-Funktion für das Ereignis "displayNameChanged".
off("error", (e: AdapterError) => void)	Abmeldefunktion für das Fehlerereignis.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Unsubscribe-Funktion für das Ereignis "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Abmeldefunktion für das "isSpeakingChanged"-Ereignis.
off("participantsJoined", ParticipantsJoinedListener)	Unsubscribe-Funktion für das Ereignis "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Abmeldefunktion für das Ereignis "participantsLeft".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Abmeldefunktion für das Ereignis "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Abmeldefunktion für das Ereignis "selectedSpeakerChanged".
offStateChange((state: CallAdapterState) => void)	Löst den Handler für stateChanged-Ereignisse ab.
on("callEnded", CallEndedListener)	Subscribe-Funktion für das "callEnded"-Ereignis.
on("callIdChanged", CallIdChangedListener)	Subscribe-Funktion für das "callIdChanged"-Ereignis.
on("diagnosticChanged", DiagnosticChangedEventListner)	Subscribe-Funktion für das "diagnosticChanged"-Ereignis. Dieses Ereignis wird immer dann ausgelöst, wenn sich der Benutzer ändert, der Diagnose des laufenden Anrufs konfrontiert ist.
on("displayNameChanged", DisplayNameChangedListener)	Subscribe-Funktion für das "displayNameChanged"-Ereignis.
on("error", (e: AdapterError) => void)	Subscribe-Funktion für das Fehlerereignis.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Abonnieren Sie die Funktion "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Subscribe-Funktion für das "isMutedChanged"-Ereignis.
on("isSpeakingChanged", IsSpeakingChangedListener)	Abonnieren Sie die Funktion "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)	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

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 Berechtigungen noch nicht erteilt wurden

Geerbt vonCommonCallAdapter.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, lassen Sie sie nicht definiert, 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 vonCommonCallAdapter.createStreamView

dispose()

Verwerfen des Zusammengesetzten

function dispose()

Geerbt vonCommonCallAdapter.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, lassen Sie sie nicht definiert, 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 vonCommonCallAdapter.disposeStreamView

getState()

Abrufen des aktuellen Zustands

function getState(): CallAdapterState

Gibt zurück

CallAdapterState

Geerbt vonCommonCallAdapter.getState

leaveCall(boolean)

Anruf verlassen

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

Parameter

forEveryone

boolean

Ob alle Teilnehmer beim Verlassen entfernt werden sollen

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.mute

off("callEnded", CallEndedListener)

Abmeldefunktion für das "callEnded"-Ereignis.

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

Parameter

event

"callEnded"

listener

CallEndedListener

Geerbt vonCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

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

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

Parameter

event

"callIdChanged"

listener

CallIdChangedListener

Geerbt vonCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

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

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

Parameter

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Geerbt vonCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

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

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

Parameter

event

"displayNameChanged"

listener

DisplayNameChangedListener

Geerbt vonCommonCallAdapter.off

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

Abmeldefunktion für das Fehlerereignis.

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

Parameter

event

"error"

listener

(e: AdapterError) => void

Geerbt vonCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Abmeldefunktion für das Ereignis "isLocalScreenSharingActiveChanged".

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

Parameter

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Geerbt vonCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

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

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

Parameter

event

"isMutedChanged"

listener

IsMutedChangedListener

Geerbt vonCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Abmeldefunktion für das "isSpeakingChanged"-Ereignis.

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

Parameter

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Geerbt vonCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

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

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

Parameter

event

"participantsJoined"

listener

ParticipantsJoinedListener

Geerbt vonCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Abmeldefunktion für das Ereignis "participantsLeft".

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

Parameter

event

"participantsLeft"

listener

ParticipantsLeftListener

Geerbt vonCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Abmeldefunktion für das Ereignis "selectedMicrophoneChanged".

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

Parameter

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Geerbt vonCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Abmeldefunktion für das Ereignis "selectedSpeakerChanged".

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

Parameter

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Geerbt vonCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Löst den Handler für stateChanged-Ereignisse ab.

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

Parameter

handler

(state: CallAdapterState) => void

Geerbt vonCommonCallAdapter.offStateChange

on("callEnded", CallEndedListener)

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

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

Parameter

event

"callEnded"

listener

CallEndedListener

Geerbt vonCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

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

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 wird.

Geerbt vonCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

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

Dieses Ereignis wird immer dann ausgelöst, wenn sich der Benutzer ändert, der Diagnose des laufenden Anrufs konfrontiert ist.

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

Parameter

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Geerbt vonCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

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

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

Parameter

event

"displayNameChanged"

listener

DisplayNameChangedListener

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Abonnieren Sie die Funktion "isLocalScreenSharingActiveChanged".

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

Parameter

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Geerbt vonCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

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

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

Parameter

event

"isMutedChanged"

listener

IsMutedChangedListener

Hinweise

Das Ereignis wird ausgelöst, wenn sich der Aktuelle Benutzer- oder Remotebenutzer stummschaltet-Zustand geändert hat.

Geerbt vonCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Abonnieren Sie die Funktion "isSpeakingChanged".

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

Parameter

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Geerbt vonCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

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

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

Parameter

event

"participantsJoined"

listener

ParticipantsJoinedListener

Geerbt vonCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

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

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

Parameter

event

"participantsLeft"

listener

ParticipantsLeftListener

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.on

onStateChange((state: CallAdapterState) => void)

Abonniert den Handler für stateChanged-Ereignisse.

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

Parameter

handler

(state: CallAdapterState) => void

Geerbt vonCommonCallAdapter.onStateChange

queryCameras()

Abfrage nach verfügbaren Kamerageräten.

function queryCameras(): Promise<VideoDeviceInfo[]>

Gibt zurück

Promise<VideoDeviceInfo[]>

Ein Array von Videogeräteinformationsentitäten <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

Geerbt vonCommonCallAdapter.queryCameras

queryMicrophones()

Abfrage nach verfügbaren Mikrofongeräten.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Gibt zurück

Promise<AudioDeviceInfo[]>

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

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

Geerbt vonCommonCallAdapter.queryMicrophones

querySpeakers()

Abfrage nach verfügbaren Mikrofongeräten.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Gibt zurück

Promise<AudioDeviceInfo[]>

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

Hinweise

Diese Methode sollte nach askDevicePermission() aufgerufen werden.

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.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 vonCommonCallAdapter.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, wählen Sie ein von Abfrage zurückgegebenes GerätMicrophones aus.

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.setSpeaker

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 vonCommonCallAdapter.startCamera

startScreenShare()

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

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.stopCamera

stopScreenShare()

Beenden der Freigabe des Bildschirms

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCommonCallAdapter.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 vonCommonCallAdapter.unmute