CallAdapterCallOperations interface

Pacchetto:

@azure/communication-react

Funzionalità per la gestione della chiamata corrente.

Proprietà

sendRealTimeText

Invia testo in tempo reale

Metodi

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à

sendRealTimeText

Invia testo in tempo reale

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

Valore della proprietà

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

Dettagli metodo

addParticipant(CommunicationUserIdentifier)

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

Parametri

participant

CommunicationUserIdentifier

Restituisce

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Aggiungere un partecipante alla chiamata.

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

Parametri

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Restituisce

Promise<void>

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

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

disposeLocalVideoStreamView()

Disporre la visualizzazione html per un flusso video locale

function disposeLocalVideoStreamView(): Promise<void>

Restituisce

Promise<void>

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>

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

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

disposeTogetherModeStreamView()

Eliminare la visualizzazione HTML per un flusso.

function disposeTogetherModeStreamView(): Promise<void>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito

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>

forbidOthersAudio()

Vieta l'audio delle riunioni di Teams.

function forbidOthersAudio(): Promise<void>

Restituisce

Promise<void>

forbidOthersVideo()

Vieta il video della riunione di Teams.

function forbidOthersVideo(): Promise<void>

Restituisce

Promise<void>

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>

holdCall()

Mette in attesa la chiamata.

function holdCall(): Promise<void>

Restituisce

Promise<void>

leaveCall(boolean)

Lasciare la chiamata

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

Parametri

forEveryone

boolean

Se rimuovere tutti i partecipanti all'uscita

Restituisce

Promise<void>

lowerHand()

Mano inferiore per l'utente corrente

function lowerHand(): Promise<void>

Restituisce

Promise<void>

mute()

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

function mute(): Promise<void>

Restituisce

Promise<void>

muteAllRemoteParticipants()

Disattiva l'audio di tutti i partecipanti

function muteAllRemoteParticipants(): Promise<void>

Restituisce

Promise<void>

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>

onReactionClick(Reaction)

Invia emoji di reazione

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

Parametri

reaction

Reaction

Restituisce

Promise<void>

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>

permitOthersAudio()

Consenti l'audio della riunione di Teams.

function permitOthersAudio(): Promise<void>

Restituisce

Promise<void>

permitOthersVideo()

Consenti il video della riunione di Teams.

function permitOthersVideo(): Promise<void>

Restituisce

Promise<void>

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>

raiseHand()

Alzi la mano per l'utente corrente

function raiseHand(): Promise<void>

Restituisce

Promise<void>

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>

removeParticipant(string)

Rimuovere un partecipante dalla chiamata.

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

Parametri

userId

string

ID del partecipante da rimuovere

Restituisce

Promise<void>

resumeCall()

Riprende la chiamata da uno LocalHold stato.

function resumeCall(): Promise<void>

Restituisce

Promise<void>

returnFromBreakoutRoom()

Ritorno al richiamo di origine della stanza per sottogruppi di lavoro

function returnFromBreakoutRoom(): Promise<void>

Restituisce

Promise<void>

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>

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>

setSpokenLanguage(string)

Funzione per impostare la lingua parlata

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

Parametri

language

string

parlato

Restituisce

Promise<void>

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

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>

startCaptions(StartCaptionsAdapterOptions)

Funzione per avviare i sottotitoli

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

Parametri

options

StartCaptionsAdapterOptions

Opzioni per i sottotitoli iniziali

Restituisce

Promise<void>

startNoiseSuppressionEffect()

Avvia l'effetto di soppressione del rumore.

function startNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

startScreenShare()

Iniziare a condividere la schermata durante una chiamata.

function startScreenShare(): Promise<void>

Restituisce

Promise<void>

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>

startTogetherMode()

Modalità Avvia insieme.

function startTogetherMode(): Promise<void>

Restituisce

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Avvia l'effetto di sfondo del video.

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

Parametri

videoBackgroundEffect

VideoBackgroundEffect

Restituisce

Promise<void>

stopAllSpotlight()

Arrestare tutti i riflettori

function stopAllSpotlight(): Promise<void>

Restituisce

Promise<void>

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>

stopCaptions(StopCaptionsAdapterOptions)

Funzione per interrompere le didascalie

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

Parametri

options

StopCaptionsAdapterOptions

Restituisce

Promise<void>

stopNoiseSuppressionEffect()

Arresta l'effetto di soppressione del rumore.

function stopNoiseSuppressionEffect(): Promise<void>

Restituisce

Promise<void>

stopScreenShare()

Interrompere la condivisione dello schermo

function stopScreenShare(): Promise<void>

Restituisce

Promise<void>

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>

stopVideoBackgroundEffects()

Interrompi l'effetto di sfondo del video.

function stopVideoBackgroundEffects(): Promise<void>

Restituisce

Promise<void>

submitSurvey(CallSurvey)

Invia il risultato del sondaggio di fine chiamata

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

Parametri

survey

CallSurvey

Restituisce

Promise<undefined | CallSurveyResponse>

unmute()

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

function unmute(): Promise<void>

Restituisce

Promise<void>

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.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aggiorna l'effetto di sfondo del video selezionato.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametri

selectedVideoBackground

VideoBackgroundEffect