Partager via

CallCommon interface

  • Référence
Paquet:
@azure/communication-calling

Interface commune d’appel.

Extends
Disposable

Propriétés

callEndReason

Contenant du code/sous-code indiquant comment cet appel s’est terminé.
callerInfo

Informations de l’appelant si cet appel est entrant.
direction

Obtenez la direction de l’appel, qu’elle soit entrante ou sortante.
id

Obtenez l’ID unique de cet appel.
isIncomingAudioMuted

Indique si l’utilisateur local a désactivé l’audio entrant.
isLocalVideoStarted

Indique si la vidéo locale est activée.
isMuted

Que l’utilisateur local soit désactivé, localement ou à distance.
isScreenSharingOn

Indique si le partage d’écran est activé.
kind

Obtenez le type d’objet d’appel.
lobby

Obtenez la salle d’attente de la réunion Teams.
localAudioStreams

Collection de flux audio locaux envoyés à d’autres participants dans un appel.
localVideoStreams

Collection de flux vidéo locaux envoyés à d’autres participants dans un appel.
remoteAudioStreams

Collection de flux audio distants reçus à partir de l’appel.
remoteParticipants

Collection de participants distants dans cet appel. En cas d’appels avec des participants de centaines ou plus, seuls les participants actifs multimédias sont présents dans cette collection.
role

Obtenez le rôle de l’utilisateur local dans l’appel.
state

Obtenez l’état de cet appel.
totalParticipantCount

Nombre total de participants dans cet appel.

Méthodes

feature<TFeature>(CallFeatureFactory<TFeature>)

Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Consultez les fonctionnalités de l’objet.* pour toutes les fonctionnalités d’appel étendue disponibles dans ce package, par exemple :

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

Raccrocher l’appel.
hold()

Mettez cet appel en attente.
mute()

Désactiver le micro local.
muteAllRemoteParticipants()

Désactiver le son de tous les participants distants.
muteIncomingAudio()

Désactiver le son entrant.
off("idChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Fonction de désabonnement pour l’événement localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Fonction de désabonnement pour l’événement localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)

Fonction de désabonnement pour l’événement mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Fonction de désabonnement pour l’événement remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Fonction de désabonnement pour l’événement remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)

Fonction De désabonnement pour l’événement roleChanged.
off("stateChanged", PropertyChangedEvent)

Fonction De désabonnement pour l’événement stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)

fonction de désabonnement pour l’événement totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Fonction Subscribe pour l’événement localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Fonction Subscribe pour l’événement localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)

