CallCommon interface

Pakket:

@azure/communication-calling

De gemeenschappelijke interface aanroepen.

Uitbreiding

Disposable

Eigenschappen

callEndReason	Bevat code/subcode die aangeeft hoe deze aanroep is beëindigd.
callerInfo	Informatie over beller als deze oproep binnenkomt.
direction	Haal de oproeprichting op, ongeacht of deze binnenkomend of uitgaand is.
id	Haal de unieke id voor deze oproep op.
isIncomingAudioMuted	Of lokale gebruiker binnenkomende audio heeft gedempt.
isLocalVideoStarted	Of lokale video is ingeschakeld.
isMuted	Of lokale gebruiker is gedempt, lokaal of extern.
isScreenSharingOn	Of het delen van het scherm is ingeschakeld.
kind	Het type aanroepobject ophalen.
lobby	Haal de Lobby van de Teams-vergadering op.
localAudioStreams	Verzameling lokale audiostreams die worden verzonden naar andere deelnemers in een gesprek.
localVideoStreams	Verzameling lokale videostreams die worden verzonden naar andere deelnemers in een gesprek.
remoteAudioStreams	Verzameling van externe audiostreams die worden ontvangen van het gesprek.
remoteParticipants	Verzameling externe deelnemers aan deze oproep. In het geval van gesprekken met deelnemers van honderd of meer, zijn alleen media-actieve deelnemers aanwezig in deze verzameling.
role	Haal de rol van de lokale gebruiker op in de oproep.
state	Haal de status van deze oproep op.
totalParticipantCount	Het totale aantal deelnemers in deze oproep.
transferorInfo	Initiator van overdracht in het geval van overdrachts-/doorstuurscenario's.

Methoden

