CallWithChatAdapterManagement interface

Paket:

@azure/communication-react

Funktionalität zum Verwalten des aktuellen Anrufs mit Chat.

Methoden

askDevicePermission(PermissionConstraints)	Fragen Sie nach Berechtigungen für Geräte.
createStreamView(string, VideoStreamOptions)	Erstellen Sie die HTML-Ansicht für einen Stream.
deleteMessage(string)	Löschen Sie eine Nachricht im Thread.
disposeStreamView(string, VideoStreamOptions)	Entsorgen Sie die HTML-Ansicht für einen Stream.
fetchInitialData()	Ruft den Anfangszustand für den Chatadapter ab. Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.
joinCall(boolean)	Schließen Sie sich dem Anruf an, wobei das Mikrofon zunächst ein-/ausschaltet.
leaveCall(boolean)	Verlassen Sie den Anruf.
loadPreviousChatMessages(number)	Laden Sie weitere frühere Nachrichten in den Chatthreadverlauf.
mute()	Stummschalten Sie den aktuellen Benutzer während des Anrufs, oder deaktivieren Sie das Mikrofon lokal.
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 einem Anruf.
sendMessage(string, SendMessageOptions)	Senden Sie eine Nachricht im Thread.
sendReadReceipt(string)	Senden Sie eine Lesebestätigung für eine Nachricht.
sendTypingIndicator()	Senden Sie den Eingabeindikator im Thread.
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.
startCall(string[], StartCallOptions)	Starten Sie den Anruf.
startCamera(VideoStreamOptions)	Starten Sie die 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 Sie die Kamera. Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
stopScreenShare()	Beenden Sie die Freigabe des Bildschirms.
unmute()	Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal.
updateMessage(string, string, Record<string, string>)	Aktualisieren eines Nachrichteninhalts.

Details zur 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

Das Fenster "Browserberechtigungen" wird angezeigt, wenn berechtigungen noch nicht erteilt wurden.

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 zusammengesetzt implementiert.

deleteMessage(string)

Löschen Sie eine Nachricht im Thread.

function deleteMessage(messageId: string): Promise<void>

Parameter

messageId

string

Gibt zurück

Promise<void>

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 zusammengesetzt implementiert.

fetchInitialData()

Ruft den Anfangszustand für den Chatadapter ab.

Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.

function fetchInitialData(): Promise<void>

Gibt zurück

Promise<void>

joinCall(boolean)

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

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

Parameter

microphoneOn

boolean

Gibt an, ob das Mikrofon anfänglich aktiviert ist

Gibt zurück

undefined | Call

leaveCall(boolean)

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

loadPreviousChatMessages(number)

Laden Sie weitere frühere Nachrichten in den Chatthreadverlauf.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parameter

messagesToLoad

number

Gibt zurück

Promise<boolean>

Hinweise

Diese Methode wird normalerweise verwendet, um den inkrementellen Abruf/unendlichen Bildlauf zu steuern.

mute()

Stummschalten Sie den aktuellen Benutzer während des Anrufs, oder deaktivieren Sie das Mikrofon lokal.

function mute(): Promise<void>

Gibt zurück

Promise<void>

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.

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.

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.

removeParticipant(string)

Entfernen Sie einen Teilnehmer aus einem Anruf.

function removeParticipant(userId: string): Promise<void>

Parameter

userId

string

UserId des zu entfernenden Teilnehmers.

Gibt zurück

Promise<void>

sendMessage(string, SendMessageOptions)

Senden Sie eine Nachricht im Thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parameter

content

string

options

SendMessageOptions

Gibt zurück

Promise<void>

sendReadReceipt(string)

Senden Sie eine Lesebestätigung für eine Nachricht.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parameter

chatMessageId

string

Gibt zurück

Promise<void>

sendTypingIndicator()

Senden Sie den Eingabeindikator im Thread.

function sendTypingIndicator(): Promise<void>

Gibt zurück

Promise<void>

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>

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>

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>

startCall(string[], StartCallOptions)

Starten Sie den Anruf.

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

Parameter

participants

string[]

Ein Array von Teilnehmer-IDs, an die teilnehmen soll

options

StartCallOptions

Gibt zurück

undefined | Call

startCamera(VideoStreamOptions)

Starten Sie die 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>

startScreenShare()

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

function startScreenShare(): Promise<void>

Gibt zurück

Promise<void>

stopCamera()

Beenden Sie die Kamera.

Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.

function stopCamera(): Promise<void>

Gibt zurück

Promise<void>

stopScreenShare()

Beenden Sie die Freigabe des Bildschirms.

function stopScreenShare(): Promise<void>

Gibt zurück

Promise<void>

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>

updateMessage(string, string, Record<string, string>)

Aktualisieren eines Nachrichteninhalts.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Parameter

messageId

string

content

string

metadata

Record<string, string>

Gibt zurück

Promise<void>