CallCommon interface

Paket:

@azure/communication-calling

Die allgemeine Anrufschnittstelle.

Extends

Disposable

Eigenschaften

callEndReason	Enthält Code/SubCode, der angibt, wie dieser Aufruf beendet wurde.
callerInfo	Anruferinformationen, wenn dieser Anruf eingehender ist.
direction	Rufen Sie die Anrufrichtung ab, unabhängig davon, ob es sich um eingehende oder ausgehende Anrufe handelt.
id	Rufen Sie die eindeutige ID für diesen Anruf ab.
isIncomingAudioMuted	Gibt an, ob der lokale Benutzer eingehende Audio stummgeschaltet hat.
isLocalVideoStarted	Gibt an, ob das lokale Video aktiviert ist.
isMuted	Gibt an, ob lokaler Benutzer lokal oder remote stummgeschaltet ist.
isScreenSharingOn	Gibt an, ob die Bildschirmfreigabe aktiviert ist.
kind	Ruft die Art des Aufrufobjekts ab.
lobby	Rufen Sie den Teams-Besprechungs-Wartebereich ab.
localAudioStreams	Sammlung lokaler Audiodatenströme, die an andere Teilnehmer in einem Anruf gesendet werden.
localVideoStreams	Sammlung lokaler Videostreams, die an andere Teilnehmer in einem Anruf gesendet werden.
remoteAudioStreams	Sammlung von Remoteaudiodatenströmen, die vom Anruf empfangen werden.
remoteParticipants	Sammlung von Remoteteilnehmern in diesem Anruf. Bei Anrufen mit Teilnehmern von hundert oder mehr sind nur medienaktive Teilnehmer in dieser Sammlung vorhanden.
role	Rufen Sie die Rolle des lokalen Benutzers im Anruf ab.
state	Rufen Sie den Status dieses Anrufs ab.
totalParticipantCount	Die Anzahl der Teilnehmer in diesem Anruf.

Methoden

