CallCommon interface

Pacchetto:

@azure/communication-calling

Interfaccia comune Di chiamata.

Extends

Disposable

Proprietà

callEndReason	Contenente codice/codice secondario che indica come è terminata la chiamata.
callerInfo	Informazioni sul chiamante se la chiamata è in ingresso.
direction	Ottenere la direzione della chiamata, sia in ingresso che in uscita.
id	Ottenere l'ID univoco per questa chiamata.
isIncomingAudioMuted	Indica se l'utente locale ha disattivato l'audio in ingresso.
isLocalVideoStarted	Indica se il video locale è attivo.
isMuted	Indica se l'utente locale è disattivato, in locale o in remoto.
isScreenSharingOn	Indica se la condivisione dello schermo è attivata.
kind	Ottiene il tipo di oggetto di chiamata.
lobby	Ottenere la sala di attesa delle riunioni di Teams.
localAudioStreams	Raccolta di flussi audio locali inviati ad altri partecipanti in una chiamata.
localVideoStreams	Raccolta di flussi video locali inviati ad altri partecipanti in una chiamata.
remoteAudioStreams	Raccolta di flussi audio remoti ricevuti dalla chiamata.
remoteParticipants	Raccolta di partecipanti remoti in questa chiamata. In caso di chiamate con partecipanti di centinaia o più, solo i partecipanti attivi multimediali sono presenti in questa raccolta.
role	Ottenere il ruolo dell'utente locale nella chiamata.
state	Ottenere lo stato di questa chiamata.
totalParticipantCount	Conteggio del numero totale di partecipanti in questa chiamata.
transferorInfo	Iniziatore di trasferimento in caso di scenari di trasferimento/inoltro.

Metodi

