CommonCallingHandlers interface

Pacote:

@azure/communication-react

Objeto que contém todos os manipuladores necessários para chamar componentes.

Chamar componentes relacionados deste pacote é capaz de selecionar manipuladores relevantes deste objeto. Consulte <xref:useHandlers> e usePropsFor.

Propriedades

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Ligue de volta para criar uma exibição para o modo de conjunto
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Ligue de volta para descartar modos de exibição juntos
onForbidAudio	Proibir participantes remotos de enviar áudio
onForbidOthersAudio	Alterar opção de reunião proibir participantes remotos de enviar áudio
onForbidOthersVideo	Alterar opção de reunião proibir participantes remotos de enviar vídeo
onForbidVideo	Proibir participantes remotos de enviar vídeo
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Permitir que participantes remotos enviem áudio
onPermitOthersAudio	Alterar a opção de reunião permite que os participantes remotos enviem áudio
onPermitOthersVideo	Alterar a opção de reunião permitir que os participantes remotos enviem vídeo
onPermitVideo	Permitir que participantes remotos enviem vídeos
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Tamanho da cena do modo de conjunto de chamadas
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Ligue de volta para criar uma exibição para o modo de conjunto
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Métodos

onAddParticipant(CommunicationUserIdentifier)
onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
onRemoveParticipant(CommunicationIdentifier)
onRemoveParticipant(string)
onSubmitSurvey(CallSurvey)

Detalhes de Propriedade

onAcceptCall

onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>

Valor de Propriedade

(incomingCallId: string, useVideo?: boolean) => Promise<void>

onBlurVideoBackground

onBlurVideoBackground: (backgroundBlurConfig?: VideoEffectConfig) => Promise<void>

Valor de Propriedade

(backgroundBlurConfig?: VideoEffectConfig) => Promise<void>

onCreateLocalStreamView

onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Valor de Propriedade

(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateRemoteStreamView

onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Valor de Propriedade

(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateTogetherModeStreamView

Ligue de volta para criar uma exibição para o modo de conjunto

onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

Valor de Propriedade

(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onDisposeRemoteScreenShareStreamView

onDisposeRemoteScreenShareStreamView: (userId: string) => Promise<void>

Valor de Propriedade

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Aviso

Esta API foi preterida.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

onDisposeRemoteStreamView: (userId: string) => Promise<void>

Valor de Propriedade

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

onDisposeRemoteVideoStreamView: (userId: string) => Promise<void>

Valor de Propriedade

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Ligue de volta para descartar modos de exibição juntos

onDisposeTogetherModeStreamView: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onForbidAudio

Proibir participantes remotos de enviar áudio

onForbidAudio?: (userIds: string[]) => Promise<void>

Valor de Propriedade

(userIds: string[]) => Promise<void>

onForbidOthersAudio

Alterar opção de reunião proibir participantes remotos de enviar áudio

onForbidOthersAudio?: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onForbidOthersVideo

Alterar opção de reunião proibir participantes remotos de enviar vídeo

onForbidOthersVideo?: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onForbidVideo

Proibir participantes remotos de enviar vídeo

onForbidVideo?: (userIds: string[]) => Promise<void>

Valor de Propriedade

(userIds: string[]) => Promise<void>

onHangUp

onHangUp: (forEveryone?: boolean) => Promise<void>

Valor de Propriedade

(forEveryone?: boolean) => Promise<void>

onLowerHand

onLowerHand: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onMuteParticipant

onMuteParticipant: (userId: string) => Promise<void>

Valor de Propriedade

(userId: string) => Promise<void>

onPermitAudio

Permitir que participantes remotos enviem áudio

onPermitAudio?: (userIds: string[]) => Promise<void>

Valor de Propriedade

(userIds: string[]) => Promise<void>

onPermitOthersAudio

Alterar a opção de reunião permite que os participantes remotos enviem áudio

onPermitOthersAudio?: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onPermitOthersVideo

Alterar a opção de reunião permitir que os participantes remotos enviem vídeo

onPermitOthersVideo?: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onPermitVideo

Permitir que participantes remotos enviem vídeos

onPermitVideo?: (userIds: string[]) => Promise<void>

Valor de Propriedade

(userIds: string[]) => Promise<void>

onRaiseHand

onRaiseHand: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onReactionClick

onReactionClick: (reaction: Reaction) => Promise<void>

Valor de Propriedade

(reaction: Reaction) => Promise<void>

onRejectCall

onRejectCall: (incomingCallId: string) => Promise<void>

Valor de Propriedade

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onReplaceVideoBackground

onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

Valor de Propriedade

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>

Valor de Propriedade

(device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>

onSelectMicrophone

onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>

Valor de Propriedade

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>

Valor de Propriedade

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

onSendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

Valor de Propriedade

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

onSendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Valor de Propriedade

(text: string, isFinalized: boolean) => Promise<void>

onSetCaptionLanguage

onSetCaptionLanguage: (language: string) => Promise<void>

Valor de Propriedade

(language: string) => Promise<void>

onSetSpokenLanguage

onSetSpokenLanguage: (language: string) => Promise<void>

Valor de Propriedade

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Tamanho da cena do modo de conjunto de chamadas

onSetTogetherModeSceneSize: (width: number, height: number) => void

Valor de Propriedade

(width: number, height: number) => void

onStartCall

onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => void

Valor de Propriedade

(participants: CommunicationIdentifier[], options?: StartCallOptions) => void

onStartCaptions

onStartCaptions: (options?: CaptionsOptions) => Promise<void>

Valor de Propriedade

(options?: CaptionsOptions) => Promise<void>

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStartSpotlight

onStartSpotlight: (userIds?: string[]) => Promise<void>

Valor de Propriedade

(userIds?: string[]) => Promise<void>

onStartTogetherMode

Ligue de volta para criar uma exibição para o modo de conjunto

onStartTogetherMode: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onStopSpotlight

onStopSpotlight: (userIds?: string[]) => Promise<void>

Valor de Propriedade

(userIds?: string[]) => Promise<void>

onToggleCamera

onToggleCamera: (options?: VideoStreamOptions) => Promise<void>

Valor de Propriedade

(options?: VideoStreamOptions) => Promise<void>

onToggleHold

onToggleHold: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valor de Propriedade

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valor de Propriedade

() => Promise<void>

Detalhes de Método

onAddParticipant(CommunicationUserIdentifier)

function onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parâmetros

participant

CommunicationUserIdentifier

Devoluções

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

function onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>

Parâmetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Devoluções

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

function onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>

Parâmetros

participant

CommunicationIdentifier

Devoluções

Promise<void>

onRemoveParticipant(string)

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

Parâmetros

userId

string

Devoluções

Promise<void>

onSubmitSurvey(CallSurvey)

function onSubmitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parâmetros

survey

CallSurvey

Devoluções

Promise<undefined | CallSurveyResponse>