feature<TFeature>(CallFeatureFactory<TFeature>)	Ruft ein initialisiertes und memoisiertes Featureobjekt mit erweiterter API ab. Überprüfen Sie die Objektfeatures.* auf alle verfügbaren erweiterten Anruffunktionen in diesem Paket, z. B.: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Hängen Sie den Anruf auf.
hold()	Setzen Sie diesen Anruf in die Warteschleife.
mute()	Lokales Mikrofon stummschalten.
muteAllRemoteParticipants()	Schalten Sie alle Remoteteilnehmer stumm.
muteIncomingAudio()	Eingehende Audio stummschalten.
off("idChanged", PropertyChangedEvent)	Unsubscribe-Funktion für idChanged-Ereignis.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Subscribe-Funktion für isIncomingAudioMutedChanged-Ereignis.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Unsubscribe-Funktion für isLocalVideoStartedChanged-Ereignis.
off("isMutedChanged", PropertyChangedEvent)	Subscribe-Funktion für isMutedChanged-Ereignis.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Unsubscribe-Funktion für isScreenSharingChanged-Ereignis.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Unsubscribe-Funktion für das localAudioStreamsUpdated-Ereignis.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Unsubscribe-Funktion für localVideoStreamsUpdated-Ereignis.
off("mutedByOthers", PropertyChangedEvent)	Unsubscribe-Funktion für das MutedByOthers-Ereignis.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Unsubscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Unsubscribe-Funktion für remoteParticipantsUpdated-Ereignis.
off("roleChanged", PropertyChangedEvent)	Unsubscribe-Funktion für das roleChanged-Ereignis.
off("stateChanged", PropertyChangedEvent)	Unsubscribe-Funktion für stateChanged-Ereignis.
off("totalParticipantCountChanged", PropertyChangedEvent)	unsubscribe function for totalParticipantCountChanged event.
on("idChanged", PropertyChangedEvent)	Subscribe-Funktion für idChanged-Ereignis.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Subscribe-Funktion für isIncomingAudioMutedChanged-Ereignis.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Subscribe-Funktion für isLocalVideoStartedChanged-Ereignis.
on("isMutedChanged", PropertyChangedEvent)	Subscribe-Funktion für isMutedChanged-Ereignis.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Subscribe-Funktion für isScreenSharingChanged-Ereignis.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Subscribe-Funktion für das localAudioStreamsUpdated-Ereignis.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Subscribe-Funktion für das localVideoStreamsUpdated-Ereignis.
on("mutedByOthers", PropertyChangedEvent)	Subscribe-Funktion für das MutedByOthers-Ereignis.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Subscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Subscribe-Funktion für remoteParticipantsUpdated-Ereignis.
on("roleChanged", PropertyChangedEvent)	Subscribe-Funktion für das roleChanged-Ereignis.
on("stateChanged", PropertyChangedEvent)	Subscribe-Funktion für stateChanged-Ereignis.
on("totalParticipantCountChanged", PropertyChangedEvent)	Subscribe-Funktion für das totalParticipantCountChanged-Ereignis.
resume()	Setzen Sie diesen Aufruf fort, wenn er sich im Zustand "LocalHold" befindet.
sendDtmf(DtmfTone)	DTMF-Ton senden.
setConstraints(CallConstraints)	Festlegen von Anrufeinschränkungen. Diese Methode legt die maximalen Einschränkungen basierend auf den bereitgestellten Werten fest. Die endgültigen angewendeten Einschränkungen sind kleiner oder gleich den werten, die hier für diese Methode bereitgestellt werden. Wenn 0 Wert angegeben wird, wird für diese Einschränkung keine Einschränkung angewendet. Wenn ein nicht definierter Wert angegeben wird, wird der zuvor verwendete Wert für diese Einschränkung verwendet.
startAudio(LocalAudioStream)	Starten Sie Audio im Anruf mit benutzerdefiniertem Audio. LocalAudioStream-Quelle sollte ein MediaStream sein.
startScreenSharing()	Beginnen Sie mit dem Senden des Bildschirmfreigabedatenstroms in einem Anruf. Der Browser fordert sie auf, die Registerkarte "Bildschirm", "App" oder "Browser" auszuwählen. Das Senden des Bildschirmfreigabedatenstroms wird unter iOS oder Android nicht unterstützt. Eingehender Bildschirmfreigabedatenstrom wird unter iOS und Android unterstützt.
startScreenSharing(LocalVideoStream)	Beginnen Sie mit dem Senden eines Unformatierten Bildschirmfreigabedatenstroms in einem Anruf. Das Senden der unformatierten Bildschirmfreigabe wird unter iOS oder Android nicht unterstützt. Die Freigabe des eingehenden rohen Bildschirms wird unter iOS und Android unterstützt.
startVideo(LocalVideoStream)	Beginnen Sie mit dem Senden des Videostreams im Anruf. Remoteteilnehmer im Anruf erhalten Ihren Videostream, damit sie ihn in ihren UIs rendern können.
stopAudio()	Beenden Sie benutzerdefinierte Audiodaten im Anruf, und wechseln Sie zum Standardaudiogerät des Geräte-Managers.
stopScreenSharing()	Beenden Sie die lokale Bildschirmfreigabe.
stopScreenSharing(LocalVideoStream)	Beenden Sie die lokale Bildschirmfreigabe.
stopVideo(LocalVideoStream)	Beenden Sie das Senden des Videostreams im Anruf. Muss dasselbe LocalVideoStream-Objekt übergeben, das zum Starten des Videos in der CallAgent.startCall()-API, der CallAgent.join()-API, der IncomingCall.accept()-API oder der Call.startVideo()-API verwendet wurde.
unmute()	Stummschaltung des lokalen Mikrofons aufheben.
unmuteIncomingAudio()	Aufheben der Stummschaltung eingehender Audiodaten.