feature<TFeature>(CallFeatureFactory<TFeature>)	Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità di chiamata estese disponibili in questo pacchetto, ad esempio: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Appendi la chiamata.
hold()	Mettere in attesa questa chiamata.
mute()	Disattivare il microfono locale.
muteAllRemoteParticipants()	Disattiva tutti i partecipanti remoti.
muteIncomingAudio()	Disattivare l'audio in ingresso.
off("callerInfoChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento di modifica delle informazioni sul chiamante.
off("idChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funzione Unsubscribe per l'evento isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Funzione Unsubscribe per l'evento isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funzione Unsubscribe per l'evento localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funzione Unsubscribe per l'evento localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Funzione Unsubscribe per l'evento mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funzione Unsubscribe per l'evento remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funzione Unsubscribe per l'evento remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento roleChanged.
off("stateChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	funzione di annullamento della sottoscrizione per l'evento totalParticipantCountChanged.
off("transferorInfoChanged", PropertyChangedEvent)	Annulla la sottoscrizione della funzione per l'evento di modifica delle informazioni sul chiamante.
on("callerInfoChanged", PropertyChangedEvent)	Sottoscrivi la funzione per l'evento di modifica delle informazioni sul chiamante.
on("idChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funzione Subscribe per l'evento localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funzione Subscribe per l'evento localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Funzione Subscribe per l'evento mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funzione Subscribe per l'evento remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funzione Subscribe per l'evento remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Sottoscrivi la funzione per l'evento roleChanged.
on("stateChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Funzione Subscribe per l'evento totalParticipantCountChanged.
on("transferorInfoChanged", PropertyChangedEvent)	Sottoscrivi la funzione per l'evento di modifica delle informazioni sul chiamante.
resume()	Riprendere questa chiamata se è in stato "LocalHold".
sendDtmf(DtmfTone)	Invia tono DTMF.
setConstraints(CallConstraints)	Impostare vincoli di chiamata. Questo metodo imposta i vincoli massimi di in base ai valori specificati. I vincoli applicati finali saranno minori o uguali ai valori forniti qui per questo metodo. Se viene specificato 0 valore, non verrà applicato alcun vincolo per tale vincolo. Se viene specificato un valore non definito, verrà usato il valore precedente usato per tale vincolo.
startAudio(LocalAudioStream)	Avviare l'audio nella chiamata con audio personalizzato. L'origine LocalAudioStream deve essere un oggetto MediaStream.
startScreenSharing()	Iniziare a inviare il flusso di condivisione dello schermo in una chiamata. Il browser chiederà di selezionare la schermata, l'app o la scheda del browser. L'invio del flusso di condivisione dello schermo non è supportato in iOS né in Android. Il flusso di condivisione dello schermo in ingresso è supportato in iOS e Android.
startScreenSharing(LocalVideoStream)	Iniziare a inviare un flusso di condivisione dello schermo non elaborato in una chiamata. L'invio di condivisione dello schermo non elaborato non è supportato in iOS né In Android. La condivisione dello schermo non elaborata in ingresso è supportata in iOS e Android.
startVideo(LocalVideoStream)	Iniziare a inviare il flusso video nella chiamata. I partecipanti remoti nella chiamata riceveranno il flusso video in modo che possano eseguirne il rendering nelle interfacce utente.
stopAudio()	Arrestare l'audio personalizzato nella chiamata e passare al dispositivo audio predefinito di Gestione dispositivi.
stopScreenSharing()	Arrestare la condivisione dello schermo locale.
stopScreenSharing(LocalVideoStream)	Arrestare la condivisione dello schermo locale.
stopVideo(LocalVideoStream)	Interrompere l'invio del flusso video nella chiamata. Deve passare lo stesso oggetto LocalVideoStream usato per avviare il video nell'API CallAgent.startCall(), l'API CallAgent.join() , l'API IncomingCall.accept() o l'API Call.startVideo().
unmute()	Disattiva microfono locale.
unmuteIncomingAudio()	Annullare l'audio in ingresso.

Metodi ereditati

dispose()

Dettagli proprietà

callEndReason

Contenente codice/codice secondario che indica come è terminata la chiamata.

callEndReason?: CallEndReason

Valore della proprietà

CallEndReason

callerInfo

Informazioni sul chiamante se la chiamata è in ingresso.

callerInfo: CallerInfo

Valore della proprietà

CallerInfo

direction

Ottenere la direzione della chiamata, sia in ingresso che in uscita.

direction: CallDirection

Valore della proprietà

CallDirection

id

Ottenere l'ID univoco per questa chiamata.

id: string

Valore della proprietà

string

isIncomingAudioMuted

Indica se l'utente locale ha disattivato l'audio in ingresso.

isIncomingAudioMuted: boolean

Valore della proprietà

boolean

isLocalVideoStarted

Indica se il video locale è attivo.

isLocalVideoStarted: boolean

Valore della proprietà

boolean

isMuted

Indica se l'utente locale è disattivato, in locale o in remoto.

isMuted: boolean

Valore della proprietà

boolean

isScreenSharingOn

Indica se la condivisione dello schermo è attivata.

isScreenSharingOn: boolean

Valore della proprietà

boolean

kind

Ottiene il tipo di oggetto di chiamata.

kind: CallKind

Valore della proprietà

CallKind

lobby

Ottenere la sala di attesa delle riunioni di Teams.

lobby: Lobby

Valore della proprietà

Lobby

localAudioStreams

Raccolta di flussi audio locali inviati ad altri partecipanti in una chiamata.

localAudioStreams: readonly LocalAudioStream[]

Valore della proprietà

readonly LocalAudioStream[]

localVideoStreams

Raccolta di flussi video locali inviati ad altri partecipanti in una chiamata.

localVideoStreams: readonly LocalVideoStream[]

Valore della proprietà

readonly LocalVideoStream[]

remoteAudioStreams

Raccolta di flussi audio remoti ricevuti dalla chiamata.

remoteAudioStreams: readonly RemoteAudioStream[]

Valore della proprietà

readonly RemoteAudioStream[]

remoteParticipants

Raccolta di partecipanti remoti in questa chiamata. In caso di chiamate con partecipanti di centinaia o più, solo i partecipanti attivi multimediali sono presenti in questa raccolta.

remoteParticipants: readonly RemoteParticipant[]

Valore della proprietà

readonly RemoteParticipant[]

role

Ottenere il ruolo dell'utente locale nella chiamata.

role: ParticipantRole

Valore della proprietà

ParticipantRole

state

Ottenere lo stato di questa chiamata.

state: CallState

Valore della proprietà

CallState

totalParticipantCount

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Conteggio del numero totale di partecipanti in questa chiamata.

totalParticipantCount: number

Valore della proprietà

number

transferorInfo

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Iniziatore di trasferimento in caso di scenari di trasferimento/inoltro.

transferorInfo?: CallerInfo

Valore della proprietà

CallerInfo

Dettagli metodo

feature<TFeature>(CallFeatureFactory<TFeature>)

Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità di chiamata estese disponibili in questo pacchetto, ad esempio:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

Parametri

factory

CallFeatureFactory<TFeature>

Factory per il costruttore di funzionalità di chiamata che fornisce un'API estesa.

Restituisce

TFeature

hangUp(HangUpOptions)

Appendi la chiamata.

function hangUp(options?: HangUpOptions): Promise<void>

Parametri

options

HangUpOptions

Opzioni hangup.

Restituisce

Promise<void>

hold()

Mettere in attesa questa chiamata.

function hold(): Promise<void>

Restituisce

Promise<void>

mute()

Disattivare il microfono locale.

function mute(): Promise<void>

Restituisce

Promise<void>

muteAllRemoteParticipants()

Disattiva tutti i partecipanti remoti.

function muteAllRemoteParticipants(): Promise<void>

Restituisce

Promise<void>

muteIncomingAudio()

Disattivare l'audio in ingresso.

function muteIncomingAudio(): Promise<void>

Restituisce

Promise<void>

off("callerInfoChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Annulla la sottoscrizione della funzione per l'evento di modifica delle informazioni sul chiamante.

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

Parametri

event

"callerInfoChanged"

listener

PropertyChangedEvent

off("idChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento idChanged.

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

Parametri

event

"idChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isIncomingAudioMutedChanged.

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

Parametri

event

"isIncomingAudioMutedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isLocalVideoStartedChanged.

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

Parametri

event

"isLocalVideoStartedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

off("isMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isMutedChanged.

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

Parametri

event

"isMutedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

off("isScreenSharingOnChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isScreenSharingChanged.

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

Parametri

event

"isScreenSharingOnChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funzione Unsubscribe per l'evento localAudioStreamsUpdated.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parametri

event

"localAudioStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn usato per sottoscrivere questo evento.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Funzione Unsubscribe per l'evento localVideoStreamsUpdated.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parametri

event

"localVideoStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn usato per sottoscrivere questo evento.

off("mutedByOthers", PropertyChangedEvent)

Funzione Unsubscribe per l'evento mutedByOthers.

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

Parametri

event

"mutedByOthers"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per annullare la sottoscrizione a questo evento.

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funzione Unsubscribe per l'evento remoteAudioStreamsUpdated.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parametri

event

"remoteAudioStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn usato per sottoscrivere questo evento.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funzione Unsubscribe per l'evento remoteParticipantsUpdated.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parametri

event

"remoteParticipantsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn usato per sottoscrivere questo evento.

off("roleChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento roleChanged.

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

Parametri

event

"roleChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("stateChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento stateChanged.

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

Parametri

event

"stateChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("totalParticipantCountChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

funzione di annullamento della sottoscrizione per l'evento totalParticipantCountChanged.

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

Parametri

event

"totalParticipantCountChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il conteggio dei partecipanti cambia.

off("transferorInfoChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Annulla la sottoscrizione della funzione per l'evento di modifica delle informazioni sul chiamante.

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

Parametri

event

"transferorInfoChanged"

listener

PropertyChangedEvent

on("callerInfoChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Sottoscrivi la funzione per l'evento di modifica delle informazioni sul chiamante.

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

Parametri

event

"callerInfoChanged"

listener

PropertyChangedEvent

on("idChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento idChanged.

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

Parametri

event

"idChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isIncomingAudioMutedChanged.

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

Parametri

event

"isIncomingAudioMutedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isLocalVideoStartedChanged.

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

Parametri

event

"isLocalVideoStartedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isMutedChanged.

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

Parametri

event

"isMutedChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isScreenSharingOnChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isScreenSharingChanged.

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

Parametri

event

"isScreenSharingOnChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funzione Subscribe per l'evento localAudioStreamsUpdated.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parametri

event

"localAudioStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Funzione Subscribe per l'evento localVideoStreamsUpdated.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parametri

event

"localVideoStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.

on("mutedByOthers", PropertyChangedEvent)

Funzione Subscribe per l'evento mutedByOthers.

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

Parametri

event

"mutedByOthers"

nome dell'evento.

listener

PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funzione Subscribe per l'evento remoteAudioStreamsUpdated.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parametri

event

"remoteAudioStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funzione Subscribe per l'evento remoteParticipantsUpdated.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parametri

event

"remoteParticipantsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.

on("roleChanged", PropertyChangedEvent)

Sottoscrivi la funzione per l'evento roleChanged.

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

Parametri

event

"roleChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("stateChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento stateChanged.

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

Parametri

event

"stateChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("totalParticipantCountChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Funzione Subscribe per l'evento totalParticipantCountChanged.

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

Parametri

event

"totalParticipantCountChanged"

nome dell'evento.

listener

PropertyChangedEvent

callback fn che verrà chiamato quando il conteggio dei partecipanti cambia.

on("transferorInfoChanged", PropertyChangedEvent)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Sottoscrivi la funzione per l'evento di modifica delle informazioni sul chiamante.

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

Parametri

event

"transferorInfoChanged"

listener

PropertyChangedEvent

resume()

Riprendere questa chiamata se è in stato "LocalHold".

function resume(): Promise<void>

Restituisce

Promise<void>

sendDtmf(DtmfTone)

Invia tono DTMF.

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

Parametri

dtmfTone

DtmfTone

Restituisce

Promise<void>

setConstraints(CallConstraints)

Impostare vincoli di chiamata. Questo metodo imposta i vincoli massimi di in base ai valori specificati. I vincoli applicati finali saranno minori o uguali ai valori forniti qui per questo metodo. Se viene specificato 0 valore, non verrà applicato alcun vincolo per tale vincolo. Se viene specificato un valore non definito, verrà usato il valore precedente usato per tale vincolo.

function setConstraints(constraints: CallConstraints): Promise<void>

Parametri

constraints

CallConstraints

Oggetto che rappresenta i vincoli di chiamata da impostare

Restituisce

Promise<void>

startAudio(LocalAudioStream)

Avviare l'audio nella chiamata con audio personalizzato. L'origine LocalAudioStream deve essere un oggetto MediaStream.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

Parametri

localAudioStream

LocalAudioStream

Restituisce

Promise<void>

startScreenSharing()

• Iniziare a inviare il flusso di condivisione dello schermo in una chiamata. Il browser chiederà di selezionare la schermata, l'app o la scheda del browser.
• L'invio del flusso di condivisione dello schermo non è supportato in iOS né in Android.
• Il flusso di condivisione dello schermo in ingresso è supportato in iOS e Android.

function startScreenSharing(): Promise<void>

Restituisce

Promise<void>

startScreenSharing(LocalVideoStream)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

• Iniziare a inviare un flusso di condivisione dello schermo non elaborato in una chiamata.
• L'invio di condivisione dello schermo non elaborato non è supportato in iOS né In Android.
• La condivisione dello schermo non elaborata in ingresso è supportata in iOS e Android.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parametri

localVideoStream

LocalVideoStream

Rappresenta un flusso di condivisione dello schermo non elaborato locale che accetta un oggetto MediaStream nel costruttore.

Restituisce

Promise<void>

startVideo(LocalVideoStream)

Iniziare a inviare il flusso video nella chiamata. I partecipanti remoti nella chiamata riceveranno il flusso video in modo che possano eseguirne il rendering nelle interfacce utente.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

Parametri

localVideoStream

LocalVideoStream

Rappresenta un flusso video locale che accetta un'origine della fotocamera nel costruttore.

Restituisce

Promise<void>

stopAudio()

Arrestare l'audio personalizzato nella chiamata e passare al dispositivo audio predefinito di Gestione dispositivi.

function stopAudio()

stopScreenSharing()

Arrestare la condivisione dello schermo locale.

function stopScreenSharing(): Promise<void>

Restituisce

Promise<void>

stopScreenSharing(LocalVideoStream)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Arrestare la condivisione dello schermo locale.

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parametri

localVideoStream

LocalVideoStream

Flusso di condivisione dello schermo locale per arrestare lo streaming.

Restituisce

Promise<void>

stopVideo(LocalVideoStream)

Interrompere l'invio del flusso video nella chiamata. Deve passare lo stesso oggetto LocalVideoStream usato per avviare il video nell'API CallAgent.startCall(), l'API CallAgent.join() , l'API IncomingCall.accept() o l'API Call.startVideo().

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

Parametri

localVideoStream

LocalVideoStream

Flusso video locale per arrestare lo streaming.

Restituisce

Promise<void>

unmute()

Disattiva microfono locale.

function unmute(): Promise<void>

Restituisce

Promise<void>

unmuteIncomingAudio()

Annullare l'audio in ingresso.

function unmuteIncomingAudio(): Promise<void>

Restituisce

Promise<void>

Dettagli dei metodi ereditati

dispose()

function dispose()

ereditato damonouso.dispose