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

Metodi

joinCall(boolean)	Partecipare alla chiamata con il microfono inizialmente attivato/disattivato.
startCall(string[], StartCallOptions)	Avviare la chiamata.

Metodi ereditati

createStreamView(string, VideoStreamOptions)	Creare la visualizzazione HTML per un flusso.
disposeStreamView(string, VideoStreamOptions)	Eliminare la visualizzazione HTML per un flusso.
leaveCall(boolean)	Lasciare la chiamata
mute()	Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale
removeParticipant(string)	Rimuovere un partecipante dalla chiamata.
startCamera(VideoStreamOptions)	Avviare la fotocamera Questo metodo avvierà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva
startScreenShare()	Iniziare a condividere la schermata durante una chiamata.
stopCamera()	Arrestare la fotocamera Questo metodo interromperà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva
stopScreenShare()	Interrompere la condivisione dello schermo
unmute()	Deselezionare l'utente corrente durante la chiamata o abilitare il microfono in locale

Dettagli metodo

joinCall(boolean)

Partecipare 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

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

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 il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void | CreateVideoStreamViewResult>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallAdapterCallOperations.createStreamView

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 il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallAdapterCallOperations.disposeStreamView

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

mute()

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

function mute(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.mute

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

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 il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startCamera

startScreenShare()

Iniziare a condividere la schermata durante una chiamata.

function startScreenShare(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.startScreenShare

stopCamera()

Arrestare 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

stopScreenShare()

Interrompere la condivisione dello schermo

function stopScreenShare(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.stopScreenShare

unmute()

Deselezionare l'utente corrente durante la chiamata o abilitare il microfono in locale

function unmute(): Promise<void>

Restituisce

Promise<void>

Ereditato daCallAdapterCallOperations.unmute