Megosztás a következőn keresztül:

StatefulCallClient interface

Csomag:
@azure/communication-react

Meghatározza azokat a metódusokat, amelyek lehetővé teszik a CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> állapotalapú használatát. A felület hozzáférést biztosít a proxyzott állapothoz, és lehetővé teszi egy kezelő regisztrálását az állapotváltozási eseményekhez. Az állapotdefinícióért lásd: CallClientState.

Az állapotváltozási eseményeket a következők vezérlik:

  • <xref:%40azure%2Fcommunication-calling%23DeviceManager> API-kból visszaadott adatok.
  • <xref:%40azure%2Fcommunication-calling%23CallAgent> API-kból visszaadott adatok.
  • A figyelők automatikusan csatlakoznak a különböző azure-beli kommunikációs hívó objektumokhoz:
    • CallAgent 'bejövő hívás'
    • CallAgent "callsUpdated"
    • DeviceManager "videoDevicesUpdated"
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager "selectedMicrophoneChanged"
    • DeviceManager "selectedSpeakerChanged"
    • "stateChanged" hívása
    • Az "idChanged" hívása
    • "isMutedChanged" hívása
    • Az "isScreenSharingOnChanged" hívása
    • A "remoteParticipantsUpdated" meghívása
    • A "localVideoStreamsUpdated" meghívása
    • IncomingCall "callEnded"
    • RemoteParticipant "stateChanged"
    • RemoteParticipant "isMutedChanged"
    • RemoteParticipant "displayNameChanged"
    • RemoteParticipant "isSpeakingChanged"
    • RemoteParticipant "videoStreamsUpdated"
    • RemoteVideoStream "isAvailableChanged"
    • TranscriptionCallFeature "isTranscriptionActiveChanged"
    • RecordingCallFeature "isRecordingActiveChanged"
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'felemeltHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature "reakció"
Extends
CallClient

Metódusok

createCallAgent([tokenCredential, options])

A CallAgent a hívások kezelésére szolgál. A CallAgent létrehozásához adjon át egy, az SDK-ból biztosított CommunicationTokenCredential objektumot.

  • A CallClient egyszerre csak egy aktív CallAgent-példánysal rendelkezhet.
  • Létrehozhat egy új CallClient-példányt egy új CallAgent létrehozásához.
  • A CallClient aktuális aktív CallAgentjét törölheti, és újra meghívhatja a CallClient createCallAgent() metódusát egy új CallAgent létrehozásához.
createTeamsCallAgent([tokenCredential, options])

A TeamsCallAgent a hívások kezelésére szolgál. A TeamsCallAgent létrehozásához adja át az SDK-ból biztosított CommunicationTokenCredential objektumot.

  • A CallClient egyszerre csak egy aktív TeamsCallAgent-példánysal rendelkezhet.
  • Létrehozhat egy új CallClient-példányt egy új TeamsCallAgent létrehozásához.
  • A CallClient aktuális aktív TeamsCallAgent metódusát törölheti, és újra meghívhatja a CallClient createTeamsCallAgent() metódusát egy új TeamsCallAgent létrehozásához.
createView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, CreateViewOptions)

Renderel egy RemoteVideoStreamState vagy LocalVideoStreamState, és az eredményül kapott VideoStreamRendererViewState tárolja a megfelelő RemoteVideoStreamState vagy LocalVideoStreamState vagy nem kiosztott nézet alatt. A motorháztető alatt hívja <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

1. forgatókönyv: RemoteVideoStreamState renderelése

  • CallId szükséges, résztvevőazonosító szükséges, és RemoteVideoStreamState típusú streamre van szükség
  • Az eredményül kapott VideoStreamRendererViewState a CallClientState adott callId és participantId azonosítójában található.

2. forgatókönyv: LocalVideoStreamState renderelése híváshoz

  • A CallId megadása kötelező, a résztvevőazonosítónak nem definiáltnak kell lennie, és a LocalVideoStreamState típusú streamre van szükség.

  • A <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> már el kell kezdeni a <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Az eredményül kapott VideoStreamRendererViewState az adott callId localVideoStreams tárolja CallClientState.

  • 2. forgatókönyv: A LocalVideoStreamState renderelése nem része a hívásnak (például a helyi előzetes verzióhoz készült kamera renderelése)

  • A CallId-nek nem definiáltnak kell lennie, a participantId azonosítónak nincs definiálva, és LocalVideoStreamState típusú streamre van szükség.

  • Az eredményül kapott VideoStreamRendererViewState az adott LocalVideoStreamState alatt található a <xref:CallClientState.deviceManager.unparentedViews>
