CallCommon interface

Csomag:

@azure/communication-calling

A Hívás közös felülete.

Extends

Disposable

Tulajdonságok

callEndReason	A hívás befejezését jelző kód/alkód.
callerInfo	Hívó adatai, ha ez a hívás bejövő.
direction	Kérje le a hívás irányát, legyen az bejövő vagy kimenő.
id	Kérje le a hívás egyedi azonosítóját.
isIncomingAudioMuted	Azt jelzi, hogy a helyi felhasználó elnémítja-e a bejövő hangot.
isLocalVideoStarted	A helyi videó be van-e kapcsolva.
isMuted	Azt jelzi, hogy a helyi felhasználó el van-e némítva, helyileg vagy távolról.
isScreenSharingOn	Be van-e kapcsolva a képernyőmegosztás.
kind	Kérje le a hívási objektum típusát.
lobby	Kérje le a Teams-értekezlet előszobát.
localAudioStreams	A hívás többi résztvevőjének küldött helyi hangstreamek gyűjteménye.
localVideoStreams	A hívás többi résztvevőjének küldött helyi videóstreamek gyűjteménye.
remoteAudioStreams	A hívásból fogadott távoli hangstreamek gyűjteménye.
remoteParticipants	A hívás távoli résztvevőinek gyűjteménye. Több száz vagy több résztvevővel folytatott hívások esetén ebben a gyűjteményben csak a média aktív résztvevői szerepelnek.
role	Kérje le a helyi felhasználó szerepkörét a Hívásban.
state	Kérje le a hívás állapotát.
totalParticipantCount	A hívás résztvevőinek teljes száma.
transferorInfo	Átviteli/továbbítási forgatókönyvek esetén az átvitel kezdeményezője.

Metódusok

