Condividi tramite


CallWithChatAdapter interface

CallWithChatComposite Interfaccia adattatore.

Extends

Proprietà ereditate

forbidAudio

Vieta l'audio per gli ID utente specificati.

forbidOthersAudio

vieta l'audio per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

forbidOthersVideo

vieta il video per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

forbidVideo

Vieta il video per gli ID utente specificati.

permitAudio

Consente l'audio per gli ID utente specificati.

permitOthersAudio

consente l'audio per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

permitOthersVideo

consente il video per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

permitVideo

Consente il video per gli ID utente specificati.

sendDtmfTone

Invia il tono DTMF a un altro partecipante alla chiamata in chiamate 1:1

sendRealTimeText

Invia testo in tempo reale

Metodi ereditati

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Aggiunge un nuovo partecipante alla chiamata.

askDevicePermission(PermissionConstraints)

Richiedere le autorizzazioni dei dispositivi.

createStreamView(string, VideoStreamOptions)

Creare la visualizzazione HTML per un flusso.

createTogetherModeStreamView(TogetherModeStreamOptions)

Creare la visualizzazione html per un flusso in modalità combinata.

deleteMessage(string)

Eliminare un messaggio nel thread.

dispose()

Eliminare il composito

disposeLocalVideoStreamView()

Disporre la visualizzazione html per un flusso video locale

disposeRemoteVideoStreamView(string)

Eliminare la visualizzazione html per un flusso video remoto

disposeScreenShareStreamView(string)

Disporre la visualizzazione html per un flusso di condivisione dello schermo

disposeStreamView(string, VideoStreamOptions)

Eliminare la visualizzazione HTML per un flusso.

disposeTogetherModeStreamView()

Disporre la visualizzazione html per un flusso in modalità combinata.

downloadResourceToCache(ResourceDetails)
fetchInitialData()

Recuperare lo stato iniziale per l'adapter Chat.

Esegue il recupero minimo necessario per i metodi ChatComposite e API.

getState()

Ottenere lo stato corrente

holdCall()

Inserisce la chiamata in un blocco locale.

joinCall(boolean)

Partecipa alla chiamata con il microfono inizialmente attivato/disattivato.

joinCall(JoinCallOptions)

Partecipa alla chiamata con la borsa delle opzioni per impostare lo stato iniziale del microfono/fotocamera quando si accede alla chiamata true = accendi il dispositivo quando ti unisci alla chiamata false = spegni il dispositivo quando ti unisci alla chiamata 'mantieni'/undefined = mantieni lo stato di prechiamata dei dispositivi

leaveCall(boolean)

Lasciare la chiamata.

loadPreviousChatMessages(number)

Caricare più messaggi precedenti nella cronologia dei thread di chat.

lowerHand()

Mano inferiore per l'utente locale.

mute()

Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale.

muteAllRemoteParticipants()

Disattivare l'audio di un partecipante

muteParticipant(string)

Disattivare l'audio di un partecipante

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)

Annulla la sottoscrizione del gestore agli eventi stateChanged.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)

Invia reazione alla riunione in corso.

onStateChange((state: CallWithChatAdapterState) => void)

Sottoscrive il gestore per gli eventi stateChanged.

queryCameras()

Eseguire una query per i dispositivi fotocamera disponibili.

queryMicrophones()

Eseguire una query per i dispositivi microfoni disponibili.

querySpeakers()

Eseguire una query per i dispositivi microfoni disponibili.

raiseHand()

Alzi la mano per l'utente locale.

removeParticipant(CommunicationIdentifier)

Rimuovere un partecipante dalla chiamata.

removeParticipant(string)

Rimuovere un partecipante da una chiamata.

removeResourceFromCache(ResourceDetails)
resumeCall()

Riprende la chiamata da uno stato LocalHold.

returnFromBreakoutRoom()

Ritorno al richiamo di origine della stanza per sottogruppi di lavoro

sendMessage(string, SendMessageOptions)

Inviare un messaggio nel thread.

sendReadReceipt(string)

