CallAdapterCallManagement interface

Pacchetto:

@azure/communication-react

Avviso

Questa API è ora deprecata.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funzionalità per la gestione della chiamata corrente o l'avvio di una nuova chiamata

Extends

CallAdapterCallOperations

Proprietà ereditate

sendRealTimeText

Invia testo in tempo reale

Metodi

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
startCall(CommunicationIdentifier[], StartCallOptions)	Avviare la chiamata.
startCall(string[], StartCallOptions)	Avviare la chiamata.

Metodi ereditati

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Aggiungere un partecipante alla chiamata.
createStreamView(string, VideoStreamOptions)	Creare la visualizzazione HTML per un flusso.
createTogetherModeStreamView(TogetherModeStreamOptions)	Creare la visualizzazione HTML per un flusso.
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()	Eliminare la visualizzazione HTML per un flusso.
forbidAudio(string[])	Vieta l'audio dei partecipanti alla riunione di Teams in base ai loro ID utente.
forbidOthersAudio()	Vieta l'audio delle riunioni di Teams.
forbidOthersVideo()	Vieta il video della riunione di Teams.
forbidVideo(string[])	Vieta ai partecipanti alle riunioni di Teams di video in base ai loro ID utente.
holdCall()	Mette in attesa la chiamata.
leaveCall(boolean)	Lasciare la chiamata
lowerHand()	Mano inferiore per l'utente corrente
mute()	Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale
muteAllRemoteParticipants()	Disattiva l'audio di tutti i partecipanti
muteParticipant(string)	Disattivare l'audio di un partecipante
onReactionClick(Reaction)	Invia emoji di reazione
permitAudio(string[])	Consenti ai partecipanti alla riunione di Teams l'audio in base ai loro ID utente.
permitOthersAudio()	Consenti l'audio della riunione di Teams.
permitOthersVideo()	Consenti il video della riunione di Teams.
permitVideo(string[])	Consenti ai partecipanti alla riunione di Teams l'audio in base ai loro ID utente.
raiseHand()	Alzi la mano per l'utente corrente
removeParticipant(CommunicationIdentifier)	Rimuovere un partecipante dalla chiamata.
removeParticipant(string)	Rimuovere un partecipante dalla chiamata.
resumeCall()	Riprende la chiamata da uno LocalHold stato.
returnFromBreakoutRoom()	Ritorno al richiamo di origine della stanza per sottogruppi di lavoro
sendDtmfTone(DtmfTone)	inviare un tono DTMF a un altro partecipante in una chiamata PSTN 1:1
setCaptionLanguage(string)	Funzione per impostare la lingua dei sottotitoli
setSpokenLanguage(string)	Funzione per impostare la lingua parlata
setTogetherModeSceneSize(number, number)	Ricalcolare le posizioni di seduta per la modalità insieme.
startCamera(VideoStreamOptions)	Avviare la fotocamera Questo metodo avvierà 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 Spotlight per i partecipanti locali e remoti in base ai loro ID utente. Se non viene passato alcun array di ID utente, viene eseguita un'azione sul partecipante locale.
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()	Arresta l'effetto di soppressione del rumore.
stopScreenShare()	Interrompere la condivisione dello schermo
stopSpotlight(string[])	Arresta l'spotlight per i partecipanti locali e remoti in base ai loro ID utente. Se non viene passato alcun array di ID utente, viene eseguita un'azione sul partecipante locale.
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.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Aggiorna l'effetto di sfondo del video selezionato.

Dettagli proprietà ereditate

sendRealTimeText

Invia testo in tempo reale

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

Valore della proprietà

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

Ereditato daCallAdapterCallOperations.sendRealTimeText

Dettagli metodo

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

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

startCall(CommunicationIdentifier[], StartCallOptions)

Avviare la chiamata.

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

Parametri

participants

CommunicationIdentifier[]

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

options

StartCallOptions

Restituisce

undefined | Call

startCall(string[], StartCallOptions)

Avviare la chiamata.

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

Parametri

participants

string[]

Matrice di ID partecipante da aggiungere

options

StartCallOptions

Restituisce

undefined | Call

Dettagli dei metodi ereditati

addParticipant(CommunicationUserIdentifier)

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

Parametri

participant

CommunicationUserIdentifier

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Aggiungere un partecipante alla chiamata.

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

Parametri

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.addParticipant

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 daCallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Creare la visualizzazione HTML per un flusso.

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

