CallWithChatAdapter interface
interface do adaptador de CallWithChatComposto.
- Extends
Propriedades Herdadas
| forbid |
Proíbe áudio para os IDs de usuário especificados. |
| forbid |
proíbe o áudio para participantes da reunião do Teams, exceto o usuário local. |
| forbid |
proíbe vídeo para participantes da reunião do Teams, exceto o usuário local. |
| forbid |
Proíbe vídeo para os IDs de usuário especificados. |
| permit |
Permite áudio para os IDs de usuário especificados. |
| permit |
permite áudio para participantes da reunião do Teams, exceto o usuário local. |
| permit |
permite vídeo para participantes da reunião do Teams, exceto o usuário local. |
| permit |
Permite vídeo para os IDs de usuário especificados. |
| send |
Enviar tom DTMF para outro participante da chamada em chamadas 1:1 |
| send |
Enviar texto em tempo real |
Métodos Herdados
Detalhes da Propriedade Herdada
forbidAudio
Proíbe áudio para os IDs de usuário especificados.
forbidAudio: (userIds: string[]) => Promise<void>
Valor de Propriedade
(userIds: string[]) => Promise<void>
forbidOthersAudio
proíbe o áudio para participantes da reunião do Teams, exceto o usuário local.
forbidOthersAudio: () => Promise<void>
Valor de Propriedade
() => Promise<void>
forbidOthersVideo
proíbe vídeo para participantes da reunião do Teams, exceto o usuário local.
forbidOthersVideo: () => Promise<void>
Valor de Propriedade
() => Promise<void>
forbidVideo
Proíbe vídeo para os IDs de usuário especificados.
forbidVideo: (userIds: string[]) => Promise<void>
Valor de Propriedade
(userIds: string[]) => Promise<void>
permitAudio
Permite áudio para os IDs de usuário especificados.
permitAudio: (userIds: string[]) => Promise<void>
Valor de Propriedade
(userIds: string[]) => Promise<void>
permitOthersAudio
permite áudio para participantes da reunião do Teams, exceto o usuário local.
permitOthersAudio: () => Promise<void>
Valor de Propriedade
() => Promise<void>
permitOthersVideo
permite vídeo para participantes da reunião do Teams, exceto o usuário local.
permitOthersVideo: () => Promise<void>
Valor de Propriedade
() => Promise<void>
permitVideo
Permite vídeo para os IDs de usuário especificados.
permitVideo: (userIds: string[]) => Promise<void>
Valor de Propriedade
(userIds: string[]) => Promise<void>
sendDtmfTone
Enviar tom DTMF para outro participante da chamada em chamadas 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Valor de Propriedade
(dtmfTone: DtmfTone) => Promise<void>
sendRealTimeText
Enviar texto em tempo real
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Valor de Propriedade
(text: string, isFinalized: boolean) => Promise<void>
Detalhes do Método Herdado
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parâmetros
- participant
- CommunicationUserIdentifier
Devoluções
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Adiciona um novo Participante à chamada.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parâmetros
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Devoluções
Promise<void>
askDevicePermission(PermissionConstraints)
Peça permissões de dispositivos.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
Parâmetros
- constrain
- PermissionConstraints
Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Devoluções
Promise<DeviceAccess>
Observações
A janela de permissão do navegador aparecerá se as permissões ainda não tiverem sido concedidas.
herdado de CallWithChatAdapterManagement.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ósito.
createTogetherModeStreamView(TogetherModeStreamOptions)
Crie a visualização html para um fluxo togethermode.
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>
Parâmetros
- options
- TogetherModeStreamOptions
Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Devoluções
Promise<void | TogetherModeStreamViewResult>
Observações
Este método é implementado para compósitos
Herdado deCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
dispose()
disposeLocalVideoStreamView()
Eliminar a vista html para um fluxo de vídeo local
function disposeLocalVideoStreamView(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
Descarte a visualização html para um fluxo de vídeo remoto
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>
Parâmetros
- remoteUserId
-
string
Identificação do participante a dispor
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
Eliminar a vista html para um fluxo de partilha de ecrã
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>
Parâmetros
- remoteUserId
-
string
Id do participante para descartar a visualização de fluxo de compartilhamento de tela.
Devoluções
Promise<void>
Observações
Este método é implementado para composto
Herdado deCallWithChatAdapterManagement.disposeScreenShareStreamView
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ósito.
disposeTogetherModeStreamView()
Descarte a exibição html para um fluxo togethermode.
function disposeTogetherModeStreamView(): Promise<void>
Devoluções
Promise<void>
Observações
Este método é implementado para compósitos
Herdado deCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parâmetros
- resourceDetails
- ResourceDetails
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
getState()
Obter o estado atual
function getState(): CallWithChatAdapterState
Devoluções
holdCall()
Coloca a chamada em um localhold.
function holdCall(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.holdCall
joinCall(boolean)
Aviso
Esta API foi preterida.
Use joinCall(options?:JoinCallOptions) instead.
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
herdado deCallWithChatAdapterManagement.joinCall
joinCall(JoinCallOptions)
Junte-se à chamada com o saco de opções para definir o estado inicial do microfone/câmara ao aderir à chamada true = ligar o dispositivo ao aderir à chamada false = desligar o dispositivo ao aderir à chamada 'manter'/undefined = reter o estado de pré-chamada dos dispositivos
function joinCall(options?: JoinCallOptions): undefined | Call
Parâmetros
- options
- JoinCallOptions
param para definir microfone / câmera inicialmente on / off / use o estado de pré-chamada.
Devoluções
undefined | Call
herdado deCallWithChatAdapterManagement.joinCall
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 deCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Carregue mais mensagens anteriores no histórico de conversas de chat.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parâmetros
- messagesToLoad
-
number
Devoluções
Promise<boolean>
Observações
Este método é geralmente usado para controlar a busca incremental/rolagem infinita.
herdado deCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Mão inferior para o usuário local.
function lowerHand(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.lowerHand
mute()
muteAllRemoteParticipants()
Silenciar um participante
function muteAllRemoteParticipants(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Silenciar um participante
function muteParticipant(userId: string): Promise<void>
Parâmetros
- userId
-
string
Devoluções
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
herdado deCallWithChatAdapterSubscriptions.off
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parâmetros
- event
-
"callEnded"
- listener
- CallEndedListener
herdado deCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parâmetros
- event
-
"callError"
- listener
-
(e: AdapterError) => void
herdado deCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parâmetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parâmetros
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
herdado deCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parâmetros
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
herdado deCallWithChatAdapterSubscriptions.off
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parâmetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
herdado deCallWithChatAdapterSubscriptions.off
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
Parâmetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
herdado deCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parâmetros
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
herdado deCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parâmetros
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
herdado deCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parâmetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
herdado deCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parâmetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parâmetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
herdado deCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parâmetros
- event
-
"messageRead"
- listener
- MessageReadListener
herdado deCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageReceived"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageSent"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
herdado deCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
herdado deCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
herdado deCallWithChatAdapterSubscriptions.off
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
herdado deCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
herdado deCallWithChatAdapterSubscriptions.on
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parâmetros
- event
-
"callEnded"
- listener
- CallEndedListener
herdado deCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parâmetros
- event
-
"callError"
- listener
-
(e: AdapterError) => void
herdado deCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parâmetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parâmetros
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
herdado deCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parâmetros
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
herdado deCallWithChatAdapterSubscriptions.on
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parâmetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
herdado deCallWithChatAdapterSubscriptions.on
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
Parâmetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
herdado deCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parâmetros
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
herdado deCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parâmetros
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
herdado deCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parâmetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
herdado deCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parâmetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parâmetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
herdado deCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parâmetros
- event
-
"messageRead"
- listener
- MessageReadListener
herdado deCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageReceived"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parâmetros
- event
-
"messageSent"
- listener
- MessageReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
herdado deCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
herdado deCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
herdado deCallWithChatAdapterSubscriptions.on
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
herdado deCallWithChatAdapterSubscriptions.on
onReactionClick(Reaction)
Enviar Reação para a reunião em curso.
function onReactionClick(reaction: Reaction): Promise<void>
Parâmetros
- reaction
- Reaction
Um valor do tipo <xref:%40azure%2Fcommunication-calling%23Reaction>
Devoluções
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
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()
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()
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()
raiseHand()
Levante a mão para o usuário local.
function raiseHand(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.raiseHand
removeParticipant(CommunicationIdentifier)
Remova um participante da chamada.
function removeParticipant(participant: CommunicationIdentifier): Promise<void>
Parâmetros
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> do participante a remover
Devoluções
Promise<void>
removeParticipant(string)
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parâmetros
- resourceDetails
- ResourceDetails
Herdado deCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Retoma a chamada de um estado LocalHold.
function resumeCall(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.resumeCall
returnFromBreakoutRoom()
Chamada de retorno à origem da sala de breakout
function returnFromBreakoutRoom(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.returnFromBreakoutRoom
sendMessage(string, SendMessageOptions)
Envie uma mensagem no tópico.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parâmetros
- content
-
string
- options
- SendMessageOptions
Devoluções
Promise<void>
sendReadReceipt(string)
sendTypingIndicator()
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>
setCaptionLanguage(string)
Função para definir o idioma da legenda
function setCaptionLanguage(language: string): Promise<void>
Parâmetros
- language
-
string
Idioma definido para legenda
Devoluções
Promise<void>
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>
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>
setSpokenLanguage(string)
Função para definir a linguagem falada
function setSpokenLanguage(language: string): Promise<void>
Parâmetros
- language
-
string
Língua falada
Devoluções
Promise<void>
setTogetherModeSceneSize(number, number)
Recalcule as posições sentadas para o modo em conjunto.
function setTogetherModeSceneSize(width: number, height: number)
Parâmetros
- width
-
number
Largura do contentor
- height
-
number
Altura do contentor
Observações
Este método é implementado para compósitos
Herdado deCallWithChatAdapterManagement.setTogetherModeSceneSize
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Inicie a chamada.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parâmetros
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Uma matriz de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser chamada
- options
- StartCallOptions
Devoluções
undefined | Call
herdado doCallWithChatAdapterManagement.startCall
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
herdado doCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Inicie a câmara.
Esse método começará a renderizar uma exibição de câmera 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>
startCaptions(StartCaptionsAdapterOptions)
Função para iniciar legendas
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>
Parâmetros
- options
- StartCaptionsAdapterOptions
Opções para legendas de início
Devoluções
Promise<void>
startNoiseSuppressionEffect()
Inicie o efeito de supressão de ruído.
function startNoiseSuppressionEffect(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
startSpotlight(string[])
Comece em destaque
function startSpotlight(userIds?: string[]): Promise<void>
Parâmetros
- userIds
-
string[]
Devoluções
Promise<void>
startTogetherMode()
Iniciar o modo de conjunto.
function startTogetherMode(): Promise<void>
Devoluções
Promise<void>
Observações
Este método é implementado para compósitos
startVideoBackgroundEffect(VideoBackgroundEffect)
Inicie o efeito de fundo do vídeo.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parâmetros
- videoBackgroundEffect
- VideoBackgroundEffect
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.startVideoBackgroundEffect
stopAllSpotlight()
Pare todos os holofotes
function stopAllSpotlight(): Promise<void>
Devoluções
Promise<void>
stopCamera()
stopCaptions(StopCaptionsAdapterOptions)
Diversão para parar legendas
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parâmetros
- options
- StopCaptionsAdapterOptions
Devoluções
Promise<void>
stopNoiseSuppressionEffect()
Inicie o efeito de supressão de ruído.
function stopNoiseSuppressionEffect(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.stopNoiseSuppressionEffect
stopScreenShare()
stopSpotlight(string[])
Pare o holofote
function stopSpotlight(userIds?: string[]): Promise<void>
Parâmetros
- userIds
-
string[]
Devoluções
Promise<void>
stopVideoBackgroundEffects()
Pare o efeito de fundo do vídeo.
function stopVideoBackgroundEffects(): Promise<void>
Devoluções
Promise<void>
Herdado deCallWithChatAdapterManagement.stopVideoBackgroundEffects
submitSurvey(CallSurvey)
Enviar o resultado da pesquisa de fim de chamada
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
Parâmetros
- survey
- CallSurvey
Devoluções
Promise<undefined | CallSurveyResponse>
unmute()
updateBackgroundPickerImages(VideoBackgroundImage[])
Substitua as imagens do seletor de plano de fundo para obter o efeito de substituição de plano de fundo.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
Parâmetros
- backgroundImages
Matriz de imagens de fundo personalizadas.
Herdado deCallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Atualizar o efeito de fundo de vídeo selecionado
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parâmetros
- selectedVideoBackground
- VideoBackgroundEffect
Herdado deCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect