Sdílet prostřednictvím

StatefulCallClient interface

Balíček:
@azure/communication-react

Definuje metody, které umožňují použití <xref:%40azure%2Fcommunication-calling%23CallClient> CallClient stavově. Rozhraní poskytuje přístup kxied stavu a také umožňuje registraci obslužné rutiny pro události změny stavu. Definice stavu naleznete v tématu CallClientState.

Události změny stavu jsou řízeny:

  • Vrácená data z rozhraní API <xref:%40azure%2Fcommunication-calling%23DeviceManager>
  • Vrácená data z rozhraní API <xref:%40azure%2Fcommunication-calling%23CallAgent>
  • Naslouchací procesy se automaticky připojují k různým objektům volání komunikace Azure:
    • CallAgent 'příchozí hovor'
    • CallAgent callsUpdated
    • Správce zařízení 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesAktualizováno
    • DeviceManager selectedMicrophoneChanged
    • DeviceManager selectedSpeakerChanged
    • Volání stateChanged
    • Volání idChanged
    • Volání isMutedChanged
    • Volání isScreenSharingOnChanged
    • Volání remoteParticipantsUpdated
    • Volání localVideoStreamsUpdated
    • IncomingCall callEnded
    • RemoteParticipant stateChanged
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant displayNameChanged
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream isAvailableChanged
    • PřepisCallFeature 'isTranscriptionActiveChanged'
    • Funkce RecordingCallFeature "isRecordingActiveChanged"
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raisedHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature 'reakce'
Extends
CallClient

Metody

createCallAgent([tokenCredential, options])

CallAgent se používá ke zpracování volání. Pokud chcete vytvořit CallAgent, předejte objekt CommunicationTokenCredential poskytnutý ze sady SDK.

  • CallClient může mít současně pouze jednu aktivní instanci CallAgent.
  • Můžete vytvořit novou instanci CallClient pro vytvoření nového CallAgent.
  • Můžete zlikvidovat aktuální aktivní CallAgent CallClient a znovu volat CallClient createCallAgent() metoda vytvořit nový CallAgent.
createTeamsCallAgent([tokenCredential, options])

TeamsCallAgent se používá ke zpracování volání. Chcete-li vytvořit TeamsCallAgent, předejte CommunicationTokenCredential objekt poskytnutý ze sady SDK.

  • CallClient může mít současně pouze jednu aktivní instanci TeamsCallAgent.
  • Můžete vytvořit novou instanci CallClient, která vytvoří novou instanci TeamsCallAgent.
  • Můžete zlikvidovat aktuální aktivní TeamsCallAgent CallClient a znovu volat metodu CreateTeamsCallAgent() CallClient a vytvořit nový TeamsCallAgent.
createView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, CreateViewOptions)

Vykreslí RemoteVideoStreamState nebo LocalVideoStreamState a uloží výsledné VideoStreamRendererViewState v příslušném RemoteVideoStreamState nebo LocalVideoStreamState nebo jako neparentované zobrazení ve stavu. Pod kapotou volá <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

Scénář 1: Vykreslení remoteVideoStreamState

  • CallId je povinné, id účastníka je povinné a vyžaduje se datový proud typu RemoteVideoStreamState.
  • Výsledná VideoStreamRendererViewState je uložena v daném id volání a id účastníka v CallClientState

Scénář 2: Vykreslení LocalVideoStreamState pro volání

  • CallId je povinné, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> již musí být spuštěn pomocí <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Výsledná VideoStreamRendererViewState je uložena v daném callId localVideoStreams v CallClientState.

  • Scénář 2: Vykreslení LocalVideoStreamState není součástí volání (například vykreslovací kamera pro místní náhled)

  • CallId musí být nedefinováno, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • Výsledná VideoStreamRendererViewState je uložena v rámci daného LocalVideoStreamState v <xref:CallClientState.deviceManager.unparentedViews>
disposeView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Zastaví vykreslení RemoteVideoStreamState nebo LocalVideoStreamState a odebere <xref:VideoStreamRendererView> z příslušného RemoteVideoStreamState v CallClientState nebo <xref:LocalVideoStream> v CallClientState nebo příslušné <xref:CallClientState.deviceManager.unparentedViews> Pod voláními <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

Jeho důležité pro disposeView k vyčištění prostředků správně.

Scénář 1: Dispose RemoteVideoStreamState

  • CallId je povinné, id účastníka je povinné a vyžaduje se datový proud typu RemoteVideoStreamState.

Scénář 2: Dispose LocalVideoStreamState pro volání

  • CallId je povinné, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • Scénář 2: Dispose LocalVideoStreamState není součástí volání

  • CallId musí být nedefinováno, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • LocalVideoStreamState musí být původní předaný createView.
getState()

Uchovává všechny stavy, které bychom mohli proxy z CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> jako CallClientState CallClientState.
offStateChange((state: CallClientState) => void)

Povoluje zrušení registrace událostí stateChanged.
onStateChange((state: CallClientState) => void)

Umožňuje registraci obslužné rutiny pro události stateChanged.

Zděděné metody

dispose()

Likviduje tohoto CallClient, který také likviduje přidruženého správce zařízení a přidruženého agenta volání.
feature<TFeature>(CallClientFeatureFactory<TFeature>)

Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* Pro všechny dostupné funkce klienta rozšířeného volání v tomto balíčku.
getDeviceManager()

Správce zařízení slouží ke zpracování mediálních zařízení, jako jsou kamery, mikrofony a reproduktory.

Podrobnosti metody

createCallAgent([tokenCredential, options])