Promise<void | TogetherModeStreamViewResult>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallAdapterCallOperations.createTogetherModeStreamView

disposeLocalVideoStreamView()

Disporre la visualizzazione html per un flusso video locale

function disposeLocalVideoStreamView(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.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 daCallAdapterCallOperations.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 daCallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Avviso

Questa API è ora deprecata.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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 daCallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

Eliminare la visualizzazione HTML per un flusso.

function disposeTogetherModeStreamView(): Promise<void>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

Vieta l'audio dei partecipanti alla riunione di Teams in base ai loro ID utente.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Vieta l'audio delle riunioni di Teams.

function forbidOthersAudio(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Vieta il video della riunione di Teams.

function forbidOthersVideo(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

Vieta ai partecipanti alle riunioni di Teams di video in base ai loro ID utente.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.forbidVideo

holdCall()

Mette in attesa la chiamata.

function holdCall(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.holdCall

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 daCallAdapterCallOperations.leaveCall

lowerHand()

Mano inferiore per l'utente corrente

function lowerHand(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.lowerHand

mute()

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

function mute(): Promise<void>

Restituisce

Promise<void>

ereditato daCallAdapterCallOperations.mute

muteAllRemoteParticipants()

Disattiva l'audio di tutti i partecipanti

function muteAllRemoteParticipants(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

Disattivare l'audio di un partecipante

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

Parametri

userId

string

ID del partecipante da disattivare

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.muteParticipant

onReactionClick(Reaction)

Invia emoji di reazione

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

Parametri

reaction

Reaction

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.onReactionClick

permitAudio(string[])

Consenti ai partecipanti alla riunione di Teams l'audio in base ai loro ID utente.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.permitAudio

permitOthersAudio()

Consenti l'audio della riunione di Teams.

function permitOthersAudio(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Consenti il video della riunione di Teams.

function permitOthersVideo(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

Consenti ai partecipanti alla riunione di Teams l'audio in base ai loro ID utente.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.permitVideo

raiseHand()

Alzi la mano per l'utente corrente

function raiseHand(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.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 daCallAdapterCallOperations.removeParticipant

removeParticipant(string)

Rimuovere un partecipante dalla chiamata.

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

Parametri

userId

string

ID del partecipante da rimuovere

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.removeParticipant

resumeCall()

Riprende la chiamata da uno LocalHold stato.

function resumeCall(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Ritorno al richiamo di origine della stanza per sottogruppi di lavoro

function returnFromBreakoutRoom(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

inviare un tono DTMF a un altro partecipante in una chiamata PSTN 1:1

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Parametri

dtmfTone

DtmfTone

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.sendDtmfTone

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 daCallAdapterCallOperations.setCaptionLanguage

setSpokenLanguage(string)

Funzione per impostare la lingua parlata

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

Parametri

language

string

parlato

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.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 daCallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Avviare la fotocamera Questo metodo avvierà 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 daCallAdapterCallOperations.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 daCallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

function startNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Iniziare a condividere la schermata durante una chiamata.

function startScreenShare(): Promise<void>

Restituisce

Promise<void>

ereditato daCallAdapterCallOperations.startScreenShare

startSpotlight(string[])

Avvia Spotlight per i partecipanti locali e remoti in base ai loro ID utente. Se non viene passato alcun array di ID utente, viene eseguita un'azione sul partecipante locale.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startSpotlight

startTogetherMode()

Modalità Avvia insieme.

function startTogetherMode(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Avvia l'effetto di sfondo del video.

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

Parametri

videoBackgroundEffect

VideoBackgroundEffect

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Arrestare tutti i riflettori

function stopAllSpotlight(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.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 daCallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funzione per interrompere le didascalie

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

Parametri

options

StopCaptionsAdapterOptions

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Arresta l'effetto di soppressione del rumore.

function stopNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Interrompere la condivisione dello schermo

function stopScreenShare(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

Arresta l'spotlight per i partecipanti locali e remoti in base ai loro ID utente. Se non viene passato alcun array di ID utente, viene eseguita un'azione sul partecipante locale.

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

Parametri

userIds

string[]

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Interrompi l'effetto di sfondo del video.

function stopVideoBackgroundEffects(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.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 daCallAdapterCallOperations.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 daCallAdapterCallOperations.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 daCallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aggiorna l'effetto di sfondo del video selezionato.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametri

selectedVideoBackground

VideoBackgroundEffect

Ereditato daCallAdapterCallOperations.updateSelectedVideoBackgroundEffect