CommonCallAdapter interface

Pacote:

@azure/communication-react

CallComposite Interface do adaptador.

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Métodos

joinCall(boolean)	Ingresse a chamada com o microfone inicialmente ativado/desativado.
startCall(string[], StartCallOptions)	Inicie a chamada.

Métodos herdados

askDevicePermission(PermissionConstraints)	Solicite permissões de dispositivos.
createStreamView(string, VideoStreamOptions)	Crie a exibição html para um fluxo.
dispose()	Descartar a composição
disposeStreamView(string, VideoStreamOptions)	Descarte a exibição html de um fluxo.
getState()	Obter o estado atual
leaveCall(boolean)	Deixe a chamada
mute()	Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente
off("callEnded", CallEndedListener)	Cancelar assinatura da função para o evento 'callEnded'.
off("callIdChanged", CallIdChangedListener)	Cancelar assinatura da função para o evento 'callIdChanged'.
off("diagnosticChanged", DiagnosticChangedEventListner)	Cancelar assinatura da função para o evento 'diagnosticChanged'.
off("displayNameChanged", DisplayNameChangedListener)	Cancelar assinatura da função para o evento 'displayNameChanged'.
off("error", (e: AdapterError) => void)	Cancelar assinatura da função para o evento 'error'.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Cancelar assinatura da função para o evento 'isLocalScreenSharingActiveChanged'.
off("isMutedChanged", IsMutedChangedListener)	Cancelar assinatura da função para o evento 'isMutedChanged'.
off("isSpeakingChanged", IsSpeakingChangedListener)	Cancelar assinatura da função para o evento 'isSpeakingChanged'.
off("participantsJoined", ParticipantsJoinedListener)	Cancelar assinatura da função para o evento 'participantsJoined'.
off("participantsLeft", ParticipantsLeftListener)	Cancelar assinatura da função para o evento 'participantsLeft'.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Cancelar assinatura da função para o evento 'selectedMicrophoneChanged'.
off("selectedSpeakerChanged", PropertyChangedEvent)	Cancelar assinatura da função para o evento 'selectedSpeakerChanged'.
offStateChange((state: CallAdapterState) => void)	Cancela a assinatura do manipulador para stateChanged events.
on("callEnded", CallEndedListener)	Função Subscribe para o evento 'callEnded'.
on("callIdChanged", CallIdChangedListener)	Função Subscribe para o evento 'callIdChanged'.
on("diagnosticChanged", DiagnosticChangedEventListner)	Função Subscribe para o evento 'diagnosticChanged'. Esse evento é acionado sempre que há uma alteração no usuário voltado para diagnóstico sobre a chamada em andamento.
on("displayNameChanged", DisplayNameChangedListener)	Função Subscribe para o evento 'displayNameChanged'.
on("error", (e: AdapterError) => void)	Função Subscribe para o evento 'error'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Função Subscribe para o evento 'isLocalScreenSharingActiveChanged'.
on("isMutedChanged", IsMutedChangedListener)	Função Subscribe para o evento 'isMutedChanged'.
on("isSpeakingChanged", IsSpeakingChangedListener)	Função Subscribe para o evento 'isSpeakingChanged'.
on("participantsJoined", ParticipantsJoinedListener)	Função Subscribe para o evento 'participantsJoined'.
on("participantsLeft", ParticipantsLeftListener)	Função Subscribe para o evento 'participantsLeft'.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Função Subscribe para o evento 'selectedMicrophoneChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone.
on("selectedSpeakerChanged", PropertyChangedEvent)	Função Subscribe para o evento 'selectedSpeakerChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante.
onStateChange((state: CallAdapterState) => void)	Assina o manipulador para stateChanged events.
queryCameras()	Consultar dispositivos de câmera disponíveis.
queryMicrophones()	Consultar dispositivos de microfone disponíveis.
querySpeakers()	Consultar dispositivos de microfone disponíveis.
removeParticipant(string)	Remova um participante da chamada.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Defina a câmera a ser usada na chamada.
setMicrophone(AudioDeviceInfo)	Defina o microfone a ser usado na chamada.
setSpeaker(AudioDeviceInfo)	Defina o alto-falante a ser usado na chamada.
startCamera(VideoStreamOptions)	Iniciar a câmera Este método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa
startScreenShare()	Comece a compartilhar a tela durante uma chamada.
stopCamera()	Parar a câmera Este método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa
stopScreenShare()	Parar de compartilhar a tela
unmute()	Desativar o usuário atual durante a chamada ou habilitar o microfone localmente

Detalhes do método

joinCall(boolean)

Ingresse a chamada com o microfone inicialmente ativado/desativado.

function joinCall(microphoneOn?: boolean)

Parâmetros

microphoneOn

boolean

Se o microfone está habilitado inicialmente

startCall(string[], StartCallOptions)

Inicie a chamada.

function startCall(participants: string[], options?: StartCallOptions)

Parâmetros

participants

string[]

Uma matriz de IDs de participante para ingressar

options

StartCallOptions

Detalhes do método herdado

askDevicePermission(PermissionConstraints)

Solicite permissões de dispositivos.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parâmetros

constrain

PermissionConstraints

Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Retornos

Promise<void>

Comentários

A janela de permissão do navegador será exibida se as permissões ainda não forem concedidas