disposeView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Leállítja a RemoteVideoStreamState vagy LocalVideoStreamState megjelenítését, és eltávolítja a <xref:VideoStreamRendererView> a RemoteVideoStreamStateCallClientState vagy <xref:LocalVideoStream>CallClientState vagy a megfelelő <xref:CallClientState.deviceManager.unparentedViews> A motorháztető alatti hívások <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

Fontos, hogy a DisposeView-t az erőforrások megfelelő megtisztítása érdekében távolítsa el.

1. forgatókönyv: RemoteVideoStreamState megsemmisítése

  • CallId szükséges, résztvevőazonosító szükséges, és RemoteVideoStreamState típusú streamre van szükség

2. forgatókönyv: A LocalVideoStreamState törlése híváshoz

  • A CallId megadása kötelező, a résztvevőazonosítónak nem definiáltnak kell lennie, és a LocalVideoStreamState típusú streamre van szükség.

  • 2. forgatókönyv: A LocalVideoStreamState elvetése nem része a hívásnak

  • A CallId-nek nem definiáltnak kell lennie, a participantId azonosítónak nincs definiálva, és LocalVideoStreamState típusú streamre van szükség.

  • A LocalVideoStreamState-nek a createView számára átadott eredetinek kell lennie.
getState()

A CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> által a CallClientState CallClientState.
offStateChange((state: CallClientState) => void)

Engedélyezi a "stateChanged" események regisztrációjának megszüntetését.
onStateChange((state: CallClientState) => void)

Lehetővé teszi, hogy egy kezelő regisztrálva legyen a "stateChanged" eseményekhez.

Örökölt metódusok

dispose()

Megsemmisíti ezt a CallClient-et, amely a társított eszközkezelőt és a társított hívásügynököt is megsemmisíti.
feature<TFeature>(CallClientFeatureFactory<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 ügyfélfunkcióját a Szolgáltatások objektumban.*
getDeviceManager()

A DeviceManager médiaeszközök, például kamerák, mikrofonok és hangszórók kezelésére szolgál.

Metódus adatai

createCallAgent([tokenCredential, options])

A CallAgent a hívások kezelésére szolgál. A CallAgent létrehozásához adjon át egy, az SDK-ból biztosított CommunicationTokenCredential objektumot.

  • A CallClient egyszerre csak egy aktív CallAgent-példánysal rendelkezhet.
  • Létrehozhat egy új CallClient-példányt egy új CallAgent létrehozásához.
  • A CallClient aktuális aktív CallAgentjét törölheti, és újra meghívhatja a CallClient createCallAgent() metódusát egy új CallAgent létrehozásához.
function createCallAgent(args: [tokenCredential, options]): Promise<DeclarativeCallAgent>

Paraméterek

args

[tokenCredential, options]

Válaszok

Promise<DeclarativeCallAgent>

createTeamsCallAgent([tokenCredential, options])

A TeamsCallAgent a hívások kezelésére szolgál. A TeamsCallAgent létrehozásához adja át az SDK-ból biztosított CommunicationTokenCredential objektumot.

  • A CallClient egyszerre csak egy aktív TeamsCallAgent-példánysal rendelkezhet.
  • Létrehozhat egy új CallClient-példányt egy új TeamsCallAgent létrehozásához.
  • A CallClient aktuális aktív TeamsCallAgent metódusát törölheti, és újra meghívhatja a CallClient createTeamsCallAgent() metódusát egy új TeamsCallAgent létrehozásához.
function createTeamsCallAgent(args: [tokenCredential, options]): Promise<DeclarativeTeamsCallAgent>

Paraméterek

args

[tokenCredential, options]

Válaszok

Promise<DeclarativeTeamsCallAgent>

createView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, CreateViewOptions)

Renderel egy RemoteVideoStreamState vagy LocalVideoStreamState, és az eredményül kapott VideoStreamRendererViewState tárolja a megfelelő RemoteVideoStreamState vagy LocalVideoStreamState vagy nem kiosztott nézet alatt. A motorháztető alatt hívja <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

1. forgatókönyv: RemoteVideoStreamState renderelése

  • CallId szükséges, résztvevőazonosító szükséges, és RemoteVideoStreamState típusú streamre van szükség
  • Az eredményül kapott VideoStreamRendererViewState a CallClientState adott callId és participantId azonosítójában található.