feature<TFeature>(CallFeatureFactory<TFeature>)	Hiermee haalt u een geïnitialiseerd en onthouden functieobject op met uitgebreide API. Controleer de objectfuncties.* voor alle beschikbare uitgebreide oproepfuncties in dit pakket, bijvoorbeeld: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Het gesprek ophangen.
hold()	Zet deze oproep in de wachtstand.
mute()	Lokale microfoon dempen.
muteAllRemoteParticipants()	Alle externe deelnemers dempen.
muteIncomingAudio()	Binnenkomende audio dempen.
off("callerInfoChanged", PropertyChangedEvent)	De functie Afmelden voor gewijzigde gebeurtenis van bellergegevens.
off("idChanged", PropertyChangedEvent)	De functie Afmelden voor idChanged-gebeurtenis.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Abonneer de functie isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	De functie Afmelden voor de gebeurtenis isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	De functie Abonneren voor de gebeurtenis isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	De functie Afmelden voor de gebeurtenis isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	De functie Afmelden voor de localAudioStreamsUpdated-gebeurtenis.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	De functie Afmelden voor de gebeurtenis localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Afmeldingsfunctie voor mutedByOthers-gebeurtenis.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	De functie Afmelden voor de remoteAudioStreamsUpdated-gebeurtenis.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	De functie Afmelden voor de gebeurtenis remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	De functie Afmelden voor de roleChanged-gebeurtenis.
off("stateChanged", PropertyChangedEvent)	Afmeldingsfunctie voor stateChanged-gebeurtenis.
off("totalParticipantCountChanged", PropertyChangedEvent)	afmeldingsfunctie voor de totalParticipantCountChanged-gebeurtenis.
off("transferorInfoChanged", PropertyChangedEvent)	De functie Afmelden voor gewijzigde gebeurtenis van bellergegevens.
on("callerInfoChanged", PropertyChangedEvent)	Abonneerfunctie voor gewijzigde gebeurtenis van bellergegevens.
on("idChanged", PropertyChangedEvent)	Abonneer de functie voor idChanged-gebeurtenis.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Abonneer de functie isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Abonneer de functie isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	De functie Abonneren voor de gebeurtenis isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	De functie Abonneren voor de gebeurtenis isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Abonneer de functie voor de gebeurtenis localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Abonneer de functie voor de gebeurtenis localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Abonneer de functie voor de gebeurtenis mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Abonneer de functie voor de remoteAudioStreamsUpdated-gebeurtenis.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Abonneer de functie voor de gebeurtenis remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Abonneer de functie voor roleChanged-gebeurtenis.
on("stateChanged", PropertyChangedEvent)	Abonneer de functie voor stateChanged-gebeurtenis.
on("totalParticipantCountChanged", PropertyChangedEvent)	Abonneer de functie voor de gebeurtenis totalParticipantCountChanged.
on("transferorInfoChanged", PropertyChangedEvent)	Abonneerfunctie voor gewijzigde gebeurtenis van bellergegevens.
resume()	Hervat deze oproep als deze de status LocalHold heeft.
sendDtmf(DtmfTone)	DTMF-toon verzenden.
setConstraints(CallConstraints)	Oproepbeperkingen instellen. Met deze methode worden de maximumbeperkingen ingesteld op basis van de opgegeven waarden. De uiteindelijke toegepaste beperkingen zijn kleiner dan of gelijk aan de waarden die hier voor deze methode worden opgegeven. Als er 0-waarde is opgegeven, wordt er geen beperking toegepast voor die beperking. Als er een niet-gedefinieerde waarde wordt opgegeven, wordt de vorige waarde gebruikt voor die beperking.
startAudio(LocalAudioStream)	Start audio in het gesprek met aangepaste audio. De LocalAudioStream-bron moet een MediaStream zijn.
startScreenSharing()	Begin met het verzenden van een stream voor het delen van het scherm in een gesprek. In de browser wordt gevraagd om het scherm, de app of het browsertabblad te selecteren. Het verzenden van een stream voor het delen van het scherm wordt niet ondersteund op iOS of Android. De stream voor het delen van binnenkomende schermen wordt ondersteund op iOS en Android.
startScreenSharing(LocalVideoStream)	Begin met het verzenden van een stream voor het delen van onbewerkte schermen in een gesprek. Het verzenden van onbewerkt scherm delen wordt niet ondersteund op iOS of Android. Binnenkomende onbewerkte schermdeling wordt ondersteund op iOS en Android.
startVideo(LocalVideoStream)	Begin met het verzenden van een videostream in het gesprek. Externe deelnemers aan het gesprek ontvangen uw videostream, zodat ze deze in hun UIs kunnen weergeven.
stopAudio()	Stop aangepaste audio in het gesprek en schakel over naar het standaardaudioapparaat van Apparaatbeheer.
stopScreenSharing()	Stop het delen van het lokale scherm.
stopScreenSharing(LocalVideoStream)	Stop het delen van het lokale scherm.
stopVideo(LocalVideoStream)	Stop met het verzenden van een videostream in het gesprek. Moet hetzelfde LocalVideoStream-object doorgeven dat is gebruikt om video te starten in de CallAgent.startCall() API, CallAgent.join() API, IncomingCall.accept() API of Call.startVideo() API.
unmute()	Demping van lokale microfoon opheffen.
unmuteIncomingAudio()	Het dempen van binnenkomende audio opheffen.

Overgenomen methoden

dispose()

Eigenschapdetails

callEndReason

Bevat code/subcode die aangeeft hoe deze aanroep is beëindigd.

callEndReason?: CallEndReason

Waarde van eigenschap

CallEndReason

callerInfo

Informatie over beller als deze oproep binnenkomt.

callerInfo: CallerInfo

Waarde van eigenschap

CallerInfo

direction

Haal de oproeprichting op, ongeacht of deze binnenkomend of uitgaand is.

direction: CallDirection

Waarde van eigenschap

CallDirection

id

Haal de unieke id voor deze oproep op.

id: string

Waarde van eigenschap

string

isIncomingAudioMuted

Of lokale gebruiker binnenkomende audio heeft gedempt.

isIncomingAudioMuted: boolean

Waarde van eigenschap

boolean

isLocalVideoStarted

Of lokale video is ingeschakeld.