Geerbte Methoden

dispose()

Details zur Eigenschaft

callEndReason

Enthält Code/SubCode, der angibt, wie dieser Aufruf beendet wurde.

callEndReason?: CallEndReason

Eigenschaftswert

CallEndReason

callerInfo

Anruferinformationen, wenn dieser Anruf eingehender ist.

callerInfo: CallerInfo

Eigenschaftswert

CallerInfo

direction

Rufen Sie die Anrufrichtung ab, unabhängig davon, ob es sich um eingehende oder ausgehende Anrufe handelt.

direction: CallDirection

Eigenschaftswert

CallDirection

id

Rufen Sie die eindeutige ID für diesen Anruf ab.

id: string

Eigenschaftswert

string

isIncomingAudioMuted

Gibt an, ob der lokale Benutzer eingehende Audio stummgeschaltet hat.

isIncomingAudioMuted: boolean

Eigenschaftswert

boolean

isLocalVideoStarted

Gibt an, ob das lokale Video aktiviert ist.

isLocalVideoStarted: boolean

Eigenschaftswert

boolean

isMuted

Gibt an, ob lokaler Benutzer lokal oder remote stummgeschaltet ist.

isMuted: boolean

Eigenschaftswert

boolean

isScreenSharingOn

Gibt an, ob die Bildschirmfreigabe aktiviert ist.

isScreenSharingOn: boolean

Eigenschaftswert

boolean

kind

Ruft die Art des Aufrufobjekts ab.

kind: CallKind

Eigenschaftswert

CallKind

lobby

Rufen Sie den Teams-Besprechungs-Wartebereich ab.

lobby: Lobby

Eigenschaftswert

Lobby

localAudioStreams

Sammlung lokaler Audiodatenströme, die an andere Teilnehmer in einem Anruf gesendet werden.

localAudioStreams: readonly LocalAudioStream[]

Eigenschaftswert

readonly LocalAudioStream[]

localVideoStreams

Sammlung lokaler Videostreams, die an andere Teilnehmer in einem Anruf gesendet werden.

localVideoStreams: readonly LocalVideoStream[]

Eigenschaftswert

readonly LocalVideoStream[]

remoteAudioStreams

Sammlung von Remoteaudiodatenströmen, die vom Anruf empfangen werden.

remoteAudioStreams: readonly RemoteAudioStream[]

Eigenschaftswert

readonly RemoteAudioStream[]

remoteParticipants

Sammlung von Remoteteilnehmern in diesem Anruf. Bei Anrufen mit Teilnehmern von hundert oder mehr sind nur medienaktive Teilnehmer in dieser Sammlung vorhanden.

remoteParticipants: readonly RemoteParticipant[]

Eigenschaftswert

readonly RemoteParticipant[]

role

Rufen Sie die Rolle des lokalen Benutzers im Anruf ab.

role: ParticipantRole

Eigenschaftswert

ParticipantRole

state

Rufen Sie den Status dieses Anrufs ab.

state: CallState

Eigenschaftswert

CallState

totalParticipantCount

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Anzahl der Teilnehmer in diesem Anruf.

totalParticipantCount: number

Eigenschaftswert

number

Details zur Methode

feature<TFeature>(CallFeatureFactory<TFeature>)

Ruft ein initialisiertes und memoisiertes Featureobjekt mit erweiterter API ab. Überprüfen Sie die Objektfeatures.* auf alle verfügbaren erweiterten Anruffunktionen in diesem Paket, z. B.:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

Parameter

factory

CallFeatureFactory<TFeature>

Die Factory für den Aufruffeaturekonstruktor, der eine erweiterte API bereitstellt.

Gibt zurück

TFeature

hangUp(HangUpOptions)

Hängen Sie den Anruf auf.

function hangUp(options?: HangUpOptions): Promise<void>

Parameter

options

HangUpOptions

HangUp-Optionen.

Gibt zurück

Promise<void>

