Freigeben über

TeamsCall interface

  • Referenz
Paket:
@azure/communication-calling

Stellt einen Teams-Anruf dar.

Extends
CallCommon

Eigenschaften

info

Rufen Sie Informationen zu diesem Teams-Anruf ab.

Geerbte Eigenschaften

callEndReason

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

Anruferinformationen, wenn dieser Anruf eingehend ist.
direction

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

Ruft die eindeutige ID für diesen Anruf ab.
isIncomingAudioMuted

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

Gibt an, ob lokales Video aktiviert ist.
isMuted

Gibt an, ob der lokale Benutzer stummgeschaltet ist, lokal oder remote.
isScreenSharingOn

Gibt an, ob die Bildschirmfreigabe aktiviert ist.
kind

Rufen Sie die Art des Aufrufobjekts ab.
lobby

Rufen Sie den Teams-Besprechungslobby ab.
localAudioStreams

Sammlung von lokalen Audiostreams, die an andere Teilnehmer eines Anrufs gesendet werden.
localVideoStreams

Sammlung lokaler Videostreams, die an andere Teilnehmer eines Anrufs gesendet werden.
remoteAudioStreams

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

Sammlung von Remoteteilnehmern an diesem Anruf. Bei Anrufen mit Hunderten oder mehr Teilnehmern 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

Anzahl der Gesamtzahl der Teilnehmer an diesem Anruf.

Methoden

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)

Fügen Sie einen Teilnehmer hinzu.
removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

Entfernen Sie einen Teilnehmer aus diesem Anruf.

Geerbte Methoden

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)

Ruft ein initialisiertes und gespeichertes Featureobjekt mit erweiterter API ab. Überprüfen Sie das Objekt Features.* auf alle verfügbaren Features für erweiterte Aufrufe in diesem Paket. Beispiel:

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

Beende den Anruf.
hold()

Setzen Sie diesen Anruf in die Warteschleife.
mute()

Lokales Mikrofon stummschalten.
muteAllRemoteParticipants()

Alle Remoteteilnehmer stummschalten.
muteIncomingAudio()

