Partilhar via

StatefulCallClient interface

  • Referência
Pacote:
@azure/communication-react

Define os métodos que permitem que o CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> seja usado com monitoração de estado. A interface fornece acesso ao estado proxy e também permite registrar um manipulador para eventos de alteração de estado. Para obter a definição de estado, consulte CallClientState.

Os eventos de alteração de estado são impulsionados por:

  • Dados retornados de <xref:%40azure%2Fcommunication-calling%23DeviceManager> APIs.
  • Dados retornados de <xref:%40azure%2Fcommunication-calling%23CallAgent> APIs.
  • Ouvintes automaticamente anexados a vários objetos de chamada de comunicação do Azure:
    • CallAgent 'incomingCall'
    • CallAgent 'chamadasAtualizado'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Chamar 'stateChanged'
    • Chamada 'idChanged'
    • Chamada 'isMutedChanged'
    • Chamada 'isScreenSharingOnChanged'
    • Ligue para 'remoteParticipantsUpdated'
    • Ligue para 'localVideoStreamsUpdated'
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
Extends
CallClient

Métodos

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

Renderiza um RemoteVideoStreamState ou LocalVideoStreamState e armazena o resultante VideoStreamRendererViewState sob o RemoteVideoStreamState relevante ou LocalVideoStreamState ou como modo de exibição não pai no estado. Sob o capô chama <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

Cenário 1: Renderizar RemoteVideoStreamState

  • CallId é necessário, participantId é necessário e fluxo do tipo RemoteVideoStreamState é necessário
  • O resultante VideoStreamRendererViewState é armazenado no callId e participantId fornecidos em CallClientState

Cenário 2: Renderizar LocalVideoStreamState para uma chamada

  • CallId é necessário, participantId deve ser indefinido e fluxo do tipo LocalVideoStreamState é necessário.

  • O <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> já deve ser iniciado usando <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Resultante VideoStreamRendererViewState é armazenado no callId localVideoStreams em CallClientState.

  • Cenário 2: Renderizar LocalVideoStreamState não parte de uma chamada (exemplo de câmera de renderização para visualização local)

  • CallId deve ser undefined, participantId deve ser undefined e stream do tipo LocalVideoStreamState é necessário.

  • Resultante VideoStreamRendererViewState é armazenado sob o determinado LocalVideoStreamState em <xref:CallClientState.deviceManager.unparentedViews>
disposeView(undefined | string, undefined | CommunicationIdentifier, LocalVideoStreamState | RemoteVideoStreamState)

Interrompe a renderização de um RemoteVideoStreamState ou LocalVideoStreamState e remove o <xref:VideoStreamRendererView> do RemoteVideoStreamState relevante em ou <xref:LocalVideoStream> CallClientState em CallClientState ou <xref:CallClientState.deviceManager.unparentedViews> apropriada Chamadas Under the hood <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

É importante descartarView para limpar os recursos corretamente.

Cenário 1: Eliminar RemoteVideoStreamState

  • CallId é necessário, participantId é necessário e fluxo do tipo RemoteVideoStreamState é necessário

Cenário 2: Descarte LocalVideoStreamState para uma chamada

  • CallId é necessário, participantId deve ser indefinido e fluxo do tipo LocalVideoStreamState é necessário.

  • Cenário 2: Eliminar LocalVideoStreamState que não faz parte de uma chamada

  • CallId deve ser undefined, participantId deve ser undefined e stream do tipo LocalVideoStreamState é necessário.

  • LocalVideoStreamState deve ser o original passado para createView.
getState()

Contém todo o estado que poderíamos proxy de CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> como CallClientState CallClientState.
offStateChange((state: CallClientState) => void)

Permite cancelar o registro para eventos 'stateChanged'.
onStateChange((state: CallClientState) => void)

Permite que um manipulador seja registrado para eventos 'stateChanged'.

Métodos Herdados

createCallAgent(CommunicationTokenCredential, CallAgentOptions)

