CommonCallingHandlers interface

Paquete:

@azure/communication-react

Objeto que contiene todos los controladores necesarios para llamar a componentes.

La llamada a componentes relacionados de este paquete puede seleccionar controladores relevantes de este objeto. Consulte <xref:useHandlers> y usePropsFor.

Propiedades

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Vuelva a llamar para crear una vista para el modo juntos
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Vuelva a llamar para eliminar juntas las vistas en modo
onForbidAudio	Prohibir que los participantes remotos envíen audio
onForbidOthersAudio	Cambiar la opción de reunión que prohíbe a los participantes remotos enviar audio
onForbidOthersVideo	Cambiar la opción de reunión que prohíbe a los participantes remotos enviar videos
onForbidVideo	Prohibir que los participantes remotos envíen videos
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Permitir que los participantes remotos envíen audio
onPermitOthersAudio	Cambiar la opción de reunión permitir que los participantes remotos envíen audio
onPermitOthersVideo	Cambiar la opción de reunión permitir que los participantes remotos envíen video
onPermitVideo	Permitir que los participantes remotos envíen videos
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Tamaño de escena del modo de conjunto de llamadas
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Vuelva a llamar para crear una vista para el modo juntos
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Métodos

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

Detalles de las propiedades

onAcceptCall

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

Valor de propiedad

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

onBlurVideoBackground

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

Valor de propiedad

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

onCreateLocalStreamView

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

Valor de propiedad

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

onCreateRemoteStreamView

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

Valor de propiedad

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

onCreateTogetherModeStreamView

Vuelva a llamar para crear una vista para el modo juntos

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

Valor de propiedad

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valor de propiedad

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valor de propiedad

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Advertencia

Esta API ya está en desuso.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Vuelva a llamar para eliminar juntas las vistas en modo

onDisposeTogetherModeStreamView: () => Promise<void>

Valor de propiedad

() => Promise<void>

onForbidAudio

Prohibir que los participantes remotos envíen audio

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

Valor de propiedad

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

onForbidOthersAudio

Cambiar la opción de reunión que prohíbe a los participantes remotos enviar audio

onForbidOthersAudio?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onForbidOthersVideo

Cambiar la opción de reunión que prohíbe a los participantes remotos enviar videos

onForbidOthersVideo?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onForbidVideo

Prohibir que los participantes remotos envíen videos

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

Valor de propiedad

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

onHangUp

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

Valor de propiedad

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

onLowerHand

onLowerHand: () => Promise<void>

Valor de propiedad

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valor de propiedad

() => Promise<void>

onMuteParticipant

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

Valor de propiedad

(userId: string) => Promise<void>

onPermitAudio

Permitir que los participantes remotos envíen audio

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

Valor de propiedad

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

onPermitOthersAudio

Cambiar la opción de reunión permitir que los participantes remotos envíen audio

onPermitOthersAudio?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onPermitOthersVideo

Cambiar la opción de reunión permitir que los participantes remotos envíen video

onPermitOthersVideo?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onPermitVideo

Permitir que los participantes remotos envíen videos

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

Valor de propiedad

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

onRaiseHand

onRaiseHand: () => Promise<void>

Valor de propiedad

() => Promise<void>

onReactionClick

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

Valor de propiedad

(reaction: Reaction) => Promise<void>

onRejectCall

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

Valor de propiedad

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valor de propiedad

() => Promise<void>

onReplaceVideoBackground

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

Valor de propiedad

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Valor de propiedad

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

onSelectMicrophone

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

Valor de propiedad

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Valor de propiedad

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Valor de propiedad

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Valor de propiedad

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

onSetCaptionLanguage

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

Valor de propiedad

(language: string) => Promise<void>

onSetSpokenLanguage

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

Valor de propiedad

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Tamaño de escena del modo de conjunto de llamadas

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

Valor de propiedad

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

onStartCall

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

Valor de propiedad

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

onStartCaptions

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

Valor de propiedad

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStartSpotlight

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

Valor de propiedad

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

onStartTogetherMode

Vuelva a llamar para crear una vista para el modo juntos

onStartTogetherMode: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopSpotlight

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

Valor de propiedad

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

onToggleCamera

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

Valor de propiedad

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

onToggleHold

onToggleHold: () => Promise<void>

Valor de propiedad

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valor de propiedad

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valor de propiedad

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valor de propiedad

() => Promise<void>

Detalles del método

onAddParticipant(CommunicationUserIdentifier)

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

Parámetros

participant

CommunicationUserIdentifier

Devoluciones

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parámetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Devoluciones

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parámetros

participant

CommunicationIdentifier

Devoluciones

Promise<void>

onRemoveParticipant(string)

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

Parámetros

userId

string

Devoluciones

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parámetros

survey

CallSurvey

Devoluciones

Promise<undefined | CallSurveyResponse>