hold()

Setzen Sie diesen Anruf in die Warteschleife.

function hold(): Promise<void>

Gibt zurück

Promise<void>

mute()

Lokales Mikrofon stummschalten.

function mute(): Promise<void>

Gibt zurück

Promise<void>

muteAllRemoteParticipants()

Schalten Sie alle Remoteteilnehmer stumm.

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

muteIncomingAudio()

Eingehende Audio stummschalten.

function muteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

off("idChanged", PropertyChangedEvent)

Unsubscribe-Funktion für idChanged-Ereignis.

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

Parameter

event

"idChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für isIncomingAudioMutedChanged-Ereignis.

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

Parameter

event

"isIncomingAudioMutedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für isLocalVideoStartedChanged-Ereignis.

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

Parameter

event

"isLocalVideoStartedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

off("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

off("isScreenSharingOnChanged", PropertyChangedEvent)

Unsubscribe-Funktion für isScreenSharingChanged-Ereignis.

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

Parameter

event

"isScreenSharingOnChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Unsubscribe-Funktion für das localAudioStreamsUpdated-Ereignis.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parameter

event

"localAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Unsubscribe-Funktion für localVideoStreamsUpdated-Ereignis.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parameter

event

"localVideoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("mutedByOthers", PropertyChangedEvent)

Unsubscribe-Funktion für das MutedByOthers-Ereignis.

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

Parameter

event

"mutedByOthers"

Ereignisname.

listener

PropertyChangedEvent

rückruf fn, der zum Kündigen des Abonnements für dieses Ereignis verwendet wurde.

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Unsubscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parameter

event

"remoteAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Unsubscribe-Funktion für remoteParticipantsUpdated-Ereignis.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameter

event

"remoteParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("roleChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("stateChanged", PropertyChangedEvent)

Unsubscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("totalParticipantCountChanged", PropertyChangedEvent)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

unsubscribe function for totalParticipantCountChanged event.

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

Parameter

event

"totalParticipantCountChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when the participant count changes.

on("idChanged", PropertyChangedEvent)

Subscribe-Funktion für idChanged-Ereignis.

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

Parameter

event

"idChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für isIncomingAudioMutedChanged-Ereignis.

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

Parameter

event

"isIncomingAudioMutedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Subscribe-Funktion für isLocalVideoStartedChanged-Ereignis.

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

Parameter

event

"isLocalVideoStartedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isScreenSharingOnChanged", PropertyChangedEvent)

Subscribe-Funktion für isScreenSharingChanged-Ereignis.

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

Parameter

event

"isScreenSharingOnChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Subscribe-Funktion für das localAudioStreamsUpdated-Ereignis.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parameter

event

"localAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Subscribe-Funktion für das localVideoStreamsUpdated-Ereignis.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parameter

event

"localVideoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

on("mutedByOthers", PropertyChangedEvent)

Subscribe-Funktion für das MutedByOthers-Ereignis.

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

Parameter

event

"mutedByOthers"

Ereignisname.

listener

PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Subscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parameter

event

"remoteAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Subscribe-Funktion für remoteParticipantsUpdated-Ereignis.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameter

event

"remoteParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("stateChanged", PropertyChangedEvent)

Subscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("totalParticipantCountChanged", PropertyChangedEvent)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Subscribe-Funktion für das totalParticipantCountChanged-Ereignis.

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

Parameter

event

"totalParticipantCountChanged"

Ereignisname.

listener

PropertyChangedEvent

callback fn that will be called when the participant count changes.

resume()

Setzen Sie diesen Aufruf fort, wenn er sich im Zustand "LocalHold" befindet.

function resume(): Promise<void>

Gibt zurück

Promise<void>

sendDtmf(DtmfTone)

DTMF-Ton senden.

function sendDtmf(dtmfTone: DtmfTone): Promise<void>

Parameter

dtmfTone

DtmfTone

