Call interface

Paket:

@azure/communication-calling

Stellt einen Anruf dar.

Extends

CallCommon

Eigenschaften

info	Rufen Sie Informationen zu diesem Anruf ab.

Geerbte 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

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Fügen Sie diesem Anruf eine Teams-App hinzu.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.
removeParticipant(CommunicationIdentifier)	Entfernen Sie einen Teilnehmer aus diesem Anruf.

Geerbte Methoden

dispose()
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.

Details zur Eigenschaft

info

Rufen Sie Informationen zu diesem Anruf ab.

info: CallInfo

Eigenschaftswert

CallInfo

Geerbte Eigenschaftsdetails

callEndReason

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

callEndReason?: CallEndReason

Eigenschaftswert

CallEndReason

geerbt vonCallCommon.callEndReason

callerInfo

Anruferinformationen, wenn dieser Anruf eingehender ist.

callerInfo: CallerInfo

Eigenschaftswert

CallerInfo

geerbt vonCallCommon.callerInfo

direction

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

direction: CallDirection

Eigenschaftswert

CallDirection

vonCallCommon.direction geerbt

id

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

id: string

Eigenschaftswert

string

geerbt vonCallCommon.id

isIncomingAudioMuted

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

isIncomingAudioMuted: boolean

Eigenschaftswert

boolean

geerbt vonCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Gibt an, ob das lokale Video aktiviert ist.

isLocalVideoStarted: boolean

Eigenschaftswert

boolean

geerbt vonCallCommon.isLocalVideoStarted

isMuted

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

isMuted: boolean

Eigenschaftswert

boolean

geerbt vonCallCommon.isMuted

isScreenSharingOn

Gibt an, ob die Bildschirmfreigabe aktiviert ist.

isScreenSharingOn: boolean

Eigenschaftswert

boolean

geerbt vonCallCommon.isScreenSharingOn

kind

Ruft die Art des Aufrufobjekts ab.

kind: CallKind

Eigenschaftswert

CallKind

vonCallCommon.kind geerbt

lobby

Rufen Sie den Teams-Besprechungs-Wartebereich ab.

lobby: Lobby

Eigenschaftswert

Lobby

vonCallCommon.lobby geerbt

localAudioStreams

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

localAudioStreams: readonly LocalAudioStream[]

Eigenschaftswert

readonly LocalAudioStream[]

vonCallCommon.localAudioStreams geerbt

localVideoStreams

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

localVideoStreams: readonly LocalVideoStream[]

Eigenschaftswert

readonly LocalVideoStream[]

geerbt vonCallCommon.localVideoStreams

remoteAudioStreams

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

remoteAudioStreams: readonly RemoteAudioStream[]

Eigenschaftswert

readonly RemoteAudioStream[]

geerbt vonCallCommon.remoteAudioStreams

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[]

vonCallCommon.remoteParticipants geerbt

role

Rufen Sie die Rolle des lokalen Benutzers im Anruf ab.

role: ParticipantRole

Eigenschaftswert

ParticipantRole

geerbt vonCallCommon.role

state

Rufen Sie den Status dieses Anrufs ab.

state: CallState

Eigenschaftswert

CallState

geerbt vonCallCommon.state

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

geerbt vonCallCommon.totalParticipantCount

Details zur Methode

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parameter

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

Der Bezeichner des hinzuzufügenden Teilnehmers.

Gibt zurück

RemoteParticipant

Das RemoteParticipant-Objekt, das dem erfolgreich hinzugefügten Teilnehmer zugeordnet ist.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

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.

Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Parameter

identifier

CommunicationUserIdentifier

Der Bezeichner des hinzuzufügenden Teilnehmers.

options

AddCommunicationUserOptions

Weitere Optionen für die Verwaltung des Anrufs.

Gibt zurück

RemoteParticipant

Das RemoteParticipant-Objekt, das dem erfolgreich hinzugefügten Teilnehmer zugeordnet ist.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

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.

Fügen Sie diesem Anruf eine Teams-App hinzu.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parameter

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

Der Bezeichner der hinzuzufügenden Teams-App.

Gibt zurück

RemoteParticipant

Das RemoteParticipant-Objekt, das der erfolgreich hinzugefügten Teams-App zugeordnet ist.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

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.

Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Parameter

identifier

MicrosoftTeamsUserIdentifier

Der Bezeichner des hinzuzufügenden Teilnehmers.

options

AddMicrosoftTeamsUserOptions

Weitere Optionen für die Verwaltung des Anrufs.

Gibt zurück

RemoteParticipant

Das RemoteParticipant-Objekt, das dem erfolgreich hinzugefügten Teilnehmer zugeordnet ist.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Fügen Sie einen Teilnehmer zu diesem Anruf hinzu.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Parameter

identifier

PhoneNumberIdentifier

Der Bezeichner des hinzuzufügenden Teilnehmers.

options

AddPhoneNumberOptions

Weitere Optionen für die Verwaltung des PSTN-Anrufs. Legen Sie beispielsweise die Telefonnummer der Anrufer-ID in einem PSTN-Anruf fest.

Gibt zurück

RemoteParticipant

Das RemoteParticipant-Objekt, das dem erfolgreich hinzugefügten Teilnehmer zugeordnet ist.

removeParticipant(CommunicationIdentifier)

Entfernen Sie einen Teilnehmer aus diesem Anruf.

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

Parameter

identifier

CommunicationIdentifier

Der Bezeichner des zu entfernenden Teilnehmers.

Gibt zurück

Promise<void>

Details zur geerbten Methode

dispose()

function dispose()

geerbt vonCallCommon.dispose

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

vonCallCommon.feature geerbt

hangUp(HangUpOptions)

Hängen Sie den Anruf auf.

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

Parameter

options

HangUpOptions

HangUp-Optionen.

Gibt zurück

Promise<void>

vonCallCommon.hangUp geerbt

hold()

Setzen Sie diesen Anruf in die Warteschleife.

function hold(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.hold

mute()

Lokales Mikrofon stummschalten.

function mute(): Promise<void>

Gibt zurück

Promise<void>

vonCallCommon.mute geerbt

muteAllRemoteParticipants()

Schalten Sie alle Remoteteilnehmer stumm.

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

vonCallCommon.muteAllRemoteParticipants geerbt

muteIncomingAudio()

Eingehende Audio stummschalten.

function muteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.muteIncomingAudio-

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.off geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

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.

vonCallCommon.on geerbt

resume()

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

function resume(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.resume

sendDtmf(DtmfTone)

DTMF-Ton senden.

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

Parameter

dtmfTone

DtmfTone

Gibt zurück

Promise<void>

geerbt vonCallCommon.sendDtmf

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>

geerbt vonCallCommon.setConstraints

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>

geerbt vonCallCommon.startAudio

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>

Geerbt vonCallCommon.startScreenSharing-

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>

Geerbt vonCallCommon.startScreenSharing-

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>

geerbt vonCallCommon.startVideo

stopAudio()

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

function stopAudio()

geerbt vonCallCommon.stopAudio

stopScreenSharing()

Beenden Sie die lokale Bildschirmfreigabe.

function stopScreenSharing(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.stopScreenSharing-

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>

geerbt vonCallCommon.stopScreenSharing-

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>

geerbt vonCallCommon.stopVideo

unmute()

Stummschaltung des lokalen Mikrofons aufheben.

function unmute(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.unmute

unmuteIncomingAudio()

Aufheben der Stummschaltung eingehender Audiodaten.

function unmuteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

geerbt vonCallCommon.unmuteIncomingAudio