CallAdapter interface

Pacote:

@azure/communication-react

Uma interface de adaptador específica para a identidade de Comunicação do Azure que se estende CommonCallAdapter.

Extends

CommonCallAdapter

Métodos

joinCall(boolean)	Participe da chamada com o microfone inicialmente ligado/desligado.
startCall(string[], StartCallOptions)	Inicie a chamada.

Métodos Herdados

askDevicePermission(PermissionConstraints)	Peça permissões de dispositivos.
createStreamView(string, VideoStreamOptions)	Crie a visualização html para um fluxo.
dispose()	Elimine o composto
disposeStreamView(string, VideoStreamOptions)	Descarte o modo de exibição html para um fluxo.
getState()	Obter o estado atual
leaveCall(boolean)	Saia da chamada
mute()	Silenciar o usuário atual durante a chamada ou desativar o microfone localmente
off("callEnded", CallEndedListener)	Função de cancelamento de inscrição para o evento 'callEnded'.
off("callIdChanged", CallIdChangedListener)	Função de cancelamento de inscrição para o evento 'callIdChanged'.
off("diagnosticChanged", DiagnosticChangedEventListner)	Função de cancelamento de inscrição para o evento 'diagnosticChanged'.
off("displayNameChanged", DisplayNameChangedListener)	Função de cancelamento de inscrição para o evento 'displayNameChanged'.
off("error", (e: AdapterError) => void)	Função de cancelamento de inscrição para o evento 'error'.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Função de cancelamento de inscrição para o evento 'isLocalScreenSharingActiveChanged'.
off("isMutedChanged", IsMutedChangedListener)	Função de cancelamento de inscrição para o evento 'isMutedChanged'.
off("isSpeakingChanged", IsSpeakingChangedListener)	Função de cancelamento de inscrição para o evento 'isSpeakingChanged'.
off("participantsJoined", ParticipantsJoinedListener)	Função de cancelamento de inscrição para o evento 'participantesParticipou'.
off("participantsLeft", ParticipantsLeftListener)	Função de cancelamento de inscrição para o evento 'participantsLeft'.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento 'selectedMicrophoneChanged'.
off("selectedSpeakerChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento 'selectedSpeakerChanged'.
offStateChange((state: CallAdapterState) => void)	Cancela a inscrição do manipulador para eventos stateChanged.
on("callEnded", CallEndedListener)	Função de subscrição para o evento 'callEnded'.
on("callIdChanged", CallIdChangedListener)	Função de assinatura para o evento 'callIdChanged'.
on("diagnosticChanged", DiagnosticChangedEventListner)	Função de subscrição para o evento 'diagnosticChanged'. Esse evento é acionado sempre que há uma alteração no diagnóstico voltado para o usuário sobre a chamada em andamento.
on("displayNameChanged", DisplayNameChangedListener)	Função de subscrição para o evento 'displayNameChanged'.
on("error", (e: AdapterError) => void)	Função de subscrição para o evento 'error'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Função de assinatura para o evento 'isLocalScreenSharingActiveChanged'.
on("isMutedChanged", IsMutedChangedListener)	Função de assinatura para o evento 'isMutedChanged'.
on("isSpeakingChanged", IsSpeakingChangedListener)	Subscrever função para o evento 'isSpeakingChanged'.
on("participantsJoined", ParticipantsJoinedListener)	Função de inscrição para o evento 'participantesParticipou'.
on("participantsLeft", ParticipantsLeftListener)	Função de inscrição para o evento 'participantsLeft'.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Função de inscrição para o evento 'selectedMicrophoneChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone.
on("selectedSpeakerChanged", PropertyChangedEvent)	Função de inscrição para o evento 'selectedSpeakerChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante.
onStateChange((state: CallAdapterState) => void)	Inscreve o manipulador em eventos stateChanged.
queryCameras()	Consulta de dispositivos de câmara disponíveis.
queryMicrophones()	Consulta de dispositivos de microfone disponíveis.
querySpeakers()	Consulta de dispositivos de microfone disponíveis.
removeParticipant(string)	Remova um participante da chamada.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Defina a câmera para usar 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âmara Este método começará a renderizar uma vista de câmara local quando a chamada não estiver ativa
startScreenShare()	Comece a partilhar o ecrã durante uma chamada.
stopCamera()	Parar a câmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa
stopScreenShare()	Parar de partilhar o ecrã
unmute()	Ativar o mudo do usuário atual durante a chamada ou ativar o microfone localmente

Detalhes de Método

joinCall(boolean)

Participe da chamada com o microfone inicialmente ligado/desligado.

function joinCall(microphoneOn?: boolean): undefined | Call

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente ativado

Devoluções

undefined | Call

startCall(string[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

string[]

Uma matriz de ids de participante para participar

options

StartCallOptions

Devoluções

undefined | Call

Detalhes do Método Herdado

askDevicePermission(PermissionConstraints)

Peça 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>

Devoluções

Promise<void>

Observações

A janela de permissão do navegador aparecerá se as permissões ainda não tiverem sido concedidas

herdado de CommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Crie a visualização html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para criar a visualizaçã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>

Devoluções

Promise<void | CreateVideoStreamViewResult>

Observações

Este método é implementado para compósitos

herdado de CommonCallAdapter.createStreamView

dispose()

Elimine o composto

function dispose()

herdado deCommonCallAdapter.dispose

disposeStreamView(string, VideoStreamOptions)

Descarte o modo de exibição html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para descartar a visã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>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

herdado de CommonCallAdapter.disposeStreamView

getState()

Obter o estado atual

function getState(): CallAdapterState

Devoluções

CallAdapterState

herdado de CommonCallAdapter.getState

leaveCall(boolean)

Saia da chamada

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

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos ao sair

Devoluções

Promise<void>

herdado de CommonCallAdapter.leaveCall

mute()

Silenciar o usuário atual durante a chamada ou desativar o microfone localmente

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.mute

off("callEnded", CallEndedListener)

Função de cancelamento de inscrição para o evento 'callEnded'.

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

Parâmetros

event

"callEnded"

listener

CallEndedListener

herdado de CommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Função de cancelamento de inscrição para o evento 'callIdChanged'.

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

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

herdado de CommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Função de cancelamento de inscrição para o evento 'diagnosticChanged'.

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

Parâmetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

herdado de CommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Função de cancelamento de inscrição para o evento 'displayNameChanged'.

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

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

herdado de CommonCallAdapter.off

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

Função de cancelamento de inscrição para o evento 'error'.

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

Parâmetros

event

"error"

listener

(e: AdapterError) => void

herdado de CommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função de cancelamento de inscrição para o evento 'isLocalScreenSharingActiveChanged'.

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

herdado de CommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Função de cancelamento de inscrição para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

herdado de CommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Função de cancelamento de inscrição para o evento 'isSpeakingChanged'.

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

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

herdado de CommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Função de cancelamento de inscrição para o evento 'participantesParticipou'.

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

Parâmetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

herdado de CommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Função de cancelamento de inscrição para o evento 'participantsLeft'.

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

Parâmetros

event

"participantsLeft"

listener

ParticipantsLeftListener

herdado de CommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedMicrophoneChanged'.

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

Parâmetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

herdado de CommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedSpeakerChanged'.

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

Parâmetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

herdado de CommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Cancela a inscrição do manipulador para eventos stateChanged.

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

Parâmetros

handler

(state: CallAdapterState) => void

herdado de CommonCallAdapter.offStateChange

on("callEnded", CallEndedListener)

Função de subscrição para o evento 'callEnded'.

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

Parâmetros

event

"callEnded"

listener

CallEndedListener

herdado de CommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Função de assinatura para o evento 'callIdChanged'.

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

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

Observações

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

herdado de CommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Função de subscrição para o evento 'diagnosticChanged'.

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

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

Parâmetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

herdado de CommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Função de subscrição para o evento 'displayNameChanged'.

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

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

herdado de CommonCallAdapter.on

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

Função de subscrição para o evento 'error'.

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

Parâmetros

event

"error"

listener

(e: AdapterError) => void

herdado de CommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função de assinatura para o evento 'isLocalScreenSharingActiveChanged'.

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

herdado de CommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Função de assinatura para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

Observações

O evento será acionado sempre que o estado de silenciamento do usuário atual ou do usuário remoto for alterado

herdado de CommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscrever função para o evento 'isSpeakingChanged'.

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

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

herdado de CommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Função de inscrição para o evento 'participantesParticipou'.

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

Parâmetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

herdado de CommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Função de inscrição para o evento 'participantsLeft'.

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

Parâmetros

event

"participantsLeft"

listener

ParticipantsLeftListener

herdado de CommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Função de inscrição 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 de CommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Função de inscrição 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 de CommonCallAdapter.on

onStateChange((state: CallAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

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

Parâmetros

handler

(state: CallAdapterState) => void

herdado de CommonCallAdapter.onStateChange

queryCameras()

Consulta de dispositivos de câmara disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluções

Promise<VideoDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.queryCameras

queryMicrophones()

Consulta de dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.queryMicrophones

querySpeakers()

Consulta de dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.querySpeakers

removeParticipant(string)

Remova um participante da chamada.

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

Parâmetros

userId

string

ID do participante a ser removido

Devoluções

Promise<void>

herdado de CommonCallAdapter.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera para usar 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 da câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

herdado de CommonCallAdapter.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

Devoluções

Promise<void>

herdado de CommonCallAdapter.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

Devoluções

Promise<void>

herdado de CommonCallAdapter.setSpeaker

startCamera(VideoStreamOptions)

Iniciar a câmara Este método começará a renderizar uma vista de câmara 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>

Devoluções

Promise<void>

herdado de CommonCallAdapter.startCamera

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.startScreenShare

stopCamera()

Parar a câmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa

function stopCamera(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.stopCamera

stopScreenShare()

Parar de partilhar o ecrã

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.stopScreenShare

unmute()

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

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.unmute