feature<TFeature>(CallFeatureFactory<TFeature>)	Egy inicializált és emlékeztető funkcióobjektum lekérése kiterjesztett API-val. Tekintse meg a csomag összes elérhető kiterjesztett hívási funkcióját, például: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Tegye le a hívást.
hold()	A hívás várakoztatása.
mute()	Helyi mikrofon elnémítása.
muteAllRemoteParticipants()	Az összes távoli résztvevő elnémítása.
muteIncomingAudio()	Bejövő hang elnémítása.
off("callerInfoChanged", PropertyChangedEvent)	A hívó adatainak leiratkozási függvénye módosított esemény.
off("idChanged", PropertyChangedEvent)	Leiratkozás függvény az idChanged eseményhez.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Feliratkozás függvény az isIncomingAudioMutedChanged eseményhez.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Leiratkozás függvény az isLocalVideoStartedChanged eseményhez.
off("isMutedChanged", PropertyChangedEvent)	Feliratkozás függvény az isMutedChanged eseményhez.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Leiratkozás függvény az isScreenSharingChanged eseményhez.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Leiratkozás függvény a localAudioStreamsUpdated eseményhez.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Leiratkozás függvény a localVideoStreamsUpdated eseményhez.
off("mutedByOthers", PropertyChangedEvent)	Leiratkozás függvény a mutedByOthers eseményhez.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Leiratkozás függvény távoliAudioStreamsUpdated eseményhez.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Leiratkozás függvény remoteParticipantsUpdated eseményhez.
off("roleChanged", PropertyChangedEvent)	Leiratkozás függvény a roleChanged eseményhez.
off("stateChanged", PropertyChangedEvent)	Leiratkozás függvény stateChanged eseményhez.
off("totalParticipantCountChanged", PropertyChangedEvent)	leiratkozás függvény a totalParticipantCountChanged eseményhez.
off("transferorInfoChanged", PropertyChangedEvent)	A hívó adatainak leiratkozási függvénye módosított esemény.
on("callerInfoChanged", PropertyChangedEvent)	A hívó adatainak előfizetési függvénye megváltozott esemény.
on("idChanged", PropertyChangedEvent)	Előfizetés függvény az idChanged eseményhez.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Feliratkozás függvény az isIncomingAudioMutedChanged eseményhez.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Feliratkozás függvény az isLocalVideoStartedChanged eseményhez.
on("isMutedChanged", PropertyChangedEvent)	Feliratkozás függvény az isMutedChanged eseményhez.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Feliratkozás függvény az isScreenSharingChanged eseményhez.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Feliratkozás függvény a localAudioStreamsUpdated eseményhez.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Feliratkozás függvény a localVideoStreamsUpdated eseményhez.
on("mutedByOthers", PropertyChangedEvent)	Feliratkozás függvény a mutedByOthers eseményhez.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Feliratkozás függvény távoliAudioStreamsUpdated eseményhez.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Feliratkozás függvény a remoteParticipantsUpdated eseményhez.
on("roleChanged", PropertyChangedEvent)	Feliratkozás függvény a roleChanged eseményhez.
on("stateChanged", PropertyChangedEvent)	Előfizetés függvény a stateChanged eseményhez.
on("totalParticipantCountChanged", PropertyChangedEvent)	Subscribe függvény totalParticipantCountChanged eseményhez.
on("transferorInfoChanged", PropertyChangedEvent)	A hívó adatainak előfizetési függvénye megváltozott esemény.
resume()	Folytassa ezt a hívást, ha "LocalHold" állapotban van.
sendDtmf(DtmfTone)	DTMF-hangnem küldése.
setConstraints(CallConstraints)	Híváskorlátozások beállítása. Ez a metódus a megadott értékek alapján állítja be a maximális korlátozásokat. A végső alkalmazott kényszerek kisebbek vagy egyenlők lesznek a metódushoz itt megadott értékekkel. Ha 0 értéket ad meg, akkor a rendszer nem alkalmaz kényszert erre a kényszerre. Ha nem definiált értéket ad meg, akkor a rendszer az előző használt értéket használja a kényszerhez.
startAudio(LocalAudioStream)	Hang indítása a hívásban egyéni hanggal. A LocalAudioStream forrásának MediaStreamnek kell lennie.
startScreenSharing()	Indítsa el a képernyőmegosztási stream küldését egy hívásban. A böngésző a képernyő, az alkalmazás vagy a böngészőlap kiválasztását kéri. A képernyőmegosztási stream küldése nem támogatott iOS-en és Androidon sem. A bejövő képernyőmegosztási stream iOS és Android rendszeren is támogatott.
startScreenSharing(LocalVideoStream)	Kezdjen el nyers képernyőmegosztási streamet küldeni egy hívásban. A nyers képernyőmegosztás küldése nem támogatott iOS és Android rendszeren sem. A bejövő nyers képernyőmegosztás iOS és Android rendszeren is támogatott.
startVideo(LocalVideoStream)	Indítsa el a videostream küldését a hívásban. A hívás távoli résztvevői megkapják a videostreamet, hogy megjeleníthessék a felhasználói felületükön.
stopAudio()	Állítsa le az egyéni hangot a hívásban, és váltson az Eszközkezelő alapértelmezett hangeszközére.
stopScreenSharing()	A helyi képernyőmegosztás leállítása.
stopScreenSharing(LocalVideoStream)	A helyi képernyőmegosztás leállítása.
stopVideo(LocalVideoStream)	Ne küldjön videostreamet a hívásban. A CallAgent.startCall() API, a CallAgent.join() API, a IncomingCall.accept() API vagy a Call.startVideo() API videó indításához használt LocalVideoStream objektumot kell átadnia.
unmute()	A helyi mikrofon visszahangosítása.
unmuteIncomingAudio()	A bejövő hang visszahangosítása.

Örökölt metódusok

dispose()

Tulajdonság adatai

callEndReason

A hívás befejezését jelző kód/alkód.

callEndReason?: CallEndReason

Tulajdonság értéke

CallEndReason

callerInfo

Hívó adatai, ha ez a hívás bejövő.

callerInfo: CallerInfo

Tulajdonság értéke

CallerInfo

direction

Kérje le a hívás irányát, legyen az bejövő vagy kimenő.

direction: CallDirection

Tulajdonság értéke

CallDirection

id

Kérje le a hívás egyedi azonosítóját.

id: string

Tulajdonság értéke

string

isIncomingAudioMuted

Azt jelzi, hogy a helyi felhasználó elnémítja-e a bejövő hangot.

isIncomingAudioMuted: boolean

Tulajdonság értéke

boolean

isLocalVideoStarted

A helyi videó be van-e kapcsolva.

isLocalVideoStarted: boolean

Tulajdonság értéke

boolean

isMuted

Azt jelzi, hogy a helyi felhasználó el van-e némítva, helyileg vagy távolról.

isMuted: boolean

Tulajdonság értéke

boolean

isScreenSharingOn

Be van-e kapcsolva a képernyőmegosztás.