Inviare una ricevuta di lettura per un messaggio.

sendTypingIndicator()

Inviare l'indicatore di digitazione nel thread.

setCamera(VideoDeviceInfo, VideoStreamOptions)

Impostare la fotocamera da usare nella chiamata.

setCaptionLanguage(string)

Funzione per impostare la lingua dei sottotitoli

setMicrophone(AudioDeviceInfo)

Impostare il microfono da usare nella chiamata.

setSpeaker(AudioDeviceInfo)

Impostare l'altoparlante da usare nella chiamata.

setSpokenLanguage(string)

Funzione per impostare la lingua parlata

setTogetherModeSceneSize(number, number)

Ricalcolare le posizioni di seduta per la modalità insieme.

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Avviare la chiamata.

startCall(string[], StartCallOptions)

Avviare la chiamata.

startCamera(VideoStreamOptions)

Avviare la fotocamera.

Questo metodo inizierà a eseguire il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.

startCaptions(StartCaptionsAdapterOptions)

Funzione per avviare i sottotitoli

startNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

startScreenShare()

Iniziare a condividere la schermata durante una chiamata.

startSpotlight(string[])

Avvia riflettore

startTogetherMode()

Modalità Avvia insieme.

startVideoBackgroundEffect(VideoBackgroundEffect)

Avvia l'effetto di sfondo del video.

stopAllSpotlight()

Arrestare tutti i riflettori

stopCamera()

Arresta la fotocamera.

Questo metodo interromperà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.

stopCaptions(StopCaptionsAdapterOptions)

Funzione per interrompere le didascalie

stopNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

stopScreenShare()

Interrompere la condivisione dello schermo.

stopSpotlight(string[])

Riflettore di arresto

stopVideoBackgroundEffects()

Interrompi l'effetto di sfondo del video.

submitSurvey(CallSurvey)

Invia il risultato del sondaggio di fine chiamata

unmute()

Annullare l'audio dell'utente corrente durante la chiamata o abilitare il microfono in locale.

updateBackgroundPickerImages(VideoBackgroundImage[])

Sostituisci le immagini del selettore di sfondo per l'effetto di sostituzione dello sfondo.

updateMessage(string, string, Record<string, string>)

Aggiornare il contenuto di un messaggio.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aggiorna l'effetto di sfondo del video selezionato

Dettagli proprietà ereditate

forbidAudio

Vieta l'audio per gli ID utente specificati.

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

Valore della proprietà

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

Ereditato daCallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

vieta l'audio per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

forbidOthersAudio: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

vieta il video per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

forbidOthersVideo: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

Vieta il video per gli ID utente specificati.

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

Valore della proprietà

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

Ereditato daCallWithChatAdapterManagement.forbidVideo

permitAudio

Consente l'audio per gli ID utente specificati.

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

Valore della proprietà

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

Ereditato daCallWithChatAdapterManagement.permitAudio

permitOthersAudio

consente l'audio per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

permitOthersAudio: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

consente il video per i partecipanti alla riunione di Teams, ad eccezione dell'utente locale.

permitOthersVideo: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCallWithChatAdapterManagement.permitOthersVideo

permitVideo

Consente il video per gli ID utente specificati.

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

Valore della proprietà

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

Ereditato daCallWithChatAdapterManagement.permitVideo

sendDtmfTone

Invia il tono DTMF a un altro partecipante alla chiamata in chiamate 1:1

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

Valore della proprietà

(dtmfTone: DtmfTone) => Promise<void>

Ereditato daCallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

Invia testo in tempo reale

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

Valore della proprietà

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

Ereditato daCallWithChatAdapterManagement.sendRealTimeText

Dettagli dei metodi ereditati

addParticipant(CommunicationUserIdentifier)

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

Parametri

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Aggiunge un nuovo partecipante alla chiamata.

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

Parametri

participant
PhoneNumberIdentifier

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.addParticipant

askDevicePermission(PermissionConstraints)

Richiedere le autorizzazioni dei dispositivi.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

Parametri

constrain
PermissionConstraints