isLocalVideoStarted: boolean

Waarde van eigenschap

boolean

isMuted

Of lokale gebruiker is gedempt, lokaal of extern.

isMuted: boolean

Waarde van eigenschap

boolean

isScreenSharingOn

Of het delen van het scherm is ingeschakeld.

isScreenSharingOn: boolean

Waarde van eigenschap

boolean

kind

Het type aanroepobject ophalen.

kind: CallKind

Waarde van eigenschap

CallKind

lobby

Haal de Lobby van de Teams-vergadering op.

lobby: Lobby

Waarde van eigenschap

Lobby

localAudioStreams

Verzameling lokale audiostreams die worden verzonden naar andere deelnemers in een gesprek.

localAudioStreams: readonly LocalAudioStream[]

Waarde van eigenschap

readonly LocalAudioStream[]

localVideoStreams

Verzameling lokale videostreams die worden verzonden naar andere deelnemers in een gesprek.

localVideoStreams: readonly LocalVideoStream[]

Waarde van eigenschap

readonly LocalVideoStream[]

remoteAudioStreams

Verzameling van externe audiostreams die worden ontvangen van het gesprek.

remoteAudioStreams: readonly RemoteAudioStream[]

Waarde van eigenschap

readonly RemoteAudioStream[]

remoteParticipants

Verzameling externe deelnemers aan deze oproep. In het geval van gesprekken met deelnemers van honderd of meer, zijn alleen media-actieve deelnemers aanwezig in deze verzameling.

remoteParticipants: readonly RemoteParticipant[]

Waarde van eigenschap

readonly RemoteParticipant[]

role

Haal de rol van de lokale gebruiker op in de oproep.

role: ParticipantRole

Waarde van eigenschap

ParticipantRole

state

Haal de status van deze oproep op.

state: CallState

Waarde van eigenschap

CallState

totalParticipantCount

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Het totale aantal deelnemers in deze oproep.

totalParticipantCount: number

Waarde van eigenschap

number

transferorInfo

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Initiator van overdracht in het geval van overdrachts-/doorstuurscenario's.

transferorInfo?: CallerInfo

Waarde van eigenschap

CallerInfo

Methodedetails

feature<TFeature>(CallFeatureFactory<TFeature>)

Hiermee haalt u een geïnitialiseerd en onthouden functieobject op met uitgebreide API. Controleer de objectfuncties.* voor alle beschikbare uitgebreide oproepfuncties in dit pakket, bijvoorbeeld:

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

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

Parameters

factory

CallFeatureFactory<TFeature>

De factory voor de aanroepfunctieconstructor die een uitgebreide API biedt.

Retouren

TFeature

hangUp(HangUpOptions)

Het gesprek ophangen.

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

Parameters

options

HangUpOptions

HangUp-opties.

Retouren

Promise<void>

hold()

Zet deze oproep in de wachtstand.

function hold(): Promise<void>

Retouren

Promise<void>

mute()

Lokale microfoon dempen.

function mute(): Promise<void>

Retouren

Promise<void>

muteAllRemoteParticipants()

Alle externe deelnemers dempen.

function muteAllRemoteParticipants(): Promise<void>

Retouren

Promise<void>

muteIncomingAudio()

Binnenkomende audio dempen.

function muteIncomingAudio(): Promise<void>

Retouren

Promise<void>