CallAgent se používá ke zpracování volání. Pokud chcete vytvořit CallAgent, předejte objekt CommunicationTokenCredential poskytnutý ze sady SDK.

  • CallClient může mít současně pouze jednu aktivní instanci CallAgent.
  • Můžete vytvořit novou instanci CallClient pro vytvoření nového CallAgent.
  • Můžete zlikvidovat aktuální aktivní CallAgent CallClient a znovu volat CallClient createCallAgent() metoda vytvořit nový CallAgent.
function createCallAgent(args: [tokenCredential, options]): Promise<DeclarativeCallAgent>

Parametry

args

[tokenCredential, options]

Návraty

Promise<DeclarativeCallAgent>

createTeamsCallAgent([tokenCredential, options])

TeamsCallAgent se používá ke zpracování volání. Chcete-li vytvořit TeamsCallAgent, předejte CommunicationTokenCredential objekt poskytnutý ze sady SDK.

  • CallClient může mít současně pouze jednu aktivní instanci TeamsCallAgent.
  • Můžete vytvořit novou instanci CallClient, která vytvoří novou instanci TeamsCallAgent.
  • Můžete zlikvidovat aktuální aktivní TeamsCallAgent CallClient a znovu volat metodu CreateTeamsCallAgent() CallClient a vytvořit nový TeamsCallAgent.
function createTeamsCallAgent(args: [tokenCredential, options]): Promise<DeclarativeTeamsCallAgent>

Parametry

args

[tokenCredential, options]

Návraty

Promise<DeclarativeTeamsCallAgent>

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

Vykreslí RemoteVideoStreamState nebo LocalVideoStreamState a uloží výsledné VideoStreamRendererViewState v příslušném RemoteVideoStreamState nebo LocalVideoStreamState nebo jako neparentované zobrazení ve stavu. Pod kapotou volá <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

Scénář 1: Vykreslení remoteVideoStreamState

  • CallId je povinné, id účastníka je povinné a vyžaduje se datový proud typu RemoteVideoStreamState.
  • Výsledná VideoStreamRendererViewState je uložena v daném id volání a id účastníka v CallClientState

Scénář 2: Vykreslení LocalVideoStreamState pro volání

  • CallId je povinné, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> již musí být spuštěn pomocí <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Výsledná VideoStreamRendererViewState je uložena v daném callId localVideoStreams v CallClientState.

  • Scénář 2: Vykreslení LocalVideoStreamState není součástí volání (například vykreslovací kamera pro místní náhled)

  • CallId musí být nedefinováno, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • Výsledná VideoStreamRendererViewState je uložena v rámci daného LocalVideoStreamState v <xref:CallClientState.deviceManager.unparentedViews>

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

Parametry

callId

undefined | string

CallId pro daný datový proud. Pokud stream není součástí žádného volání, může být nedefinovaný.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> přidružené k dané remoteVideoStreamState. Při vykreslování LocalVideoStreamState může být nedefinováno.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

LocalVideoStreamState nebo RemoteVideoStreamState pro zahájení vykreslování.

options
CreateViewOptions

Možnosti předané <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer>.

Návraty

Promise<undefined | CreateViewResult>

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

Zastaví vykreslení RemoteVideoStreamState nebo LocalVideoStreamState a odebere <xref:VideoStreamRendererView> z příslušného RemoteVideoStreamState v CallClientState nebo <xref:LocalVideoStream> v CallClientState nebo příslušné <xref:CallClientState.deviceManager.unparentedViews> Pod voláními <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

Jeho důležité pro disposeView k vyčištění prostředků správně.

Scénář 1: Dispose RemoteVideoStreamState

  • CallId je povinné, id účastníka je povinné a vyžaduje se datový proud typu RemoteVideoStreamState.

Scénář 2: Dispose LocalVideoStreamState pro volání

  • CallId je povinné, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • Scénář 2: Dispose LocalVideoStreamState není součástí volání

  • CallId musí být nedefinováno, id účastníka musí být nedefinováno a datový proud typu LocalVideoStreamState je povinný.

  • LocalVideoStreamState musí být původní předaný createView.

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

Parametry

callId

undefined | string

CallId pro daný datový proud. Pokud stream není součástí žádného volání, může být nedefinovaný.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> přidružené k dané remoteVideoStreamState. Může být nedefinováno, pokud disposing LocalVideoStreamState.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

LocalVideoStreamState nebo RemoteVideoStreamState k odstranění.

getState()

Uchovává všechny stavy, které bychom mohli proxy z CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> jako CallClientState CallClientState.

function getState(): CallClientState

Návraty

CallClientState

offStateChange((state: CallClientState) => void)

Povoluje zrušení registrace událostí stateChanged.

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

Parametry

handler

(state: CallClientState) => void

Původní zpětné volání, které se má odhlásit.

onStateChange((state: CallClientState) => void)

Umožňuje registraci obslužné rutiny pro události stateChanged.

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

Parametry

handler

(state: CallClientState) => void

Zpětná volání pro příjem stavu.

Podrobnosti zděděných metod

dispose()

Likviduje tohoto CallClient, který také likviduje přidruženého správce zařízení a přidruženého agenta volání.

function dispose(): Promise<void>

Návraty

Promise<void>

Zděděno od CallClient.dispose

feature<TFeature>(CallClientFeatureFactory<TFeature>)

Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* Pro všechny dostupné funkce klienta rozšířeného volání v tomto balíčku.

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

Parametry

factory

CallClientFeatureFactory<TFeature>

Továrna pro konstruktor funkce volání klienta, který poskytuje rozšířené rozhraní API.

Návraty

TFeature

zděděno z CallClient.feature

getDeviceManager()

Správce zařízení slouží ke zpracování mediálních zařízení, jako jsou kamery, mikrofony a reproduktory.

function getDeviceManager(): Promise<DeviceManager>

Návraty

Promise<DeviceManager>

zděděné z CallClient.getDeviceManager