O CallAgent é usado para lidar com chamadas. Para criar o CallAgent, passe um objeto CommunicationTokenCredential fornecido pelo SDK.

  • O CallClient só pode ter uma instância ativa do CallAgent de cada vez.
  • Você pode criar uma nova instância CallClient para criar um novo CallAgent.
  • Você pode descartar o CallAgent ativo atual de um CallClient e chamar o método createCallAgent() do CallClient novamente para criar um novo CallAgent.
createTeamsCallAgent(CommunicationTokenCredential, TeamsCallAgentOptions)

O TeamsCallAgent é usado para lidar com chamadas do Teams. Para criar o TeamsCallAgent, passe um objeto CommunicationTokenCredential fornecido pelo SDK.

  • O CallClient só pode ter uma instância ativa do TeamsCallAgent de cada vez.
  • Você pode criar uma nova instância CallClient para criar um novo TeamsCallAgent.
  • Você pode descartar o TeamsCallAgent ativo atual de um CallClient e chamar o método createTeamsCallAgent() do CallClient novamente para criar um novo TeamsCallAgent.
feature<TFeature>(CallClientFeatureFactory<TFeature>)

Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de cliente de chamada estendida disponíveis neste pacote.
getDeviceManager()

O DeviceManager é usado para lidar com dispositivos de mídia, como câmeras, microfones e alto-falantes.

Detalhes de Método

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

Renderiza um RemoteVideoStreamState ou LocalVideoStreamState e armazena o resultante VideoStreamRendererViewState sob o RemoteVideoStreamState relevante ou LocalVideoStreamState ou como modo de exibição não pai no estado. Sob o capô chama <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>.

Cenário 1: Renderizar RemoteVideoStreamState

  • CallId é necessário, participantId é necessário e fluxo do tipo RemoteVideoStreamState é necessário
  • O resultante VideoStreamRendererViewState é armazenado no callId e participantId fornecidos em CallClientState

Cenário 2: Renderizar LocalVideoStreamState para uma chamada

  • CallId é necessário, participantId deve ser indefinido e fluxo do tipo LocalVideoStreamState é necessário.

  • O <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> já deve ser iniciado usando <xref:%40azure%2Fcommunication-calling%23Call.startVideo>.

  • Resultante VideoStreamRendererViewState é armazenado no callId localVideoStreams em CallClientState.

  • Cenário 2: Renderizar LocalVideoStreamState não parte de uma chamada (exemplo de câmera de renderização para visualização local)

  • CallId deve ser undefined, participantId deve ser undefined e stream do tipo LocalVideoStreamState é necessário.

  • Resultante VideoStreamRendererViewState é armazenado sob o determinado LocalVideoStreamState em <xref:CallClientState.deviceManager.unparentedViews>

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

Parâmetros

callId

undefined | string

CallId para o fluxo determinado. Pode ser indefinido se o fluxo não fizer parte de nenhuma chamada.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> associado com o RemoteVideoStreamState fornecido. Pode ser indefinido se renderizar LocalVideoStreamState.

stream

LocalVideoStreamState | RemoteVideoStreamState

O LocalVideoStreamState ou RemoteVideoStreamState para iniciar a renderização.

options
CreateViewOptions

Opções que são passadas para o <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer>.

Devoluções

Promise<undefined | CreateViewResult>

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

Interrompe a renderização de um RemoteVideoStreamState ou LocalVideoStreamState e remove o <xref:VideoStreamRendererView> do RemoteVideoStreamState relevante em ou <xref:LocalVideoStream> CallClientState em CallClientState ou <xref:CallClientState.deviceManager.unparentedViews> apropriada Chamadas Under the hood <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

É importante descartarView para limpar os recursos corretamente.

Cenário 1: Eliminar RemoteVideoStreamState

  • CallId é necessário, participantId é necessário e fluxo do tipo RemoteVideoStreamState é necessário

Cenário 2: Descarte LocalVideoStreamState para uma chamada

  • CallId é necessário, participantId deve ser indefinido e fluxo do tipo LocalVideoStreamState é necessário.

  • Cenário 2: Eliminar LocalVideoStreamState que não faz parte de uma chamada

  • CallId deve ser undefined, participantId deve ser undefined e stream do tipo LocalVideoStreamState é necessário.

  • LocalVideoStreamState deve ser o original passado para createView.

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