isScreenSharingOn: boolean

Tulajdonság értéke

boolean

kind

Kérje le a hívási objektum típusát.

kind: CallKind

Tulajdonság értéke

CallKind

lobby

Kérje le a Teams-értekezlet előszobát.

lobby: Lobby

Tulajdonság értéke

Lobby

localAudioStreams

A hívás többi résztvevőjének küldött helyi hangstreamek gyűjteménye.

localAudioStreams: readonly LocalAudioStream[]

Tulajdonság értéke

readonly LocalAudioStream[]

localVideoStreams

A hívás többi résztvevőjének küldött helyi videóstreamek gyűjteménye.

localVideoStreams: readonly LocalVideoStream[]

Tulajdonság értéke

readonly LocalVideoStream[]

remoteAudioStreams

A hívásból fogadott távoli hangstreamek gyűjteménye.

remoteAudioStreams: readonly RemoteAudioStream[]

Tulajdonság értéke

readonly RemoteAudioStream[]

remoteParticipants

A hívás távoli résztvevőinek gyűjteménye. Több száz vagy több résztvevővel folytatott hívások esetén ebben a gyűjteményben csak a média aktív résztvevői szerepelnek.

remoteParticipants: readonly RemoteParticipant[]

Tulajdonság értéke

readonly RemoteParticipant[]

role

Kérje le a helyi felhasználó szerepkörét a Hívásban.

role: ParticipantRole

Tulajdonság értéke

ParticipantRole

state

Kérje le a hívás állapotát.

state: CallState

Tulajdonság értéke

CallState

totalParticipantCount

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A hívás résztvevőinek teljes száma.

totalParticipantCount: number

Tulajdonság értéke

number

transferorInfo

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

Átviteli/továbbítási forgatókönyvek esetén az átvitel kezdeményezője.

transferorInfo?: CallerInfo

Tulajdonság értéke

CallerInfo

Metódus adatai

feature<TFeature>(CallFeatureFactory<TFeature>)

Egy inicializált és emlékeztető funkcióobjektum lekérése kiterjesztett API-val. Tekintse meg a csomag összes elérhető kiterjesztett hívási funkcióját, például:

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

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

Paraméterek

factory

CallFeatureFactory<TFeature>

A kiterjesztett API-t biztosító hívási funkció konstruktorának gyára.

Válaszok

TFeature

hangUp(HangUpOptions)

Tegye le a hívást.

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

Paraméterek

options

HangUpOptions

Lefagyás beállításai.

Válaszok

Promise<void>

hold()

A hívás várakoztatása.

function hold(): Promise<void>

Válaszok

Promise<void>

mute()

Helyi mikrofon elnémítása.

function mute(): Promise<void>

Válaszok

Promise<void>

muteAllRemoteParticipants()

Az összes távoli résztvevő elnémítása.

function muteAllRemoteParticipants(): Promise<void>

Válaszok

Promise<void>

muteIncomingAudio()

Bejövő hang elnémítása.

function muteIncomingAudio(): Promise<void>

Válaszok

Promise<void>