Herdado deCallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Crie a exibição html para um fluxo.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para criar o modo de exibição de câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void | CreateVideoStreamViewResult>

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.createStreamView

dispose()

Descartar a composição

function dispose()

Herdado deDisposable.dispose

disposeStreamView(string, VideoStreamOptions)

Descarte a exibição html de um fluxo.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para descartar a exibição da câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.disposeStreamView

getState()

Obter o estado atual

function getState(): CallAdapterState

Retornos

CallAdapterState

Herdado deAdapterState.getState

leaveCall(boolean)

Deixe a chamada

function leaveCall(forEveryone?: boolean): Promise<void>

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.leaveCall

mute()

Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente

function mute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.mute

off("callEnded", CallEndedListener)

Cancelar assinatura da função para o evento 'callEnded'.

function off(event: "callEnded", listener: CallEndedListener)

Parâmetros

event

"callEnded"

listener

CallEndedListener

Herdado deCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Cancelar assinatura da função para o evento 'callIdChanged'.

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

Herdado deCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Cancelar assinatura da função para o evento 'diagnosticChanged'.

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parâmetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Herdado deCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Cancelar assinatura da função para o evento 'displayNameChanged'.

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

Herdado deCallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Cancelar assinatura da função para o evento 'error'.

function off(event: "error", listener: (e: AdapterError) => void)

Parâmetros

event

"error"

listener

(e: AdapterError) => void

Herdado deCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Cancelar assinatura da função para o evento 'isLocalScreenSharingActiveChanged'.

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Herdado deCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Cancelar assinatura da função para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

Herdado deCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Cancelar assinatura da função para o evento 'isSpeakingChanged'.

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Herdado deCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Cancelar assinatura da função para o evento 'participantsJoined'.

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

Herdado deCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Cancelar assinatura da função para o evento 'participantsLeft'.

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Parâmetros

event

"participantsLeft"

listener

ParticipantsLeftListener

Herdado deCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Cancelar assinatura da função para o evento 'selectedMicrophoneChanged'.

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

Parâmetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Herdado deCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Cancelar assinatura da função para o evento 'selectedSpeakerChanged'.

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

Parâmetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Herdado deCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Cancela a assinatura do manipulador para stateChanged events.

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

Parâmetros

handler

(state: CallAdapterState) => void

Herdado deAdapterState.offStateChange

on("callEnded", CallEndedListener)

Função Subscribe para o evento 'callEnded'.

function on(event: "callEnded", listener: CallEndedListener)

Parâmetros

event

"callEnded"

listener

CallEndedListener

Herdado deCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Função Subscribe para o evento 'callIdChanged'.

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

Comentários

O evento será disparado quando callId do usuário atual for alterado.

Herdado deCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Função Subscribe para o evento 'diagnosticChanged'.

Esse evento é acionado sempre que há uma alteração no usuário voltado para diagnóstico sobre a chamada em andamento.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parâmetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Herdado deCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Função Subscribe para o evento 'displayNameChanged'.

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

Herdado deCallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Função Subscribe para o evento 'error'.

function on(event: "error", listener: (e: AdapterError) => void)

Parâmetros

event

"error"

listener

(e: AdapterError) => void

Herdado deCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função Subscribe para o evento 'isLocalScreenSharingActiveChanged'.

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Herdado deCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Função Subscribe para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

Comentários

O evento será disparado sempre que o usuário atual ou o estado de mudo do usuário remoto forem alterados

Herdado deCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Função Subscribe para o evento 'isSpeakingChanged'.

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Herdado deCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Função Subscribe para o evento 'participantsJoined'.

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

Herdado deCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Função Subscribe para o evento 'participantsLeft'.

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Parâmetros

event

"participantsLeft"

listener

ParticipantsLeftListener

Herdado deCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Função Subscribe para o evento 'selectedMicrophoneChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone.

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

Parâmetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Herdado deCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Função Subscribe para o evento 'selectedSpeakerChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante.

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

Parâmetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Herdado deCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Assina o manipulador para stateChanged events.

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

Parâmetros

handler

(state: CallAdapterState) => void

Herdado deAdapterState.onStateChange

queryCameras()

Consultar dispositivos de câmera disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retornos

Promise<VideoDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.queryCameras

queryMicrophones()

Consultar dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Consultar dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.querySpeakers

removeParticipant(string)

Remova um participante da chamada.

function removeParticipant(userId: string): Promise<void>

Parâmetros

userId

string

ID do participante a ser removido

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera a ser usada na chamada.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parâmetros

sourceInfo

VideoDeviceInfo

Dispositivo de câmera para escolher, escolha um retornado por queryCameras

options

VideoStreamOptions

Opções para controlar como o fluxo de câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de microfone para escolher, escolha um retornado por queryMicrophones

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de alto-falante para escolher, escolha um retornado por querySpeakers

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

Iniciar a câmera Este método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa

function startCamera(options?: VideoStreamOptions): Promise<void>

Parâmetros

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startCamera

startScreenShare()

Comece a compartilhar a tela durante uma chamada.

function startScreenShare(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startScreenShare

stopCamera()

Parar a câmera Este método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa

function stopCamera(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopCamera

stopScreenShare()

Parar de compartilhar a tela

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopScreenShare

unmute()

Desativar o usuário atual durante a chamada ou habilitar o microfone localmente

function unmute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.unmute