Parâmetros

callId

undefined | string

CallId para o fluxo determinado. Pode ser indefinido se o fluxo não fizer parte de nenhuma chamada.

participantId

undefined | CommunicationIdentifier

<xref:RemoteParticipant.identifier> associado com o RemoteVideoStreamState fornecido. Pode ser indefinido se descartar LocalVideoStreamState.

stream

LocalVideoStreamState | RemoteVideoStreamState

O LocalVideoStreamState ou RemoteVideoStreamState para descartar.

getState()

Contém todo o estado que poderíamos proxy de CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> como CallClientState CallClientState.

function getState(): CallClientState

Devoluções

CallClientState

offStateChange((state: CallClientState) => void)

Permite cancelar o registro para eventos 'stateChanged'.

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

Parâmetros

handler

(state: CallClientState) => void

Retorno de chamada original a ser cancelado.

onStateChange((state: CallClientState) => void)

Permite que um manipulador seja registrado para eventos 'stateChanged'.

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

Parâmetros

handler

(state: CallClientState) => void

Retorno de chamada para receber o estado.

Detalhes do Método Herdado

createCallAgent(CommunicationTokenCredential, CallAgentOptions)

O CallAgent é usado para lidar com chamadas. Para criar o CallAgent, passe um objeto CommunicationTokenCredential fornecido pelo SDK.

  • O CallClient só pode ter uma instância ativa do CallAgent de cada vez.
  • Você pode criar uma nova instância CallClient para criar um novo CallAgent.
  • Você pode descartar o CallAgent ativo atual de um CallClient e chamar o método createCallAgent() do CallClient novamente para criar um novo CallAgent.
function createCallAgent(tokenCredential: CommunicationTokenCredential, options?: CallAgentOptions): Promise<CallAgent>

Parâmetros

tokenCredential
CommunicationTokenCredential

A credencial do token. Use AzureCommunicationTokenCredential do @azure/communication-common para criar uma credencial.

options
CallAgentOptions

O CallAgentOptions para opções adicionais, como nome para exibição.

Devoluções

Promise<CallAgent>

herdado de CallClient.createCallAgent

createTeamsCallAgent(CommunicationTokenCredential, TeamsCallAgentOptions)

O TeamsCallAgent é usado para lidar com chamadas do Teams. Para criar o TeamsCallAgent, passe um objeto CommunicationTokenCredential fornecido pelo SDK.

  • O CallClient só pode ter uma instância ativa do TeamsCallAgent de cada vez.
  • Você pode criar uma nova instância CallClient para criar um novo TeamsCallAgent.
  • Você pode descartar o TeamsCallAgent ativo atual de um CallClient e chamar o método createTeamsCallAgent() do CallClient novamente para criar um novo TeamsCallAgent.
function createTeamsCallAgent(tokenCredential: CommunicationTokenCredential, options?: TeamsCallAgentOptions): Promise<TeamsCallAgent>

Parâmetros

tokenCredential
CommunicationTokenCredential

A credencial do token. Use AzureCommunicationTokenCredential do @azure/communication-common para criar uma credencial.

options
TeamsCallAgentOptions

O CallAgentOptions para opções adicionais, como nome para exibição.

Devoluções

Promise<TeamsCallAgent>

herdado de CallClient.createTeamsCallAgent

feature<TFeature>(CallClientFeatureFactory<TFeature>)

Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de cliente de chamada estendida disponíveis neste pacote.

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

Parâmetros

factory

CallClientFeatureFactory<TFeature>

A fábrica para o construtor de recurso de cliente de chamada que fornece uma API estendida.

Devoluções

TFeature

herdado de CallClient.feature

getDeviceManager()

O DeviceManager é usado para lidar com dispositivos de mídia, como câmeras, microfones e alto-falantes.

function getDeviceManager(): Promise<DeviceManager>

Devoluções

Promise<DeviceManager>

herdado de CallClient.getDeviceManager