off("callerInfoChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A hívó adatainak leiratkozási függvénye módosított esemény.

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

Paraméterek

event

"callerInfoChanged"

listener

PropertyChangedEvent

off("idChanged", PropertyChangedEvent)

Leiratkozás függvény az idChanged eseményhez.

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

Paraméterek

event

"idChanged"

esemény neve.

listener

PropertyChangedEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Feliratkozás függvény az isIncomingAudioMutedChanged eseményhez.

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

Paraméterek

event

"isIncomingAudioMutedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Leiratkozás függvény az isLocalVideoStartedChanged eseményhez.

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

Paraméterek

event

"isLocalVideoStartedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

off("isMutedChanged", PropertyChangedEvent)

Feliratkozás függvény az isMutedChanged eseményhez.

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

Paraméterek

event

"isMutedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

off("isScreenSharingOnChanged", PropertyChangedEvent)

Leiratkozás függvény az isScreenSharingChanged eseményhez.

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

Paraméterek

event

"isScreenSharingOnChanged"

esemény neve.

listener

PropertyChangedEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Leiratkozás függvény a localAudioStreamsUpdated eseményhez.

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

Paraméterek

event

"localAudioStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<LocalAudioStream>

az eseményre való feliratkozáshoz használt visszahívási fn.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Leiratkozás függvény a localVideoStreamsUpdated eseményhez.

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

Paraméterek

event

"localVideoStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<LocalVideoStream>

az eseményre való feliratkozáshoz használt visszahívási fn.

off("mutedByOthers", PropertyChangedEvent)

Leiratkozás függvény a mutedByOthers eseményhez.

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

Paraméterek

event

"mutedByOthers"

esemény neve.

listener

PropertyChangedEvent

az eseményre való leiratkozáshoz használt visszahívási fn.

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Leiratkozás függvény távoliAudioStreamsUpdated eseményhez.

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

Paraméterek

event

"remoteAudioStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<RemoteAudioStream>

az eseményre való feliratkozáshoz használt visszahívási fn.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Leiratkozás függvény remoteParticipantsUpdated eseményhez.

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

Paraméterek

event

"remoteParticipantsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<RemoteParticipant>

az eseményre való feliratkozáshoz használt visszahívási fn.

off("roleChanged", PropertyChangedEvent)

Leiratkozás függvény a roleChanged eseményhez.

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

Paraméterek

event

"roleChanged"

esemény neve.

listener

PropertyChangedEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

off("stateChanged", PropertyChangedEvent)

Leiratkozás függvény stateChanged eseményhez.

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

Paraméterek

event

"stateChanged"

esemény neve.

listener

PropertyChangedEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

off("totalParticipantCountChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

leiratkozás függvény a totalParticipantCountChanged eseményhez.

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

Paraméterek

event

"totalParticipantCountChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor a résztvevők száma megváltozik.

off("transferorInfoChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A hívó adatainak leiratkozási függvénye módosított esemény.

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

Paraméterek

event

"transferorInfoChanged"

listener

PropertyChangedEvent

on("callerInfoChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A hívó adatainak előfizetési függvénye megváltozott esemény.

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

Paraméterek

event

"callerInfoChanged"

listener

PropertyChangedEvent

on("idChanged", PropertyChangedEvent)

Előfizetés függvény az idChanged eseményhez.

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

Paraméterek

event

"idChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Feliratkozás függvény az isIncomingAudioMutedChanged eseményhez.

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

Paraméterek

event

"isIncomingAudioMutedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Feliratkozás függvény az isLocalVideoStartedChanged eseményhez.

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

Paraméterek

event

"isLocalVideoStartedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("isMutedChanged", PropertyChangedEvent)

Feliratkozás függvény az isMutedChanged eseményhez.

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

Paraméterek

event

"isMutedChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("isScreenSharingOnChanged", PropertyChangedEvent)

Feliratkozás függvény az isScreenSharingChanged eseményhez.

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

Paraméterek

event

"isScreenSharingOnChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Feliratkozás függvény a localAudioStreamsUpdated eseményhez.

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

Paraméterek

event

"localAudioStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<LocalAudioStream>

a gyűjtemény módosításakor meghívandó visszahívási fn a hozzáadott és eltávolított elemek tömbjeinek lesz átadva.

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Feliratkozás függvény a localVideoStreamsUpdated eseményhez.

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

Paraméterek

event

"localVideoStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<LocalVideoStream>

a gyűjtemény módosításakor meghívandó visszahívási fn a hozzáadott és eltávolított elemek tömbjeinek lesz átadva.

on("mutedByOthers", PropertyChangedEvent)

Feliratkozás függvény a mutedByOthers eseményhez.

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

Paraméterek

event

"mutedByOthers"

esemény neve.

listener

PropertyChangedEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Feliratkozás függvény távoliAudioStreamsUpdated eseményhez.

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

Paraméterek

event

"remoteAudioStreamsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<RemoteAudioStream>

a gyűjtemény módosításakor meghívandó visszahívási fn a hozzáadott és eltávolított elemek tömbjeinek lesz átadva.

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Feliratkozás függvény a remoteParticipantsUpdated eseményhez.

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

Paraméterek

event

"remoteParticipantsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<RemoteParticipant>

a gyűjtemény módosításakor meghívandó visszahívási fn a hozzáadott és eltávolított elemek tömbjeinek lesz átadva.

on("roleChanged", PropertyChangedEvent)

Feliratkozás függvény a roleChanged eseményhez.

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

Paraméterek

event

"roleChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("stateChanged", PropertyChangedEvent)

Előfizetés függvény a stateChanged eseményhez.

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

Paraméterek

event

"stateChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("totalParticipantCountChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

Subscribe függvény totalParticipantCountChanged eseményhez.

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

Paraméterek

event

"totalParticipantCountChanged"

esemény neve.

listener

PropertyChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor a résztvevők száma megváltozik.

on("transferorInfoChanged", PropertyChangedEvent)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A hívó adatainak előfizetési függvénye megváltozott esemény.

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

Paraméterek

event

"transferorInfoChanged"

listener

PropertyChangedEvent

resume()

Folytassa ezt a hívást, ha "LocalHold" állapotban van.

function resume(): Promise<void>

Válaszok

Promise<void>

sendDtmf(DtmfTone)

DTMF-hangnem küldése.

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

Paraméterek

dtmfTone

DtmfTone

Válaszok

Promise<void>

setConstraints(CallConstraints)

Híváskorlátozások beállítása. Ez a metódus a megadott értékek alapján állítja be a maximális korlátozásokat. A végső alkalmazott kényszerek kisebbek vagy egyenlők lesznek a metódushoz itt megadott értékekkel. Ha 0 értéket ad meg, akkor a rendszer nem alkalmaz kényszert erre a kényszerre. Ha nem definiált értéket ad meg, akkor a rendszer az előző használt értéket használja a kényszerhez.

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

Paraméterek

constraints

CallConstraints

A beállítandó hívási korlátozásokat képviselő objektum

Válaszok

Promise<void>

startAudio(LocalAudioStream)

Hang indítása a hívásban egyéni hanggal. A LocalAudioStream forrásának MediaStreamnek kell lennie.

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

Paraméterek

localAudioStream

LocalAudioStream

Válaszok

Promise<void>

startScreenSharing()

• Indítsa el a képernyőmegosztási stream küldését egy hívásban. A böngésző a képernyő, az alkalmazás vagy a böngészőlap kiválasztását kéri.
• A képernyőmegosztási stream küldése nem támogatott iOS-en és Androidon sem.
• A bejövő képernyőmegosztási stream iOS és Android rendszeren is támogatott.

function startScreenSharing(): Promise<void>

Válaszok

Promise<void>

startScreenSharing(LocalVideoStream)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

• Kezdjen el nyers képernyőmegosztási streamet küldeni egy hívásban.
• A nyers képernyőmegosztás küldése nem támogatott iOS és Android rendszeren sem.
• A bejövő nyers képernyőmegosztás iOS és Android rendszeren is támogatott.

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

Paraméterek

localVideoStream

LocalVideoStream

Egy helyi nyers képernyőmegosztási streamet jelöl, amely egy MediaStreamet vesz igénybe a konstruktorban.

Válaszok

Promise<void>

startVideo(LocalVideoStream)

Indítsa el a videostream küldését a hívásban. A hívás távoli résztvevői megkapják a videostreamet, hogy megjeleníthessék a felhasználói felületükön.

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

Paraméterek

localVideoStream

LocalVideoStream

Egy helyi videostreamet jelöl, amely kamerát használ a konstruktorban.

Válaszok

Promise<void>

stopAudio()

Állítsa le az egyéni hangot a hívásban, és váltson az Eszközkezelő alapértelmezett hangeszközére.

function stopAudio()

stopScreenSharing()

A helyi képernyőmegosztás leállítása.

function stopScreenSharing(): Promise<void>

Válaszok

Promise<void>

stopScreenSharing(LocalVideoStream)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

A helyi képernyőmegosztás leállítása.

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

Paraméterek

localVideoStream

LocalVideoStream

A streamelés leállításához használja a helyi képernyőmegosztási streamet.

Válaszok

Promise<void>

stopVideo(LocalVideoStream)

Ne küldjön videostreamet a hívásban. A CallAgent.startCall() API, a CallAgent.join() API, a IncomingCall.accept() API vagy a Call.startVideo() API videó indításához használt LocalVideoStream objektumot kell átadnia.

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

Paraméterek

localVideoStream

LocalVideoStream

A helyi videóstream a streamelés leállításához.

Válaszok

Promise<void>

unmute()

A helyi mikrofon visszahangosítása.

function unmute(): Promise<void>

Válaszok

Promise<void>

unmuteIncomingAudio()

A bejövő hang visszahangosítása.

function unmuteIncomingAudio(): Promise<void>

Válaszok

Promise<void>

Örökölt metódus részletei

dispose()

function dispose()

Eldobható.megsemmisítő