off("callerInfoChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

De functie Afmelden voor gewijzigde gebeurtenis van bellergegevens.

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

Parameters

event

"callerInfoChanged"

listener

PropertyChangedEvent

off("idChanged", PropertyChangedEvent)

De functie Afmelden voor idChanged-gebeurtenis.

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

Parameters

event

"idChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Abonneer de functie isIncomingAudioMutedChanged.

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

Parameters

event

"isIncomingAudioMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

off("isLocalVideoStartedChanged", PropertyChangedEvent)

De functie Afmelden voor de gebeurtenis isLocalVideoStartedChanged.

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

Parameters

event

"isLocalVideoStartedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

off("isMutedChanged", PropertyChangedEvent)

De functie Abonneren voor de gebeurtenis isMutedChanged.

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

Parameters

event

"isMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

off("isScreenSharingOnChanged", PropertyChangedEvent)

De functie Afmelden voor de gebeurtenis isScreenSharingChanged.

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

Parameters

event

"isScreenSharingOnChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

De functie Afmelden voor de localAudioStreamsUpdated-gebeurtenis.

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

Parameters

event

"localAudioStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

De functie Afmelden voor de gebeurtenis localVideoStreamsUpdated.

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

Parameters

event

"localVideoStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("mutedByOthers", PropertyChangedEvent)

Afmeldingsfunctie voor mutedByOthers-gebeurtenis.

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

Parameters

event

"mutedByOthers"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u af te melden voor deze gebeurtenis.

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

De functie Afmelden voor de remoteAudioStreamsUpdated-gebeurtenis.

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

Parameters

event

"remoteAudioStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

De functie Afmelden voor de gebeurtenis remoteParticipantsUpdated.

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

Parameters

event

"remoteParticipantsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("roleChanged", PropertyChangedEvent)

De functie Afmelden voor de roleChanged-gebeurtenis.

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

Parameters

event

"roleChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("stateChanged", PropertyChangedEvent)

Afmeldingsfunctie voor stateChanged-gebeurtenis.

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

Parameters

event

"stateChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("totalParticipantCountChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

afmeldingsfunctie voor de totalParticipantCountChanged-gebeurtenis.

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

Parameters

event

"totalParticipantCountChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de deelnemer telt.

off("transferorInfoChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

De functie Afmelden voor gewijzigde gebeurtenis van bellergegevens.

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

Parameters

event

"transferorInfoChanged"

listener

PropertyChangedEvent

on("callerInfoChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Abonneerfunctie voor gewijzigde gebeurtenis van bellergegevens.

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

Parameters

event

"callerInfoChanged"

listener

PropertyChangedEvent

on("idChanged", PropertyChangedEvent)

Abonneer de functie voor idChanged-gebeurtenis.

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

Parameters

event

"idChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Abonneer de functie isIncomingAudioMutedChanged.

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

Parameters

event

"isIncomingAudioMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Abonneer de functie isLocalVideoStartedChanged.

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

Parameters

event

"isLocalVideoStartedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isMutedChanged", PropertyChangedEvent)

De functie Abonneren voor de gebeurtenis isMutedChanged.

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

Parameters

event

"isMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isScreenSharingOnChanged", PropertyChangedEvent)

De functie Abonneren voor de gebeurtenis isScreenSharingChanged.

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

Parameters

event

"isScreenSharingOnChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Abonneer de functie voor de gebeurtenis localAudioStreamsUpdated.

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

Parameters

event

"localAudioStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Abonneer de functie voor de gebeurtenis localVideoStreamsUpdated.

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

Parameters

event

"localVideoStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.

on("mutedByOthers", PropertyChangedEvent)

Abonneer de functie voor de gebeurtenis mutedByOthers.

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

Parameters

event

"mutedByOthers"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Abonneer de functie voor de remoteAudioStreamsUpdated-gebeurtenis.

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

Parameters

event

"remoteAudioStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Abonneer de functie voor de gebeurtenis remoteParticipantsUpdated.

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

Parameters

event

"remoteParticipantsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.

on("roleChanged", PropertyChangedEvent)

Abonneer de functie voor roleChanged-gebeurtenis.

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

Parameters

event

"roleChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("stateChanged", PropertyChangedEvent)

Abonneer de functie voor stateChanged-gebeurtenis.

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

Parameters

event

"stateChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("totalParticipantCountChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Abonneer de functie voor de gebeurtenis totalParticipantCountChanged.

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

Parameters

event

"totalParticipantCountChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de deelnemer telt.

on("transferorInfoChanged", PropertyChangedEvent)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Abonneerfunctie voor gewijzigde gebeurtenis van bellergegevens.

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

Parameters

event

"transferorInfoChanged"

listener

PropertyChangedEvent

resume()

Hervat deze oproep als deze de status LocalHold heeft.

function resume(): Promise<void>

Retouren

Promise<void>

sendDtmf(DtmfTone)

DTMF-toon verzenden.

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

Parameters

dtmfTone

DtmfTone

Retouren

Promise<void>

setConstraints(CallConstraints)

Oproepbeperkingen instellen. Met deze methode worden de maximumbeperkingen ingesteld op basis van de opgegeven waarden. De uiteindelijke toegepaste beperkingen zijn kleiner dan of gelijk aan de waarden die hier voor deze methode worden opgegeven. Als er 0-waarde is opgegeven, wordt er geen beperking toegepast voor die beperking. Als er een niet-gedefinieerde waarde wordt opgegeven, wordt de vorige waarde gebruikt voor die beperking.

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

Parameters

constraints

CallConstraints

Object dat de aanroepbeperkingen vertegenwoordigt die moeten worden ingesteld

Retouren

Promise<void>

startAudio(LocalAudioStream)

Start audio in het gesprek met aangepaste audio. De LocalAudioStream-bron moet een MediaStream zijn.

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

Parameters

localAudioStream

LocalAudioStream

Retouren

Promise<void>

startScreenSharing()

• Begin met het verzenden van een stream voor het delen van het scherm in een gesprek. In de browser wordt gevraagd om het scherm, de app of het browsertabblad te selecteren.
• Het verzenden van een stream voor het delen van het scherm wordt niet ondersteund op iOS of Android.
• De stream voor het delen van binnenkomende schermen wordt ondersteund op iOS en Android.

function startScreenSharing(): Promise<void>

Retouren

Promise<void>

startScreenSharing(LocalVideoStream)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

• Begin met het verzenden van een stream voor het delen van onbewerkte schermen in een gesprek.
• Het verzenden van onbewerkt scherm delen wordt niet ondersteund op iOS of Android.
• Binnenkomende onbewerkte schermdeling wordt ondersteund op iOS en Android.

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

Parameters

localVideoStream

LocalVideoStream

Vertegenwoordigt een lokale stream voor het delen van onbewerkte schermen die een MediaStream in constructor gebruikt.

Retouren

Promise<void>

startVideo(LocalVideoStream)

Begin met het verzenden van een videostream in het gesprek. Externe deelnemers aan het gesprek ontvangen uw videostream, zodat ze deze in hun UIs kunnen weergeven.

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

Parameters

localVideoStream

LocalVideoStream

Vertegenwoordigt een lokale videostream die een camerabron in constructor gebruikt.

Retouren

Promise<void>

stopAudio()

Stop aangepaste audio in het gesprek en schakel over naar het standaardaudioapparaat van Apparaatbeheer.

function stopAudio()

stopScreenSharing()

Stop het delen van het lokale scherm.

function stopScreenSharing(): Promise<void>

Retouren

Promise<void>

stopScreenSharing(LocalVideoStream)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Stop het delen van het lokale scherm.

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

Parameters

localVideoStream

LocalVideoStream

De lokale stream voor het delen van het scherm om het streamen te stoppen.

Retouren

Promise<void>

stopVideo(LocalVideoStream)

Stop met het verzenden van een videostream in het gesprek. Moet hetzelfde LocalVideoStream-object doorgeven dat is gebruikt om video te starten in de CallAgent.startCall() API, CallAgent.join() API, IncomingCall.accept() API of Call.startVideo() API.

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

Parameters

localVideoStream

LocalVideoStream

De lokale videostream om het streamen te stoppen.

Retouren

Promise<void>

unmute()

Demping van lokale microfoon opheffen.

function unmute(): Promise<void>

Retouren

Promise<void>

unmuteIncomingAudio()

Het dempen van binnenkomende audio opheffen.

function unmuteIncomingAudio(): Promise<void>

Retouren

Promise<void>

Details overgenomen methode

dispose()

function dispose()

overgenomen vanDisposable.dispose