2. forgatókönyv: LocalVideoStreamState renderelése híváshoz

  • A CallId megadása kötelező, a résztvevőazonosítónak nem definiáltnak kell lennie, és a LocalVideoStreamState típusú streamre van szükség.

  • A <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> már el kell kezdeni a <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Az eredményül kapott VideoStreamRendererViewState az adott callId localVideoStreams tárolja CallClientState.

  • 2. forgatókönyv: A LocalVideoStreamState renderelése nem része a hívásnak (például a helyi előzetes verzióhoz készült kamera renderelése)

  • A CallId-nek nem definiáltnak kell lennie, a participantId azonosítónak nincs definiálva, és LocalVideoStreamState típusú streamre van szükség.

  • Az eredményül kapott VideoStreamRendererViewState az adott LocalVideoStreamState alatt található a <xref:CallClientState.deviceManager.unparentedViews>

function createView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, options?: CreateViewOptions): Promise<undefined | CreateViewResult>

Paraméterek

callId

undefined | string

Az adott stream CallId azonosítója. Nem definiálható, ha a stream nem része egyetlen hívásnak sem.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> az adott RemoteVideoStreamState-hez társítva. A LocalVideoStreamState renderelése nem definiálható.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

A LocalVideoStreamState vagy a RemoteVideoStreamState a renderelés megkezdéséhez.

options
CreateViewOptions

A <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer>átadott beállítások.

Válaszok

Promise<undefined | CreateViewResult>

disposeView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Leállítja a RemoteVideoStreamState vagy LocalVideoStreamState megjelenítését, és eltávolítja a <xref:VideoStreamRendererView> a RemoteVideoStreamStateCallClientState vagy <xref:LocalVideoStream>CallClientState vagy a megfelelő <xref:CallClientState.deviceManager.unparentedViews> A motorháztető alatti hívások <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

Fontos, hogy a DisposeView-t az erőforrások megfelelő megtisztítása érdekében távolítsa el.

1. forgatókönyv: RemoteVideoStreamState megsemmisítése

  • CallId szükséges, résztvevőazonosító szükséges, és RemoteVideoStreamState típusú streamre van szükség

2. forgatókönyv: A LocalVideoStreamState törlése híváshoz

  • A CallId megadása kötelező, a résztvevőazonosítónak nem definiáltnak kell lennie, és a LocalVideoStreamState típusú streamre van szükség.

  • 2. forgatókönyv: A LocalVideoStreamState elvetése nem része a hívásnak

  • A CallId-nek nem definiáltnak kell lennie, a participantId azonosítónak nincs definiálva, és LocalVideoStreamState típusú streamre van szükség.

  • A LocalVideoStreamState-nek a createView számára átadott eredetinek kell lennie.

function disposeView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Paraméterek

callId

undefined | string

Az adott stream CallId azonosítója. Nem definiálható, ha a stream nem része egyetlen hívásnak sem.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> az adott RemoteVideoStreamState-hez társítva. A LocalVideoStreamState letiltása esetén nem lehet definiálni.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

A LocalVideoStreamState vagy a RemoteVideoStreamState megsemmisítendő.

getState()

A CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> által a CallClientState CallClientState.

function getState(): CallClientState

Válaszok

CallClientState

offStateChange((state: CallClientState) => void)

Engedélyezi a "stateChanged" események regisztrációjának megszüntetését.

function offStateChange(handler: (state: CallClientState) => void)

Paraméterek

handler

(state: CallClientState) => void

Az eredeti visszahívás leiratkozáshoz.

onStateChange((state: CallClientState) => void)

Lehetővé teszi, hogy egy kezelő regisztrálva legyen a "stateChanged" eseményekhez.

function onStateChange(handler: (state: CallClientState) => void)

Paraméterek

handler

(state: CallClientState) => void

Visszahívás az állapot fogadásához.

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

dispose()

Megsemmisíti ezt a CallClient-et, amely a társított eszközkezelőt és a társított hívásügynököt is megsemmisíti.

function dispose(): Promise<void>

Válaszok

Promise<void>

Örökölt CallClient.dispose

feature<TFeature>(CallClientFeatureFactory<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 ügyfélfunkcióját a Szolgáltatások objektumban.*

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

Paraméterek

factory

CallClientFeatureFactory<TFeature>

A hívásügyfél szolgáltatáskonstruktorának gyára, amely kiterjesztett API-t biztosít.

Válaszok

TFeature

Örökölt CallClient.feature

getDeviceManager()

A DeviceManager médiaeszközök, például kamerák, mikrofonok és hangszórók kezelésére szolgál.

function getDeviceManager(): Promise<DeviceManager>

Válaszok

Promise<DeviceManager>

Örökölt CallClient.getDeviceManager