Schalten Sie eingehende Audiodaten stumm.
off("idChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das idChanged-Ereignis.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isIncomingAudioMutedChanged-Ereignis.
off("isLocalVideoStartedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isLocalVideoStartedChanged-Ereignis.
off("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.
off("isScreenSharingOnChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isScreenSharingChanged-Ereignis.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Unsubscribe-Funktion für das LocalAudioStreamsUpdated-Ereignis.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Unsubscribe-Funktion für das 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-Funktion für totalParticipantCountChanged-Ereignis.
on("idChanged", PropertyChangedEvent)

Subscribe-Funktion für das idChanged-Ereignis.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isIncomingAudioMutedChanged-Ereignis.
on("isLocalVideoStartedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isLocalVideoStartedChanged-Ereignis.
on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.
on("isScreenSharingOnChanged", PropertyChangedEvent)

Subscribe-Funktion für das 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 Status "LocalHold" befindet.
sendDtmf(DtmfTone)

Senden Sie DTMF-Ton.
setConstraints(CallConstraints)

Legen Sie Aufrufeinschränkungen fest. Diese Methode legt die maximalen Einschränkungen von basierend auf den angegebenen Werten fest. Die endgültig angewendeten Einschränkungen sind kleiner oder gleich den Werten, die hier für diese Methode bereitgestellt werden. Wenn der Wert 0 angegeben wird, wird keine Einschränkung für diese Einschränkung angewendet. Wenn 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()
  • Starten Sie das Senden eines Bildschirmfreigabestreams in einem Anruf. Der Browser wird aufgefordert, den Bildschirm, die App oder die Browserregisterkarte auszuwählen.
  • Das Senden von Bildschirmfreigabestreams wird unter iOS oder Android nicht unterstützt.
  • Eingehender Stream für die Bildschirmfreigabe wird unter iOS und Android unterstützt.
startScreenSharing(LocalVideoStream)
  • Beginnen Sie mit dem Senden eines Unformatierten Bildschirmfreigabestreams in einem Anruf.
  • Das Senden von unformatierten Bildschirmfreigaben wird unter iOS oder Android nicht unterstützt.
  • Die Freigabe eingehender Unformatierter Bildschirme wird unter iOS und Android unterstützt.
startVideo(LocalVideoStream)

Beginnen Sie mit dem Senden des Videostreams im Anruf. Remoteteilnehmer am 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 von Videos in der CallAgent.startCall()-API, callAgent.join()-API, IncomingCall.accept()-API oder Call.startVideo()-API verwendet wurde.
unmute()

Heben Sie die Stummschaltung des lokalen Mikrofons auf.
unmuteIncomingAudio()

Heben Sie die Stummschaltung eingehender Audiodaten auf.

Details zur Eigenschaft

info

Rufen Sie Informationen zu diesem Teams-Anruf ab.

info: TeamsCallInfo

Eigenschaftswert

TeamsCallInfo

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

Geerbt vonCallCommon.direction

id

Ruft 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 lokales Video aktiviert ist.

isLocalVideoStarted: boolean

Eigenschaftswert

boolean

Geerbt vonCallCommon.isLocalVideoStarted

isMuted

Gibt an, ob der lokale Benutzer stummgeschaltet ist, lokal oder remote.

isMuted: boolean

Eigenschaftswert

boolean

Geerbt vonCallCommon.isMuted

isScreenSharingOn

Gibt an, ob die Bildschirmfreigabe aktiviert ist.

isScreenSharingOn: boolean

Eigenschaftswert

boolean

Geerbt vonCallCommon.isScreenSharingOn

kind

Rufen Sie die Art des Aufrufobjekts ab.

kind: CallKind

Eigenschaftswert

CallKind

Geerbt vonCallCommon.kind

lobby

Rufen Sie den Teams-Besprechungslobby ab.

lobby: Lobby

Eigenschaftswert

Lobby

Geerbt vonCallCommon.lobby

localAudioStreams

Sammlung von lokalen Audiostreams, die an andere Teilnehmer eines Anrufs gesendet werden.

localAudioStreams: readonly LocalAudioStream[]

Eigenschaftswert

readonly LocalAudioStream[]

Geerbt vonCallCommon.localAudioStreams

localVideoStreams

Sammlung lokaler Videostreams, die an andere Teilnehmer eines Anrufs 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 an diesem Anruf. Bei Anrufen mit Hunderten oder mehr Teilnehmern sind nur medienaktive Teilnehmer in dieser Sammlung vorhanden.

remoteParticipants: readonly RemoteParticipant[]

Eigenschaftswert

readonly RemoteParticipant[]

Geerbt vonCallCommon.remoteParticipants

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.

Anzahl der Gesamtzahl der Teilnehmer an diesem Anruf.

totalParticipantCount: number

Eigenschaftswert

number

Geerbt vonCallCommon.totalParticipantCount

Details zur Methode

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)

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

function addParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: AddTeamsParticipantOptions): RemoteParticipant

Parameter

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

Hinzuzufügende Teilnehmer

options
AddTeamsParticipantOptions

AddTeamsParticipantOptions

Gibt zurück

RemoteParticipant

removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

Entfernen Sie einen Teilnehmer aus diesem Anruf.

function removeParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier): Promise<void>

Parameter

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier

der zu entfernende Teilnehmer.

Gibt zurück

Promise<void>

Details zur geerbten Methode

dispose() 

function dispose()

Geerbt vonCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Ruft ein initialisiertes und gespeichertes Featureobjekt mit erweiterter API ab. Überprüfen Sie das Objekt Features.* auf alle verfügbaren Features für erweiterte Aufrufe in diesem Paket. Beispiel:

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 Aufruffunktionskonstruktor, der eine erweiterte API bereitstellt.

Gibt zurück

TFeature

Geerbt vonCallCommon.feature

hangUp(HangUpOptions)

Beende den Anruf.

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

Parameter

options
HangUpOptions

HangUp-Optionen.

Gibt zurück

Promise<void>

Geerbt vonCallCommon.hangUp

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>

Geerbt vonCallCommon.mute

muteAllRemoteParticipants()

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.

Alle Remoteteilnehmer stummschalten.

function muteAllRemoteParticipants(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Schalten Sie eingehende Audiodaten stumm.

function muteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das idChanged-Ereignis.

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

Parameter

event

"idChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isIncomingAudioMutedChanged-Ereignis.

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

Parameter

event

"isIncomingAudioMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isLocalVideoStartedChanged-Ereignis.

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

Parameter

event

"isLocalVideoStartedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isScreenSharingChanged-Ereignis.

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

Parameter

event

"isScreenSharingOnChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

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>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Unsubscribe-Funktion für das localVideoStreamsUpdated-Ereignis.

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

Parameter

event

"localVideoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<LocalVideoStream>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("mutedByOthers", 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-Funktion für das mutedByOthers-Ereignis.

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

Parameter

event

"mutedByOthers"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abbestellen dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Unsubscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.

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

Parameter

event

"remoteAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteAudioStream>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Unsubscribe-Funktion für remoteParticipantsUpdated-Ereignis.

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

Parameter

event

"remoteParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("roleChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

off("stateChanged", PropertyChangedEvent)

Unsubscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.off

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-Funktion für totalParticipantCountChanged-Ereignis.

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

Parameter

event

"totalParticipantCountChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich die Teilnehmeranzahl ändert.

Geerbt vonCallCommon.off

on("idChanged", PropertyChangedEvent)

Subscribe-Funktion für das idChanged-Ereignis.

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

Parameter

event

"idChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isIncomingAudioMutedChanged-Ereignis.

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

Parameter

event

"isIncomingAudioMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isLocalVideoStartedChanged-Ereignis.

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

Parameter

event

"isLocalVideoStartedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Subscribe-Funktion für das isScreenSharingChanged-Ereignis.

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

Parameter

event

"isScreenSharingOnChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

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>

Rückruf fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

Geerbt vonCallCommon.on

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>

Rückruf fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

Geerbt vonCallCommon.on

on("mutedByOthers", 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 mutedByOthers-Ereignis.

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

Parameter

event

"mutedByOthers"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

Geerbt vonCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Subscribe-Funktion für remoteAudioStreamsUpdated-Ereignis.

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

Parameter

event

"remoteAudioStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteAudioStream>

Rückruf fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

Geerbt vonCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Subscribe-Funktion für remoteParticipantsUpdated-Ereignis.

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

Parameter

event

"remoteParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

Rückruf fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

Geerbt vonCallCommon.on

on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

on("stateChanged", PropertyChangedEvent)

Subscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

Geerbt vonCallCommon.on

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

Rückruf fn, der aufgerufen wird, wenn sich die Teilnehmeranzahl ändert.

Geerbt vonCallCommon.on

resume()

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

function resume(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallCommon.resume

sendDtmf(DtmfTone)

Senden Sie DTMF-Ton.

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

Parameter

dtmfTone
DtmfTone

Gibt zurück

Promise<void>

Geerbt vonCallCommon.sendDtmf

setConstraints(CallConstraints)

Legen Sie Aufrufeinschränkungen fest. Diese Methode legt die maximalen Einschränkungen von basierend auf den angegebenen Werten fest. Die endgültig angewendeten Einschränkungen sind kleiner oder gleich den Werten, die hier für diese Methode bereitgestellt werden. Wenn der Wert 0 angegeben wird, wird keine Einschränkung für diese Einschränkung angewendet. Wenn 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()

  • Starten Sie das Senden eines Bildschirmfreigabestreams in einem Anruf. Der Browser wird aufgefordert, den Bildschirm, die App oder die Browserregisterkarte auszuwählen.
  • Das Senden von Bildschirmfreigabestreams wird unter iOS oder Android nicht unterstützt.
  • Eingehender Stream für die Bildschirmfreigabe 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 Bildschirmfreigabestreams in einem Anruf.
  • Das Senden von unformatierten Bildschirmfreigaben wird unter iOS oder Android nicht unterstützt.
  • Die Freigabe eingehender Unformatierter Bildschirme wird unter iOS und Android unterstützt.
function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream
LocalVideoStream

Stellt einen lokalen Rohbild-Freigabestream dar, der einen MediaStream-Konstruktor verwendet.

Gibt zurück

Promise<void>

Geerbt vonCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Beginnen Sie mit dem Senden des Videostreams im Anruf. Remoteteilnehmer am 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 annimmt.

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 lokale Bildschirmfreigabestream, 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 von Videos in der CallAgent.startCall()-API, callAgent.join()-API, IncomingCall.accept()-API oder 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()

Heben Sie die Stummschaltung des lokalen Mikrofons auf.

function unmute(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallCommon.unmute

unmuteIncomingAudio()

Heben Sie die Stummschaltung eingehender Audiodaten auf.

function unmuteIncomingAudio(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallCommon.unmuteIncomingAudio