TeamsCallingHandlers interface

Pacote:

@azure/communication-react

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

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

Extends

CommonCallingHandlers

Propriedades

onStartCall

Propriedades herdadas

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
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 herdados

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

Detalhes da propriedade

onStartCall

onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall

Valor da propriedade

(participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall

Detalhes das propriedades herdadas

onAcceptCall

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onAcceptCall

onBlurVideoBackground

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onBlurVideoBackground

onCreateLocalStreamView

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

Valor da propriedade

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

herdado deCommonCallingHandlers.onCreateLocalStreamView

onCreateRemoteStreamView

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

Valor da propriedade

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

herdado deCommonCallingHandlers.onCreateRemoteStreamView

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>

Herdado deCommonCallingHandlers.onCreateTogetherModeStreamView

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onDisposeLocalScreenShareStreamView

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onDisposeLocalStreamView

onDisposeRemoteScreenShareStreamView

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

Valor da propriedade

(userId: string) => Promise<void>

Herdado deCommonCallingHandlers.onDisposeRemoteScreenShareStreamView

onDisposeRemoteStreamView

Aviso

Essa API foi preterida.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Valor da propriedade

(userId: string) => Promise<void>

Herdado deCommonCallingHandlers.onDisposeRemoteStreamView

onDisposeRemoteVideoStreamView

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

Valor da propriedade

(userId: string) => Promise<void>

Herdado deCommonCallingHandlers.onDisposeRemoteVideoStreamView

onDisposeTogetherModeStreamView

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

onDisposeTogetherModeStreamView: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onDisposeTogetherModeStreamView

onForbidAudio

Proibir participantes remotos de enviar áudio

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onForbidAudio

onForbidOthersAudio

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

onForbidOthersAudio?: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onForbidOthersAudio

onForbidOthersVideo

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

onForbidOthersVideo?: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onForbidOthersVideo

onForbidVideo

Proibir participantes remotos de enviar vídeo

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onForbidVideo

onHangUp

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

Valor da propriedade

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

herdado deCommonCallingHandlers.onHangUp

onLowerHand

onLowerHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onLowerHand

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onMuteAllRemoteParticipants

onMuteParticipant

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

Valor da propriedade

(userId: string) => Promise<void>

Herdado deCommonCallingHandlers.onMuteParticipant

onPermitAudio

Permitir que participantes remotos enviem áudio

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onPermitAudio

onPermitOthersAudio

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

onPermitOthersAudio?: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onPermitOthersAudio

onPermitOthersVideo

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

onPermitOthersVideo?: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onPermitOthersVideo

onPermitVideo

Permitir que participantes remotos enviem vídeo

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onPermitVideo

onRaiseHand

onRaiseHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onRaiseHand

onReactionClick

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

Valor da propriedade

(reaction: Reaction) => Promise<void>

Herdado deCommonCallingHandlers.onReactionClick

onRejectCall

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

Valor da propriedade

(incomingCallId: string) => Promise<void>

Herdado deCommonCallingHandlers.onRejectCall

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onRemoveVideoBackgroundEffects

onReplaceVideoBackground

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

Valor da propriedade

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

Herdado deCommonCallingHandlers.onReplaceVideoBackground

onSelectCamera

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

Valor da propriedade

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

herdado deCommonCallingHandlers.onSelectCamera

onSelectMicrophone

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

Valor da propriedade

(device: AudioDeviceInfo) => Promise<void>

herdado deCommonCallingHandlers.onSelectMicrophone

onSelectSpeaker

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

Valor da propriedade

(device: AudioDeviceInfo) => Promise<void>

Herdado deCommonCallingHandlers.onSelectSpeaker

onSendDtmfTone

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

Valor da propriedade

(dtmfTone: DtmfTone) => Promise<void>

Herdado deCommonCallingHandlers.onSendDtmfTone

onSendRealTimeText

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onSendRealTimeText

onSetCaptionLanguage

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

Valor da propriedade

(language: string) => Promise<void>

Herdado deCommonCallingHandlers.onSetCaptionLanguage

onSetSpokenLanguage

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

Valor da propriedade

(language: string) => Promise<void>

Herdado deCommonCallingHandlers.onSetSpokenLanguage

onSetTogetherModeSceneSize

Tamanho da cena do modo de conjunto de chamadas

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onSetTogetherModeSceneSize

onStartCaptions

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onStartCaptions

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStartLocalVideo

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStartNoiseSuppressionEffect

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

herdado deCommonCallingHandlers.onStartScreenShare

onStartSpotlight

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onStartSpotlight

onStartTogetherMode

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

onStartTogetherMode: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStartTogetherMode

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStopAllSpotlight

onStopCaptions

onStopCaptions: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStopCaptions

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onStopNoiseSuppressionEffect

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

herdado deCommonCallingHandlers.onStopScreenShare

onStopSpotlight

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onStopSpotlight

onToggleCamera

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

Valor da propriedade

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

Herdado deCommonCallingHandlers.onToggleCamera

onToggleHold

onToggleHold: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onToggleHold

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onToggleMicrophone

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valor da propriedade

() => Promise<void>

Herdado deCommonCallingHandlers.onToggleRaiseHand

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valor da propriedade

() => Promise<void>

herdado deCommonCallingHandlers.onToggleScreenShare

Detalhes do método herdado

onAddParticipant(CommunicationUserIdentifier)

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

Parâmetros

participant

CommunicationUserIdentifier

Retornos

Promise<void>

Herdado deCommonCallingHandlers.onAddParticipant

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parâmetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retornos

Promise<void>

Herdado deCommonCallingHandlers.onAddParticipant

onRemoveParticipant(CommunicationIdentifier)

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

Parâmetros

participant

CommunicationIdentifier

Retornos

Promise<void>

herdado deCommonCallingHandlers.onRemoveParticipant

onRemoveParticipant(string)

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

Parâmetros

userId

string

Retornos

Promise<void>

herdado deCommonCallingHandlers.onRemoveParticipant

onSubmitSurvey(CallSurvey)

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

Parâmetros

survey

CallSurvey

Retornos

Promise<undefined | CallSurveyResponse>

Herdado deCommonCallingHandlers.onSubmitSurvey