Definire i vincoli per l'accesso ai dispositivi locali <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Restituisce

Promise<DeviceAccess>

Commenti

Verrà visualizzata la finestra delle autorizzazioni del browser se le autorizzazioni non sono ancora concesse.

Ereditato daCallWithChatAdapterManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Creare la visualizzazione HTML per un flusso.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parametri

remoteUserId

string

ID del partecipante di cui eseguire il rendering, lasciarlo non definito per creare la visualizzazione della fotocamera locale

options
VideoStreamOptions

Opzioni per controllare la modalità di rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void | CreateVideoStreamViewResult>

Commenti

Questo metodo viene implementato per composito.

Ereditato daCallWithChatAdapterManagement.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Creare la visualizzazione html per un flusso in modalità combinata.

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

Parametri

options
TogetherModeStreamOptions

Opzioni per controllare la modalità di rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Commenti

Questo metodo viene implementato per composito

Ereditato daCallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Eliminare un messaggio nel thread.

function deleteMessage(messageId: string): Promise<void>

Parametri

messageId

string

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.deleteMessage

dispose()

Eliminare il composito

function dispose()

Ereditato daDisposable_2.dispose

disposeLocalVideoStreamView()

Disporre la visualizzazione html per un flusso video locale

function disposeLocalVideoStreamView(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Eliminare la visualizzazione html per un flusso video remoto

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parametri

remoteUserId

string

ID del partecipante di cui disporre

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Disporre la visualizzazione html per un flusso di condivisione dello schermo

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parametri

remoteUserId

string

ID del partecipante per cui smaltire la visualizzazione del flusso di condivisione dello schermo.

Restituisce

Promise<void>

Commenti

Questo metodo è implementato per i compositi

Ereditato daCallWithChatAdapterManagement.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Eliminare la visualizzazione HTML per un flusso.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parametri

remoteUserId

string

ID del partecipante di cui eseguire il rendering, lasciarlo non definito per eliminare la visualizzazione della fotocamera locale

options
VideoStreamOptions

Opzioni per controllare la modalità di rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito.

Ereditato daCallWithChatAdapterManagement.disposeStreamView

disposeTogetherModeStreamView()

Disporre la visualizzazione html per un flusso in modalità combinata.

function disposeTogetherModeStreamView(): Promise<void>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parametri

resourceDetails
ResourceDetails

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.downloadResourceToCache

fetchInitialData()

Recuperare lo stato iniziale per l'adapter Chat.

Esegue il recupero minimo necessario per i metodi ChatComposite e API.

function fetchInitialData(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.fetchInitialData

getState()

Ottenere lo stato corrente

function getState(): CallWithChatAdapterState

Restituisce

Ereditato daAdapterState.getState

holdCall()

Inserisce la chiamata in un blocco locale.

function holdCall(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.holdCall

joinCall(boolean)

Avviso

Questa API è ora deprecata.

Use joinCall(options?:JoinCallOptions) instead.

Partecipa alla chiamata con il microfono inizialmente attivato/disattivato.

function joinCall(microphoneOn?: boolean): undefined | Call

Parametri

microphoneOn

boolean

Indica se il microfono è inizialmente abilitato

Restituisce

undefined | Call

Ereditato daCallWithChatAdapterManagement.joinCall

joinCall(JoinCallOptions)

Partecipa alla chiamata con la borsa delle opzioni per impostare lo stato iniziale del microfono/fotocamera quando si accede alla chiamata true = accendi il dispositivo quando ti unisci alla chiamata false = spegni il dispositivo quando ti unisci alla chiamata 'mantieni'/undefined = mantieni lo stato di prechiamata dei dispositivi

function joinCall(options?: JoinCallOptions): undefined | Call

Parametri

options
JoinCallOptions

Param per impostare inizialmente lo stato di attivazione/disattivazione / utilizzo dello stato di prechiamata del microfono/della fotocamera.

Restituisce

undefined | Call

Ereditato daCallWithChatAdapterManagement.joinCall

leaveCall(boolean)

Lasciare la chiamata.

function leaveCall(forEveryone?: boolean): Promise<void>

Parametri

forEveryone

boolean

Se rimuovere tutti i partecipanti all'uscita

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.leaveCall

loadPreviousChatMessages(number)

Caricare più messaggi precedenti nella cronologia dei thread di chat.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parametri

messagesToLoad

number

Restituisce

Promise<boolean>

Commenti

Questo metodo viene in genere usato per controllare lo scorrimento incrementale di recupero/infinito.

Ereditato daCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Mano inferiore per l'utente locale.

function lowerHand(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.lowerHand

mute()

Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale.

function mute(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Disattivare l'audio di un partecipante

function muteAllRemoteParticipants(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Disattivare l'audio di un partecipante

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

Parametri

userId

string

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametri

event

"breakoutRoomsUpdated"

Ereditato daCallWithChatAdapterSubscriptions.off

off("callEnded", CallEndedListener)

function off(event: "callEnded", listener: CallEndedListener)

Parametri

event

"callEnded"

Ereditato daCallWithChatAdapterSubscriptions.off

off("callError", (e: AdapterError) => void)

function off(event: "callError", listener: (e: AdapterError) => void)

Parametri

event

"callError"

listener

(e: AdapterError) => void

Ereditato daCallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parametri

event

"callIdChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parametri

event

"callParticipantsJoined"

Ereditato daCallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parametri

event

"callParticipantsLeft"

Ereditato daCallWithChatAdapterSubscriptions.off

off("capabilitiesChanged", CapabilitiesChangedListener)

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametri

event

"capabilitiesChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("captionsReceived", CaptionsReceivedListener)

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametri

event

"captionsReceived"

Ereditato daCallWithChatAdapterSubscriptions.off

off("chatError", (e: AdapterError) => void)

function off(event: "chatError", listener: (e: AdapterError) => void)

Parametri

event

"chatError"

listener

(e: AdapterError) => void

Ereditato daCallWithChatAdapterSubscriptions.off

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Parametri

event

"chatInitialized"

Ereditato daCallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametri

event

"chatParticipantsAdded"

Ereditato daCallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametri

event

"chatParticipantsRemoved"

Ereditato daCallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parametri

event

"displayNameChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametri

event

"isCaptionLanguageChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametri

event

"isCaptionsActiveChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametri

event

"isLocalScreenSharingActiveChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Parametri

event

"isMutedChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parametri

event

"isSpeakingChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametri

event

"isSpokenLanguageChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Parametri

event

"messageDeleted"

Ereditato daCallWithChatAdapterSubscriptions.off

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Parametri

event

"messageEdited"

Ereditato daCallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Parametri

event

"messageRead"

Ereditato daCallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Parametri

event

"messageReceived"

Ereditato daCallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Parametri

event

"messageSent"

Ereditato daCallWithChatAdapterSubscriptions.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametri

event

"realTimeTextReceived"

Ereditato daCallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parametri

event

"selectedMicrophoneChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parametri

event

"selectedSpeakerChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

off("spotlightChanged", SpotlightChangedListener)

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametri

event

"spotlightChanged"

Ereditato daCallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

Annulla la sottoscrizione del gestore agli eventi stateChanged.

function offStateChange(handler: (state: CallWithChatAdapterState) => void)

Parametri

handler

(state: CallWithChatAdapterState) => void

Ereditato daAdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametri

event

"breakoutRoomsUpdated"

Ereditato daCallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

function on(event: "callEnded", listener: CallEndedListener)

Parametri

event

"callEnded"

Ereditato daCallWithChatAdapterSubscriptions.on

on("callError", (e: AdapterError) => void)

function on(event: "callError", listener: (e: AdapterError) => void)

Parametri

event

"callError"

listener

(e: AdapterError) => void

Ereditato daCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parametri

event

"callIdChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parametri

event

"callParticipantsJoined"

Ereditato daCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parametri

event

"callParticipantsLeft"

Ereditato daCallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametri

event

"capabilitiesChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametri

event

"captionsReceived"

Ereditato daCallWithChatAdapterSubscriptions.on

on("chatError", (e: AdapterError) => void)

function on(event: "chatError", listener: (e: AdapterError) => void)

Parametri

event

"chatError"

listener

(e: AdapterError) => void

Ereditato daCallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Parametri

event

"chatInitialized"

Ereditato daCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametri

event

"chatParticipantsAdded"

Ereditato daCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametri

event

"chatParticipantsRemoved"

Ereditato daCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parametri

event

"displayNameChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametri

event

"isCaptionLanguageChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametri

event

"isCaptionsActiveChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametri

event

"isLocalScreenSharingActiveChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Parametri

event

"isMutedChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parametri

event

"isSpeakingChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametri

event

"isSpokenLanguageChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Parametri

event

"messageDeleted"

Ereditato daCallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Parametri

event

"messageEdited"

Ereditato daCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Parametri

event

"messageRead"

Ereditato daCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Parametri

event

"messageReceived"

Ereditato daCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Parametri

event

"messageSent"

Ereditato daCallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametri

event

"realTimeTextReceived"

Ereditato daCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parametri

event

"selectedMicrophoneChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parametri

event

"selectedSpeakerChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametri

event

"spotlightChanged"

Ereditato daCallWithChatAdapterSubscriptions.on

onReactionClick(Reaction)

Invia reazione alla riunione in corso.

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

Parametri

reaction
Reaction

Un valore di tipo <xref:%40azure%2Fcommunication-calling%23Reaction>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Sottoscrive il gestore per gli eventi stateChanged.

function onStateChange(handler: (state: CallWithChatAdapterState) => void)

Parametri

handler

(state: CallWithChatAdapterState) => void

Ereditato daAdapterState.onStateChange

queryCameras()

Eseguire una query per i dispositivi fotocamera disponibili.

function queryCameras(): Promise<VideoDeviceInfo[]>

Restituisce

Promise<VideoDeviceInfo[]>

Matrice di entità di informazioni sul dispositivo video <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Commenti

Questo metodo deve essere chiamato dopo askDevicePermission()

Ereditato daCallWithChatAdapterManagement.queryCameras

queryMicrophones()

Eseguire una query per i dispositivi microfoni disponibili.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Restituisce

Promise<AudioDeviceInfo[]>

Matrice di entità di informazioni sul dispositivo audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Commenti

Questo metodo deve essere chiamato dopo askDevicePermission()

Ereditato daCallWithChatAdapterManagement.queryMicrophones

querySpeakers()

Eseguire una query per i dispositivi microfoni disponibili.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Restituisce

Promise<AudioDeviceInfo[]>

Matrice di entità di informazioni sul dispositivo audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Commenti

Questo metodo deve essere chiamato dopo askDevicePermission()

Ereditato daCallWithChatAdapterManagement.querySpeakers

raiseHand()

Alzi la mano per l'utente locale.

function raiseHand(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.raiseHand

removeParticipant(CommunicationIdentifier)

Rimuovere un partecipante dalla chiamata.

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

Parametri

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> del partecipante da rimuovere

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.removeParticipant

removeParticipant(string)

Rimuovere un partecipante da una chiamata.

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

Parametri

userId

string

UserId del partecipante da rimuovere.

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametri

resourceDetails
ResourceDetails

Ereditato daCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Riprende la chiamata da uno stato LocalHold.

function resumeCall(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

Ritorno al richiamo di origine della stanza per sottogruppi di lavoro

function returnFromBreakoutRoom(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.returnFromBreakoutRoom

sendMessage(string, SendMessageOptions)

Inviare un messaggio nel thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parametri

content

string

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Inviare una ricevuta di lettura per un messaggio.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parametri

chatMessageId

string

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Inviare l'indicatore di digitazione nel thread.

function sendTypingIndicator(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.sendTypingIndicator

setCamera(VideoDeviceInfo, VideoStreamOptions)

Impostare la fotocamera da usare nella chiamata.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parametri

sourceInfo
VideoDeviceInfo

Dispositivo fotocamera da scegliere, selezionarne uno restituito da queryCamera

options
VideoStreamOptions

Opzioni per controllare come viene eseguito il rendering del flusso della fotocamera <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.setCamera

setCaptionLanguage(string)

Funzione per impostare la lingua dei sottotitoli

function setCaptionLanguage(language: string): Promise<void>

Parametri

language

string

Lingua impostata per i sottotitoli

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Impostare il microfono da usare nella chiamata.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parametri

sourceInfo
AudioDeviceInfo

Dispositivo microfono da scegliere, selezionarne uno restituito da queryMicrophones

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Impostare l'altoparlante da usare nella chiamata.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parametri

sourceInfo
AudioDeviceInfo

Dispositivo altoparlante da scegliere, selezionarne uno restituito da querySpeakers

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.setSpeaker

setSpokenLanguage(string)

Funzione per impostare la lingua parlata

function setSpokenLanguage(language: string): Promise<void>

Parametri

language

string

parlato

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Ricalcolare le posizioni di seduta per la modalità insieme.

function setTogetherModeSceneSize(width: number, height: number)

Parametri

width

number

Larghezza del contenitore

height

number

Altezza del contenitore

Commenti

Questo metodo viene implementato per composito

Ereditato daCallWithChatAdapterManagement.setTogetherModeSceneSize

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Avviare la chiamata.

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

Parametri

participants

(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

Un array di <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> da chiamare

Restituisce

undefined | Call

Ereditato daCallWithChatAdapterManagement.startCall

startCall(string[], StartCallOptions)

Avviare la chiamata.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

Parametri

participants

string[]

Matrice di ID partecipante da aggiungere

Restituisce

undefined | Call

Ereditato daCallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Avviare la fotocamera.

Questo metodo inizierà a eseguire il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.

function startCamera(options?: VideoStreamOptions): Promise<void>

Parametri

options
VideoStreamOptions

Opzioni per controllare la modalità di rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funzione per avviare i sottotitoli

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parametri

options
StartCaptionsAdapterOptions

Opzioni per i sottotitoli iniziali

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

function startNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

Iniziare a condividere la schermata durante una chiamata.

function startScreenShare(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Avvia riflettore

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Modalità Avvia insieme.

function startTogetherMode(): Promise<void>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallWithChatAdapterManagement.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Avvia l'effetto di sfondo del video.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parametri

videoBackgroundEffect
VideoBackgroundEffect

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Arrestare tutti i riflettori

function stopAllSpotlight(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopAllSpotlight

stopCamera()

Arresta la fotocamera.

Questo metodo interromperà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.

function stopCamera(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funzione per interrompere le didascalie

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parametri

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

function stopNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Interrompere la condivisione dello schermo.

function stopScreenShare(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopScreenShare

stopSpotlight(string[])

Riflettore di arresto

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Interrompi l'effetto di sfondo del video.

function stopVideoBackgroundEffects(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Invia il risultato del sondaggio di fine chiamata

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

Parametri

survey
CallSurvey

Restituisce

Promise<undefined | CallSurveyResponse>

Ereditato daCallWithChatAdapterManagement.submitSurvey

unmute()

Annullare l'audio dell'utente corrente durante la chiamata o abilitare il microfono in locale.

function unmute(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Sostituisci le immagini del selettore di sfondo per l'effetto di sostituzione dello sfondo.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametri

backgroundImages

VideoBackgroundImage[]

Array di immagini di sfondo personalizzate.

Ereditato daCallWithChatAdapterManagement.updateBackgroundPickerImages

updateMessage(string, string, Record<string, string>)

Aggiornare il contenuto di un messaggio.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

Parametri

messageId

string

content

string

options

Record<string, string>

Restituisce

Promise<void>

Ereditato daCallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aggiorna l'effetto di sfondo del video selezionato

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametri

selectedVideoBackground
VideoBackgroundEffect

Ereditato daCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect