CommonCallingHandlers interface

Pacote:

@azure/communication-react

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

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

Propriedades

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Retorno de chamada para criar uma exibição para o modo juntos
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Ligar de volta para descartar juntos modos de exibição
onForbidAudio	Proibir participantes remotos de enviar áudio
onForbidOthersAudio	Alterar opção de reunião proíbe participantes remotos de enviar áudio
onForbidOthersVideo	Alterar a opção de reunião para 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 permitir que participantes remotos enviem áudio
onPermitOthersVideo	Alterar a opção de reunião permitir que participantes remotos enviem vídeo
onPermitVideo	Permitir que participantes remotos enviem vídeo
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	Retorno de chamada para criar uma exibição para o 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)

Detalhes da propriedade

onAcceptCall

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

Valor da propriedade

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

onBlurVideoBackground

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

Valor da propriedade

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

onCreateLocalStreamView

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

Valor da propriedade

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

onCreateRemoteStreamView

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

Valor da propriedade

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

onCreateTogetherModeStreamView

Retorno de chamada para criar uma exibição para o modo juntos

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

Valor da propriedade

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Valor da propriedade

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Aviso

Essa API foi preterida.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Valor da propriedade

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

Valor da propriedade

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

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

onDisposeTogetherModeStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

onForbidAudio

Proibir participantes remotos de enviar áudio

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

Valor da propriedade

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

onForbidOthersAudio

Alterar opção de reunião proíbe participantes remotos de enviar áudio

onForbidOthersAudio?: () => Promise<void>

Valor da propriedade

() => Promise<void>

onForbidOthersVideo

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

onForbidOthersVideo?: () => Promise<void>

Valor da propriedade

() => Promise<void>

onForbidVideo

Proibir participantes remotos de enviar vídeo

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

Valor da propriedade

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

onHangUp

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

Valor da propriedade

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

onLowerHand

onLowerHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valor da propriedade

() => Promise<void>

onMuteParticipant

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

Valor da propriedade

(userId: string) => Promise<void>

onPermitAudio

Permitir que participantes remotos enviem áudio

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

Valor da propriedade

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

onPermitOthersAudio

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

onPermitOthersAudio?: () => Promise<void>

Valor da propriedade

() => Promise<void>

onPermitOthersVideo

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

onPermitOthersVideo?: () => Promise<void>

Valor da propriedade

() => Promise<void>

onPermitVideo

Permitir que participantes remotos enviem vídeo

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

Valor da propriedade

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

onRaiseHand

onRaiseHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

onReactionClick

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

Valor da propriedade

(reaction: Reaction) => Promise<void>

onRejectCall

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

Valor da propriedade

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valor da propriedade

() => Promise<void>

onReplaceVideoBackground

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

Valor da propriedade

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Valor da propriedade

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

onSelectMicrophone

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

Valor da propriedade

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Valor da propriedade

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Valor da propriedade

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Valor da propriedade

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

onSetCaptionLanguage

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

Valor da propriedade

(language: string) => Promise<void>

onSetSpokenLanguage

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

Valor da propriedade

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Tamanho da cena do modo de conjunto de chamadas

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

Valor da propriedade

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

onStartCall

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

Valor da propriedade

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

onStartCaptions

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

Valor da propriedade

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStartSpotlight

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

Valor da propriedade

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

onStartTogetherMode

Retorno de chamada para criar uma exibição para o modo juntos

onStartTogetherMode: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

onStopSpotlight

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

Valor da propriedade

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

onToggleCamera

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

Valor da propriedade

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

onToggleHold

onToggleHold: () => Promise<void>

Valor da propriedade

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valor da propriedade

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

Detalhes do método

onAddParticipant(CommunicationUserIdentifier)

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

Parâmetros

participant

CommunicationUserIdentifier

Retornos

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parâmetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retornos

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parâmetros

participant

CommunicationIdentifier

Retornos

Promise<void>

onRemoveParticipant(string)

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

Parâmetros

userId

string

Retornos

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parâmetros

survey

CallSurvey

Retornos

Promise<undefined | CallSurveyResponse>