Fonction d’abonnement pour l’événement mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Fonction Subscribe pour l’événement remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Fonction Subscribe pour l’événement remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement roleChanged.
on("stateChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement totalParticipantCountChanged.
resume()

Reprendre cet appel s’il se trouve sur l’état « LocalHold ».
sendDtmf(DtmfTone)

Envoyer le ton DTMF.
setConstraints(CallConstraints)

Définissez des contraintes d’appel. Cette méthode définit les contraintes maximales de basées sur les valeurs fournies. Les contraintes appliquées finales seront inférieures ou égales aux valeurs fournies ici à cette méthode. Si la valeur 0 est fournie, aucune contrainte n’est appliquée à cette contrainte. Si une valeur non définie est fournie, la valeur précédente utilisée sera utilisée pour cette contrainte.
startAudio(LocalAudioStream)

Démarrez l’audio dans l’appel avec l’audio personnalisé. La source LocalAudioStream doit être Un MediaStream.
startScreenSharing()
  • Commencez à envoyer un flux de partage d’écran dans un appel. Le navigateur invite à sélectionner l’écran, l’application ou l’onglet navigateur.
  • L’envoi d’un flux de partage d’écran n’est pas pris en charge sur iOS ni Android.
  • Le flux de partage d’écran entrant est pris en charge sur iOS et Android.
startScreenSharing(LocalVideoStream)
  • Commencez à envoyer un flux de partage d’écran brut dans un appel.
  • L’envoi d’un partage d’écran brut n’est pas pris en charge sur iOS ni Android.
  • Le partage d’écran brut entrant est pris en charge sur iOS et Android.
startVideo(LocalVideoStream)

Commencez à envoyer le flux vidéo dans l’appel. Les participants distants de l’appel recevront votre flux vidéo afin qu’ils puissent le rendre dans leurs INTERFACES utilisateur.
stopAudio()

Arrêtez l’audio personnalisé dans l’appel et basculez vers l’appareil audio par défaut du Gestionnaire d’appareils.
stopScreenSharing()

Arrêtez le partage d’écran local.
stopScreenSharing(LocalVideoStream)

Arrêtez le partage d’écran local.
stopVideo(LocalVideoStream)

Arrêtez l’envoi du flux vidéo dans l’appel. Doit passer le même objet LocalVideoStream utilisé pour démarrer la vidéo dans l’API CallAgent.startCall(), l’API CallAgent.join(), l’API IncomingCall.accept() ou l’API Call.startVideo().
unmute()

Activer le microphone local.
unmuteIncomingAudio()

Activer l’audio entrant.

Méthodes héritées

dispose()

Détails de la propriété

callEndReason

Contenant du code/sous-code indiquant comment cet appel s’est terminé.

callEndReason?: CallEndReason

Valeur de propriété

CallEndReason

callerInfo

Informations de l’appelant si cet appel est entrant.

callerInfo: CallerInfo

Valeur de propriété

CallerInfo

direction

Obtenez la direction de l’appel, qu’elle soit entrante ou sortante.

direction: CallDirection

Valeur de propriété

CallDirection

id

Obtenez l’ID unique de cet appel.

id: string

Valeur de propriété

string

isIncomingAudioMuted

Indique si l’utilisateur local a désactivé l’audio entrant.

isIncomingAudioMuted: boolean

Valeur de propriété

boolean

isLocalVideoStarted

Indique si la vidéo locale est activée.

isLocalVideoStarted: boolean

Valeur de propriété

boolean

isMuted

Que l’utilisateur local soit désactivé, localement ou à distance.

isMuted: boolean

Valeur de propriété

boolean

isScreenSharingOn

Indique si le partage d’écran est activé.

isScreenSharingOn: boolean

Valeur de propriété

boolean

kind

Obtenez le type d’objet d’appel.

kind: CallKind

Valeur de propriété

CallKind

lobby

Obtenez la salle d’attente de la réunion Teams.

lobby: Lobby

Valeur de propriété

Lobby

localAudioStreams

Collection de flux audio locaux envoyés à d’autres participants dans un appel.

localAudioStreams: readonly LocalAudioStream[]

Valeur de propriété

readonly LocalAudioStream[]

localVideoStreams

Collection de flux vidéo locaux envoyés à d’autres participants dans un appel.

localVideoStreams: readonly LocalVideoStream[]

Valeur de propriété

readonly LocalVideoStream[]

remoteAudioStreams

Collection de flux audio distants reçus à partir de l’appel.

remoteAudioStreams: readonly RemoteAudioStream[]

Valeur de propriété

readonly RemoteAudioStream[]

remoteParticipants

Collection de participants distants dans cet appel. En cas d’appels avec des participants de centaines ou plus, seuls les participants actifs multimédias sont présents dans cette collection.

remoteParticipants: readonly RemoteParticipant[]

Valeur de propriété

readonly RemoteParticipant[]

role

Obtenez le rôle de l’utilisateur local dans l’appel.

role: ParticipantRole

Valeur de propriété

ParticipantRole

state

Obtenez l’état de cet appel.

state: CallState

Valeur de propriété

CallState

totalParticipantCount

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Nombre total de participants dans cet appel.

totalParticipantCount: number

Valeur de propriété

number

Détails de la méthode

feature<TFeature>(CallFeatureFactory<TFeature>)

Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Consultez les fonctionnalités de l’objet.* pour toutes les fonctionnalités d’appel étendue disponibles dans ce package, par exemple :

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

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

Paramètres

factory

CallFeatureFactory<TFeature>

Fabrique du constructeur de fonctionnalités d’appel qui fournit une API étendue.

Retours

TFeature

hangUp(HangUpOptions)

Raccrocher l’appel.

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

Paramètres

options
HangUpOptions

Options de blocage.

Retours

Promise<void>

hold()

Mettez cet appel en attente.

function hold(): Promise<void>

Retours

Promise<void>

mute()

Désactiver le micro local.

function mute(): Promise<void>

Retours

Promise<void>

muteAllRemoteParticipants()

Désactiver le son de tous les participants distants.

function muteAllRemoteParticipants(): Promise<void>

Retours

Promise<void>

muteIncomingAudio()

Désactiver le son entrant.

function muteIncomingAudio(): Promise<void>

Retours

Promise<void>

off("idChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement idChanged.

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

Paramètres

event

"idChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.

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

Paramètres

event

"isIncomingAudioMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isLocalVideoStartedChanged.

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

Paramètres

event

"isLocalVideoStartedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

off("isMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isMutedChanged.

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

Paramètres

event

"isMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

off("isScreenSharingOnChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isScreenSharingChanged.

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

Paramètres

event

"isScreenSharingOnChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Fonction de désabonnement pour l’événement localAudioStreamsUpdated.

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

Paramètres

event

"localAudioStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<LocalAudioStream>

rappel fn utilisé pour s’abonner à cet événement.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Fonction de désabonnement pour l’événement localVideoStreamsUpdated.

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

Paramètres

event

"localVideoStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<LocalVideoStream>

rappel fn utilisé pour s’abonner à cet événement.

off("mutedByOthers", PropertyChangedEvent)

Fonction de désabonnement pour l’événement mutedByOthers.

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

Paramètres

event

"mutedByOthers"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour se désabonner de cet événement.

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Fonction de désabonnement pour l’événement remoteAudioStreamsUpdated.

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

Paramètres

event

"remoteAudioStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteAudioStream>

rappel fn utilisé pour s’abonner à cet événement.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Fonction de désabonnement pour l’événement remoteParticipantsUpdated.

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

Paramètres

event

"remoteParticipantsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteParticipant>

rappel fn utilisé pour s’abonner à cet événement.

off("roleChanged", PropertyChangedEvent)

Fonction De désabonnement pour l’événement roleChanged.

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

Paramètres

event

"roleChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("stateChanged", PropertyChangedEvent)

Fonction De désabonnement pour l’événement stateChanged.

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

Paramètres

event

"stateChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("totalParticipantCountChanged", PropertyChangedEvent)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

fonction de désabonnement pour l’événement totalParticipantCountChanged.

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

Paramètres

event

"totalParticipantCountChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque le nombre de participants change.

on("idChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement idChanged.

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

Paramètres

event

"idChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.

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

Paramètres

event

"isIncomingAudioMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isLocalVideoStartedChanged.

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

Paramètres

event

"isLocalVideoStartedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("isMutedChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isMutedChanged.

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

Paramètres

event

"isMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("isScreenSharingOnChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement isScreenSharingChanged.

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

Paramètres

event

"isScreenSharingOnChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Fonction Subscribe pour l’événement localAudioStreamsUpdated.

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

Paramètres

event

"localAudioStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<LocalAudioStream>

rappel fn qui sera appelé lorsque cette collection va changer, elle transmet des tableaux d’éléments ajoutés et supprimés.

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Fonction Subscribe pour l’événement localVideoStreamsUpdated.

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

Paramètres

event

"localVideoStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<LocalVideoStream>

rappel fn qui sera appelé lorsque cette collection va changer, elle transmet des tableaux d’éléments ajoutés et supprimés.

on("mutedByOthers", PropertyChangedEvent)

Fonction d’abonnement pour l’événement mutedByOthers.

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

Paramètres

event

"mutedByOthers"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Fonction Subscribe pour l’événement remoteAudioStreamsUpdated.

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

Paramètres

event

"remoteAudioStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteAudioStream>

rappel fn qui sera appelé lorsque cette collection va changer, elle transmet des tableaux d’éléments ajoutés et supprimés.

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Fonction Subscribe pour l’événement remoteParticipantsUpdated.

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

Paramètres

event

"remoteParticipantsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteParticipant>

rappel fn qui sera appelé lorsque cette collection va changer, elle transmet des tableaux d’éléments ajoutés et supprimés.

on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement roleChanged.

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

Paramètres

event

"roleChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("stateChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement stateChanged.

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

Paramètres

event

"stateChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("totalParticipantCountChanged", PropertyChangedEvent)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Fonction Subscribe pour l’événement totalParticipantCountChanged.

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

Paramètres

event

"totalParticipantCountChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn qui sera appelé lorsque le nombre de participants change.

resume()

Reprendre cet appel s’il se trouve sur l’état « LocalHold ».

function resume(): Promise<void>

Retours

Promise<void>

sendDtmf(DtmfTone)

Envoyer le ton DTMF.

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

Paramètres

dtmfTone
DtmfTone

Retours

Promise<void>

setConstraints(CallConstraints)

Définissez des contraintes d’appel. Cette méthode définit les contraintes maximales de basées sur les valeurs fournies. Les contraintes appliquées finales seront inférieures ou égales aux valeurs fournies ici à cette méthode. Si la valeur 0 est fournie, aucune contrainte n’est appliquée à cette contrainte. Si une valeur non définie est fournie, la valeur précédente utilisée sera utilisée pour cette contrainte.

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

Paramètres

constraints
CallConstraints

Objet représentant les contraintes d’appel à définir

Retours

Promise<void>

startAudio(LocalAudioStream)

Démarrez l’audio dans l’appel avec l’audio personnalisé. La source LocalAudioStream doit être Un MediaStream.

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

Paramètres

localAudioStream
LocalAudioStream

Retours

Promise<void>

startScreenSharing()

  • Commencez à envoyer un flux de partage d’écran dans un appel. Le navigateur invite à sélectionner l’écran, l’application ou l’onglet navigateur.
  • L’envoi d’un flux de partage d’écran n’est pas pris en charge sur iOS ni Android.
  • Le flux de partage d’écran entrant est pris en charge sur iOS et Android.
function startScreenSharing(): Promise<void>

Retours

Promise<void>

startScreenSharing(LocalVideoStream)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

  • Commencez à envoyer un flux de partage d’écran brut dans un appel.
  • L’envoi d’un partage d’écran brut n’est pas pris en charge sur iOS ni Android.
  • Le partage d’écran brut entrant est pris en charge sur iOS et Android.
function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Paramètres

localVideoStream
LocalVideoStream

Représente un flux de partage d’écran brut local qui prend un MediaStream dans le constructeur.

Retours

Promise<void>

startVideo(LocalVideoStream)

Commencez à envoyer le flux vidéo dans l’appel. Les participants distants de l’appel recevront votre flux vidéo afin qu’ils puissent le rendre dans leurs INTERFACES utilisateur.

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

Paramètres

localVideoStream
LocalVideoStream

Représente un flux vidéo local qui prend une source de caméra dans le constructeur.

Retours

Promise<void>

stopAudio()

Arrêtez l’audio personnalisé dans l’appel et basculez vers l’appareil audio par défaut du Gestionnaire d’appareils.

function stopAudio()

stopScreenSharing()

Arrêtez le partage d’écran local.

function stopScreenSharing(): Promise<void>

Retours

Promise<void>

stopScreenSharing(LocalVideoStream)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Arrêtez le partage d’écran local.

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

Paramètres

localVideoStream
LocalVideoStream

Flux de partage d’écran local pour arrêter la diffusion en continu.

Retours

Promise<void>

stopVideo(LocalVideoStream)

Arrêtez l’envoi du flux vidéo dans l’appel. Doit passer le même objet LocalVideoStream utilisé pour démarrer la vidéo dans l’API CallAgent.startCall(), l’API CallAgent.join(), l’API IncomingCall.accept() ou l’API Call.startVideo().

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

Paramètres

localVideoStream
LocalVideoStream

Flux vidéo local pour arrêter la diffusion en continu.

Retours

Promise<void>

unmute()

Activer le microphone local.

function unmute(): Promise<void>

Retours

Promise<void>

unmuteIncomingAudio()

Activer l’audio entrant.

function unmuteIncomingAudio(): Promise<void>

Retours

Promise<void>

Détails de la méthode héritée

dispose() 

function dispose()

héritée dejetable.dispose