CommonCallAdapter interface

Pacchetto:

@azure/communication-react

CallComposite Interfaccia dell'adattatore.

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Metodi

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

Metodi ereditati

askDevicePermission(PermissionConstraints)	Richiedere le autorizzazioni dei dispositivi.
createStreamView(string, VideoStreamOptions)	Creare la visualizzazione HTML per un flusso.
dispose()	Eliminare il composito
disposeStreamView(string, VideoStreamOptions)	Eliminare la visualizzazione HTML per un flusso.
getState()	Ottenere lo stato corrente
leaveCall(boolean)	Lasciare la chiamata
mute()	Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale
off("callEnded", CallEndedListener)	Annullare la sottoscrizione della funzione per l'evento 'callEnded'.
off("callIdChanged", CallIdChangedListener)	Annullare la sottoscrizione della funzione per l'evento 'callIdChanged'.
off("diagnosticChanged", DiagnosticChangedEventListner)	Annullare la sottoscrizione della funzione per l'evento 'diagnosticChanged'.
off("displayNameChanged", DisplayNameChangedListener)	Annulla la sottoscrizione della funzione per l'evento 'displayNameChanged'.
off("error", (e: AdapterError) => void)	Annullare la sottoscrizione della funzione per l'evento 'error'.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funzione Unsubscribe per l'evento 'isLocalScreenSharingActiveChanged'.
off("isMutedChanged", IsMutedChangedListener)	Funzione Unsubscribe per l'evento 'isMutedChanged'.
off("isSpeakingChanged", IsSpeakingChangedListener)	Funzione Unsubscribe per l'evento 'isSpeakingChanged'.
off("participantsJoined", ParticipantsJoinedListener)	Funzione Unsubscribe per l'evento 'participantsJoined'.
off("participantsLeft", ParticipantsLeftListener)	Funzione Unsubscribe per l'evento 'participantsLeft'.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento 'selectedMicrophoneChanged'.
off("selectedSpeakerChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento 'selectedSpeakerChanged'.
offStateChange((state: CallAdapterState) => void)	Annulla la sottoscrizione del gestore agli eventi stateChanged.
on("callEnded", CallEndedListener)	Funzione Subscribe per l'evento 'callEnded'.
on("callIdChanged", CallIdChangedListener)	Sottoscrivere la funzione per l'evento 'callIdChanged'.
on("diagnosticChanged", DiagnosticChangedEventListner)	Funzione Subscribe per l'evento 'diagnosticChanged'. Questo evento viene generato ogni volta che viene apportata una modifica alla diagnostica dell'utente relativa alla chiamata in corso.
on("displayNameChanged", DisplayNameChangedListener)	Funzione Subscribe per l'evento 'displayNameChanged'.
on("error", (e: AdapterError) => void)	Funzione Subscribe per l'evento 'error'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funzione Subscribe per l'evento 'isLocalScreenSharingActiveChanged'.
on("isMutedChanged", IsMutedChangedListener)	Funzione Subscribe per l'evento 'isMutedChanged'.
on("isSpeakingChanged", IsSpeakingChangedListener)	Funzione Subscribe per l'evento 'isSpeakingChanged'.
on("participantsJoined", ParticipantsJoinedListener)	Funzione Subscribe per l'evento 'participantsJoined'.
on("participantsLeft", ParticipantsLeftListener)	Funzione Subscribe per l'evento 'participantsLeft'.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Sottoscrivere la funzione per l'evento 'selectedMicrophoneChanged'. Questo evento viene generato ogni volta che l'utente seleziona un nuovo dispositivo microfono.
on("selectedSpeakerChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento 'selectedSpeakerChanged'. Questo evento viene generato ogni volta che l'utente seleziona un nuovo dispositivo voce.
onStateChange((state: CallAdapterState) => 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.
removeParticipant(string)	Rimuovere un partecipante dalla chiamata.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Impostare la fotocamera da usare nella chiamata.
setMicrophone(AudioDeviceInfo)	Impostare il microfono da usare nella chiamata.
setSpeaker(AudioDeviceInfo)	Impostare l'altoparlante da usare nella 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)

Parametri

microphoneOn

boolean

Indica se il microfono è inizialmente abilitato

startCall(string[], StartCallOptions)

Avviare la chiamata.

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

Parametri

participants

string[]

Matrice di ID partecipante da aggiungere

options

StartCallOptions

Dettagli dei metodi ereditati

askDevicePermission(PermissionConstraints)

Richiedere le autorizzazioni dei dispositivi.

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

Parametri

constrain

PermissionConstraints

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

Restituisce

Promise<void>

Commenti

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

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

Restituisce

Promise<void | CreateVideoStreamViewResult>

Commenti

Questo metodo viene implementato per composito

Ereditato daCallAdapterCallOperations.createStreamView

dispose()

Eliminare il composito

function dispose()

Ereditato daElimina.dispose

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

getState()

Ottenere lo stato corrente

function getState(): CallAdapterState

Restituisce

CallAdapterState

Ereditato daAdapterState.getState

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

off("callEnded", CallEndedListener)

Annullare la sottoscrizione della funzione per l'evento 'callEnded'.

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

Parametri

event

"callEnded"

listener

CallEndedListener

Ereditato daCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Annullare la sottoscrizione della funzione per l'evento 'callIdChanged'.

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

Parametri

event

"callIdChanged"

listener

CallIdChangedListener

Ereditato daCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Annullare la sottoscrizione della funzione per l'evento 'diagnosticChanged'.

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametri

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Ereditato daCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Annulla la sottoscrizione della funzione per l'evento 'displayNameChanged'.

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

Parametri

event

"displayNameChanged"

listener

DisplayNameChangedListener

Ereditato daCallAdapterSubscribers.off

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

Annullare la sottoscrizione della funzione per l'evento 'error'.

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

Parametri

event

"error"

listener

(e: AdapterError) => void

Ereditato daCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funzione Unsubscribe per l'evento 'isLocalScreenSharingActiveChanged'.

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

Parametri

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Ereditato daCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Funzione Unsubscribe per l'evento 'isMutedChanged'.

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

Parametri

event

"isMutedChanged"

listener

IsMutedChangedListener

Ereditato daCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Funzione Unsubscribe per l'evento 'isSpeakingChanged'.

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

Parametri

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Ereditato daCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Funzione Unsubscribe per l'evento 'participantsJoined'.

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

Parametri

event

"participantsJoined"

listener

ParticipantsJoinedListener

Ereditato daCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Funzione Unsubscribe per l'evento 'participantsLeft'.

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

Parametri

event

"participantsLeft"

listener

ParticipantsLeftListener

Ereditato daCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento 'selectedMicrophoneChanged'.

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

Parametri

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Ereditato daCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento 'selectedSpeakerChanged'.

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

Parametri

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Ereditato daCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Annulla la sottoscrizione del gestore agli eventi stateChanged.

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

Parametri

handler

(state: CallAdapterState) => void

Ereditato daAdapterState.offStateChange

on("callEnded", CallEndedListener)

Funzione Subscribe per l'evento 'callEnded'.

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

Parametri

event

"callEnded"

listener

CallEndedListener

Ereditato daCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Sottoscrivere la funzione per l'evento 'callIdChanged'.

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

Parametri

event

"callIdChanged"

listener

CallIdChangedListener

Commenti

L'evento verrà attivato quando viene modificato callId dell'utente corrente.

Ereditato daCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Funzione Subscribe per l'evento 'diagnosticChanged'.

Questo evento viene generato ogni volta che viene apportata una modifica alla diagnostica dell'utente relativa alla chiamata in corso.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametri

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Ereditato daCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Funzione Subscribe per l'evento 'displayNameChanged'.

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

Parametri

event

"displayNameChanged"

listener

DisplayNameChangedListener

Ereditato daCallAdapterSubscribers.on

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

Funzione Subscribe per l'evento 'error'.

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

Parametri

event

"error"

listener

(e: AdapterError) => void

Ereditato daCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funzione Subscribe per l'evento 'isLocalScreenSharingActiveChanged'.

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

Parametri

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Ereditato daCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Funzione Subscribe per l'evento 'isMutedChanged'.

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

Parametri

event

"isMutedChanged"

listener

IsMutedChangedListener

Commenti

L'evento verrà attivato ogni volta che viene modificato lo stato di disattivazione dell'utente corrente o dell'utente remoto

Ereditato daCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Funzione Subscribe per l'evento 'isSpeakingChanged'.

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

Parametri

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Ereditato daCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Funzione Subscribe per l'evento 'participantsJoined'.

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

Parametri

event

"participantsJoined"

listener

ParticipantsJoinedListener

Ereditato daCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Funzione Subscribe per l'evento 'participantsLeft'.

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

Parametri

event

"participantsLeft"

listener

ParticipantsLeftListener

Ereditato daCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Sottoscrivere la funzione per l'evento 'selectedMicrophoneChanged'.

Questo evento viene generato ogni volta che l'utente seleziona un nuovo dispositivo microfono.

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

Parametri

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Ereditato daCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento 'selectedSpeakerChanged'.

Questo evento viene generato ogni volta che l'utente seleziona un nuovo dispositivo voce.

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

Parametri

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Ereditato daCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Sottoscrive il gestore per gli eventi stateChanged.

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

Parametri

handler

(state: CallAdapterState) => 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 daCallAdapterDeviceManagement.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 daCallAdapterDeviceManagement.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 daCallAdapterDeviceManagement.querySpeakers

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

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 queryCameras

options

VideoStreamOptions

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

Restituisce

Promise<void>

Ereditato daCallAdapterDeviceManagement.setCamera

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 dalla queryMicrophones

Restituisce

Promise<void>

Ereditato daCallAdapterDeviceManagement.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 daCallAdapterDeviceManagement.setSpeaker

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