Gibt zurück

Promise<void>

setConstraints(CallConstraints)

Festlegen von Anrufeinschränkungen. Diese Methode legt die maximalen Einschränkungen basierend auf den bereitgestellten Werten fest. Die endgültigen angewendeten Einschränkungen sind kleiner oder gleich den werten, die hier für diese Methode bereitgestellt werden. Wenn 0 Wert angegeben wird, wird für diese Einschränkung keine Einschränkung angewendet. Wenn ein nicht definierter Wert angegeben wird, wird der zuvor verwendete Wert für diese Einschränkung verwendet.

function setConstraints(constraints: CallConstraints): Promise<void>

Parameter

constraints

CallConstraints

Objekt, das die festzulegenden Aufrufeinschränkungen darstellt

Gibt zurück

Promise<void>

startAudio(LocalAudioStream)

Starten Sie Audio im Anruf mit benutzerdefiniertem Audio. LocalAudioStream-Quelle sollte ein MediaStream sein.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

Parameter

localAudioStream

LocalAudioStream

Gibt zurück

Promise<void>

startScreenSharing()

• Beginnen Sie mit dem Senden des Bildschirmfreigabedatenstroms in einem Anruf. Der Browser fordert sie auf, die Registerkarte "Bildschirm", "App" oder "Browser" auszuwählen.
• Das Senden des Bildschirmfreigabedatenstroms wird unter iOS oder Android nicht unterstützt.
• Eingehender Bildschirmfreigabedatenstrom wird unter iOS und Android unterstützt.

function startScreenSharing(): Promise<void>

Gibt zurück

Promise<void>

startScreenSharing(LocalVideoStream)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

• Beginnen Sie mit dem Senden eines Unformatierten Bildschirmfreigabedatenstroms in einem Anruf.
• Das Senden der unformatierten Bildschirmfreigabe wird unter iOS oder Android nicht unterstützt.
• Die Freigabe des eingehenden rohen Bildschirms wird unter iOS und Android unterstützt.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Stellt einen lokalen Rohdatenstrom für die Bildschirmfreigabe dar, der einen MediaStream im Konstruktor verwendet.

Gibt zurück

Promise<void>

startVideo(LocalVideoStream)

Beginnen Sie mit dem Senden des Videostreams im Anruf. Remoteteilnehmer im Anruf erhalten Ihren Videostream, damit sie ihn in ihren UIs rendern können.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Stellt einen lokalen Videostream dar, der eine Kameraquelle im Konstruktor akzeptiert.

Gibt zurück

Promise<void>

stopAudio()

Beenden Sie benutzerdefinierte Audiodaten im Anruf, und wechseln Sie zum Standardaudiogerät des Geräte-Managers.

function stopAudio()

stopScreenSharing()

Beenden Sie die lokale Bildschirmfreigabe.

function stopScreenSharing(): Promise<void>

Gibt zurück

Promise<void>

stopScreenSharing(LocalVideoStream)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Beenden Sie die lokale Bildschirmfreigabe.

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Der Stream für die lokale Bildschirmfreigabe, um das Streaming zu beenden.

Gibt zurück

Promise<void>

stopVideo(LocalVideoStream)

Beenden Sie das Senden des Videostreams im Anruf. Muss dasselbe LocalVideoStream-Objekt übergeben, das zum Starten des Videos in der CallAgent.startCall()-API, der CallAgent.join()-API, der IncomingCall.accept()-API oder der Call.startVideo()-API verwendet wurde.

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Der lokale Videostream zum Beenden des Streamings.

Gibt zurück

Promise<void>

unmute()

Stummschaltung des lokalen Mikrofons aufheben.

function unmute(): Promise<void>

Gibt zurück

Promise<void>

unmuteIncomingAudio()

Aufheben der Stummschaltung eingehender Audiodaten.

function unmuteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

Details zur geerbten Methode

dispose()

function dispose()

geerbt vonDisposable.dispose