Call interface
Représente un appel.
- Extends
Propriétés
info | Obtenez des informations sur cet appel. |
Propriétés héritées
call |
Contenant du code/sous-code indiquant comment cet appel s’est terminé. |
caller |
Informations de l’appelant si cet appel est entrant. |
direction | Obtenez le sens de l’appel, qu’il soit entrant ou sortant. |
id | Obtenez l’ID unique de cet appel. |
is |
Indique si l’utilisateur local a désactivé l’audio entrant. |
is |
Indique si la vidéo locale est activée. |
is |
Indique si l’utilisateur local est désactivé, localement ou à distance. |
is |
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. |
local |
Collection de flux audio locaux envoyés à d’autres participants à un appel. |
local |
Collection de flux vidéo locaux envoyés à d’autres participants à un appel. |
remote |
Collection de flux audio distants reçus à partir de l’appel. |
remote |
Collection de participants distants à cet appel. En cas d’appels avec des participants d’une centaine ou plus, seuls les participants actifs dans les mé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. |
total |
Nombre total de participants à cet appel. |
Méthodes
add |
Ajoutez un participant à cet appel. |
add |
Ajoutez un participant à cet appel. |
add |
Ajoutez une application Teams à cet appel. |
add |
Ajoutez un participant à cet appel. |
add |
Ajoutez un participant à cet appel. |
remove |
Supprimer un participant de cet appel. |
Méthodes héritées
dispose() | |
feature<TFeature>(Call |
Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Vérifiez l’objet Features.* pour toutes les fonctionnalités d’appel étendu disponibles dans ce package, par exemple :
|
hang |
Raccrocher l’appel. |
hold() | Mettez cet appel en attente. |
mute() | Désactiver le microphone local. |
mute |
Désactivez tous les participants distants. |
mute |
Désactiver le son entrant. |
off("id |
Fonction de désabonnement pour l’événement idChanged. |
off("is |
Fonction Subscribe pour l’événement isIncomingAudioMutedChanged. |
off("is |
Fonction de désabonnement pour l’événement isLocalVideoStartedChanged. |
off("is |
Fonction d’abonnement pour l’événement isMutedChanged. |
off("is |
Fonction de désabonnement pour l’événement isScreenSharingChanged. |
off("local |
Fonction de désabonnement pour l’événement localAudioStreamsUpdated. |
off("local |
Fonction de désabonnement pour l’événement localVideoStreamsUpdated. |
off("muted |
Fonction de désabonnement pour l’événement mutedByOthers. |
off("remote |
Fonction de désabonnement pour l’événement remoteAudioStreamsUpdated. |
off("remote |
Fonction unsubscribe pour l’événement remoteParticipantsUpdated. |
off("role |
Fonction de désabonnement pour l’événement roleChanged. |
off("state |
Fonction de désabonnement pour l’événement stateChanged. |
off("total |
Fonction unsubscribe pour l’événement totalParticipantCountChanged. |
on("id |
Fonction d’abonnement pour l’événement idChanged. |
on("is |
Fonction Subscribe pour l’événement isIncomingAudioMutedChanged. |
on("is |
Fonction Subscribe pour l’événement isLocalVideoStartedChanged. |
on("is |
Fonction d’abonnement pour l’événement isMutedChanged. |
on("is |
Fonction Subscribe pour l’événement isScreenSharingChanged. |
on("local |
Fonction d’abonnement pour l’événement localAudioStreamsUpdated. |
on("local |
Fonction d’abonnement pour l’événement localVideoStreamsUpdated. |
on("muted |
Fonction Subscribe pour l’événement mutedByOthers. |
on("remote |
Fonction d’abonnement pour l’événement remoteAudioStreamsUpdated. |
on("remote |
Fonction d’abonnement pour l’événement remoteParticipantsUpdated. |
on("role |
Fonction d’abonnement pour l’événement roleChanged. |
on("state |
Fonction d’abonnement pour l’événement stateChanged. |
on("total |
Fonction d’abonnement pour l’événement totalParticipantCountChanged. |
resume() | Reprenez cet appel s’il est à l’état « LocalHold ». |
send |
Envoyer la tonalité DTMF. |
set |
Définissez des contraintes d’appel. Cette méthode définit les contraintes maximales de en fonction des valeurs fournies. Les contraintes appliquées finales seront inférieures ou égales aux valeurs fournies ici pour cette méthode. Si la valeur 0 est fournie, aucune contrainte n’est appliquée pour cette contrainte. Si une valeur non définie est fournie, la valeur précédente utilisée est utilisée pour cette contrainte. |
start |
Démarrez l’audio dans l’appel avec l’audio personnalisé. La source LocalAudioStream doit être un MediaStream. |
start |
|
start |
|
start |
Commencez à envoyer un flux vidéo dans l’appel. Les participants distants à l’appel recevront votre flux vidéo afin qu’ils puissent le restituer dans leurs interfaces utilisateur. |
stop |
Arrêtez l’audio personnalisé dans l’appel et basculez vers périphérique audio par défaut du Gestionnaire de périphériques. |
stop |
Arrêtez le partage d’écran local. |
stop |
Arrêtez le partage d’écran local. |
stop |
Arrêtez l’envoi de flux vidéo dans l’appel. Doit passer le même objet LocalVideoStream que celui 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() | Réactivez le microphone local. |
unmute |
Réactivez le son entrant. |
Détails de la propriété
info
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.
Obtenez des informations sur cet appel.
info: CallInfo
Valeur de propriété
Détails de la propriété héritée
callEndReason
Contenant du code/sous-code indiquant comment cet appel s’est terminé.
callEndReason?: CallEndReason
Valeur de propriété
Hérité deCallCommon.callEndReason
callerInfo
Informations de l’appelant si cet appel est entrant.
callerInfo: CallerInfo
Valeur de propriété
Hérité deCallCommon.callerInfo
direction
Obtenez le sens de l’appel, qu’il soit entrant ou sortant.
direction: CallDirection
Valeur de propriété
Hérité deCallCommon.direction
id
isIncomingAudioMuted
Indique si l’utilisateur local a désactivé l’audio entrant.
isIncomingAudioMuted: boolean
Valeur de propriété
boolean
Hérité deCallCommon.isIncomingAudioMuted
isLocalVideoStarted
Indique si la vidéo locale est activée.
isLocalVideoStarted: boolean
Valeur de propriété
boolean
Hérité deCallCommon.isLocalVideoStarted
isMuted
Indique si l’utilisateur local est désactivé, localement ou à distance.
isMuted: boolean
Valeur de propriété
boolean
Hérité deCallCommon.isMuted
isScreenSharingOn
Indique si le partage d’écran est activé.
isScreenSharingOn: boolean
Valeur de propriété
boolean
Hérité deCallCommon.isScreenSharingOn
kind
lobby
Obtenez la salle d’attente de la réunion Teams.
lobby: Lobby
Valeur de propriété
Hérité deCallCommon.lobby
localAudioStreams
Collection de flux audio locaux envoyés à d’autres participants à un appel.
localAudioStreams: readonly LocalAudioStream[]
Valeur de propriété
readonly LocalAudioStream[]
Hérité deCallCommon.localAudioStreams
localVideoStreams
Collection de flux vidéo locaux envoyés à d’autres participants à un appel.
localVideoStreams: readonly LocalVideoStream[]
Valeur de propriété
readonly LocalVideoStream[]
Hérité deCallCommon.localVideoStreams
remoteAudioStreams
Collection de flux audio distants reçus à partir de l’appel.
remoteAudioStreams: readonly RemoteAudioStream[]
Valeur de propriété
readonly RemoteAudioStream[]
Hérité deCallCommon.remoteAudioStreams
remoteParticipants
Collection de participants distants à cet appel. En cas d’appels avec des participants d’une centaine ou plus, seuls les participants actifs dans les médias sont présents dans cette collection.
remoteParticipants: readonly RemoteParticipant[]
Valeur de propriété
readonly RemoteParticipant[]
Hérité deCallCommon.remoteParticipants
role
Obtenez le rôle de l’utilisateur local dans l’appel.
role: ParticipantRole
Valeur de propriété
Hérité deCallCommon.role
state
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 à cet appel.
totalParticipantCount: number
Valeur de propriété
number
Hérité deCallCommon.totalParticipantCount
Détails de la méthode
addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)
Ajoutez un participant à cet appel.
function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant
Paramètres
- identifier
Identificateur du participant à ajouter.
Retours
Objet RemoteParticipant associé au participant ajouté avec succès.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)
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.
Ajoutez un participant à cet appel.
function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant
Paramètres
- identifier
- CommunicationUserIdentifier
Identificateur du participant à ajouter.
- options
- AddCommunicationUserOptions
Options supplémentaires pour la gestion de l’appel.
Retours
Objet RemoteParticipant associé au participant ajouté avec succès.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)
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.
Ajoutez une application Teams à cet appel.
function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant
Paramètres
- identifier
Identificateur de l’application Teams à ajouter.
Retours
Objet RemoteParticipant associé à l’application Teams correctement ajoutée.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)
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.
Ajoutez un participant à cet appel.
function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant
Paramètres
- identifier
- MicrosoftTeamsUserIdentifier
Identificateur du participant à ajouter.
- options
- AddMicrosoftTeamsUserOptions
Options supplémentaires pour la gestion de l’appel.
Retours
Objet RemoteParticipant associé au participant ajouté avec succès.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Ajoutez un participant à cet appel.
function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant
Paramètres
- identifier
- PhoneNumberIdentifier
Identificateur du participant à ajouter.
- options
- AddPhoneNumberOptions
Options supplémentaires pour la gestion de l’appel RTC. Par exemple, la définition du numéro de téléphone id de l’appelant dans un appel RTC.
Retours
Objet RemoteParticipant associé au participant ajouté avec succès.
removeParticipant(CommunicationIdentifier)
Supprimer un participant de cet appel.
function removeParticipant(identifier: CommunicationIdentifier): Promise<void>
Paramètres
- identifier
- CommunicationIdentifier
Identificateur du participant à supprimer.
Retours
Promise<void>
Détails de la méthode héritée
dispose()
function dispose()
Hérité deCallCommon.dispose
feature<TFeature>(CallFeatureFactory<TFeature>)
Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Vérifiez l’objet Features.* pour toutes les fonctionnalités d’appel étendu 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é d’appel qui fournit une API étendue.
Retours
TFeature
Hérité deCallCommon.feature
hangUp(HangUpOptions)
Raccrocher l’appel.
function hangUp(options?: HangUpOptions): Promise<void>
Paramètres
- options
- HangUpOptions
Options de blocage.
Retours
Promise<void>
Hérité deCallCommon.hangUp
hold()
Mettez cet appel en attente.
function hold(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.hold
mute()
Désactiver le microphone local.
function mute(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.mute
muteAllRemoteParticipants()
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.
Désactivez tous les participants distants.
function muteAllRemoteParticipants(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.muteAllRemoteParticipants
muteIncomingAudio()
Désactiver le son entrant.
function muteIncomingAudio(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.muteIncomingAudio
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.
Hérité deCallCommon.off
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.off
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.off
off("isMutedChanged", PropertyChangedEvent)
Fonction d’abonnement pour l’événement isMutedChanged.
function off(event: "isMutedChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"isMutedChanged"
nom de l’événement.
- listener
- PropertyChangedEvent
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.off
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.
Hérité deCallCommon.off
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
rappel fn utilisé pour s’abonner à cet événement.
Hérité deCallCommon.off
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
rappel fn utilisé pour s’abonner à cet événement.
Hérité deCallCommon.off
off("mutedByOthers", 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 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.
Hérité deCallCommon.off
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
rappel fn utilisé pour s’abonner à cet événement.
Hérité deCallCommon.off
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Fonction unsubscribe pour l’événement remoteParticipantsUpdated.
function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Paramètres
- event
-
"remoteParticipantsUpdated"
nom de l’événement.
- listener
rappel fn utilisé pour s’abonner à cet événement.
Hérité deCallCommon.off
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.
Hérité deCallCommon.off
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.
Hérité deCallCommon.off
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 unsubscribe pour l’événement totalParticipantCountChanged.
function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"totalParticipantCountChanged"
nom de l’événement.
- listener
- PropertyChangedEvent
callback fn qui sera appelé lorsque le nombre de participants change.
Hérité deCallCommon.off
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
on("isMutedChanged", PropertyChangedEvent)
Fonction d’abonnement pour l’événement isMutedChanged.
function on(event: "isMutedChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"isMutedChanged"
nom de l’événement.
- listener
- PropertyChangedEvent
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)
Fonction d’abonnement pour l’événement localAudioStreamsUpdated.
function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)
Paramètres
- event
-
"localAudioStreamsUpdated"
nom de l’événement.
- listener
callback fn qui sera appelé lorsque cette collection changera, il passera des tableaux d’éléments ajoutés et supprimés.
Hérité deCallCommon.on
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
Fonction d’abonnement pour l’événement localVideoStreamsUpdated.
function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)
Paramètres
- event
-
"localVideoStreamsUpdated"
nom de l’événement.
- listener
callback fn qui sera appelé lorsque cette collection changera, il passera des tableaux d’éléments ajoutés et supprimés.
Hérité deCallCommon.on
on("mutedByOthers", 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 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.
Hérité deCallCommon.on
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)
Fonction d’abonnement pour l’événement remoteAudioStreamsUpdated.
function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)
Paramètres
- event
-
"remoteAudioStreamsUpdated"
nom de l’événement.
- listener
callback fn qui sera appelé lorsque cette collection changera, il passera des tableaux d’éléments ajoutés et supprimés.
Hérité deCallCommon.on
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Fonction d’abonnement pour l’événement remoteParticipantsUpdated.
function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Paramètres
- event
-
"remoteParticipantsUpdated"
nom de l’événement.
- listener
callback fn qui sera appelé lorsque cette collection changera, il passera des tableaux d’éléments ajoutés et supprimés.
Hérité deCallCommon.on
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
Hérité deCallCommon.on
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 d’abonnement pour l’événement totalParticipantCountChanged.
function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"totalParticipantCountChanged"
nom de l’événement.
- listener
- PropertyChangedEvent
callback fn qui sera appelé lorsque le nombre de participants change.
Hérité deCallCommon.on
resume()
Reprenez cet appel s’il est à l’état « LocalHold ».
function resume(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.resume
sendDtmf(DtmfTone)
Envoyer la tonalité DTMF.
function sendDtmf(dtmfTone: DtmfTone): Promise<void>
Paramètres
- dtmfTone
- DtmfTone
Retours
Promise<void>
Hérité deCallCommon.sendDtmf
setConstraints(CallConstraints)
Définissez des contraintes d’appel. Cette méthode définit les contraintes maximales de en fonction des valeurs fournies. Les contraintes appliquées finales seront inférieures ou égales aux valeurs fournies ici pour cette méthode. Si la valeur 0 est fournie, aucune contrainte n’est appliquée pour cette contrainte. Si une valeur non définie est fournie, la valeur précédente utilisée est 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>
Hérité deCallCommon.setConstraints
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>
Hérité deCallCommon.startAudio
startScreenSharing()
- Commencez à envoyer un flux de partage d’écran dans un appel. Le navigateur vous invite à sélectionner l’écran, l’application ou l’onglet du navigateur.
- L’envoi d’un flux de partage d’écran n’est pas pris en charge sur iOS ou Android.
- Le flux de partage d’écran entrant est pris en charge sur iOS et Android.
function startScreenSharing(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.startScreenSharing
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 Sur 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>
Hérité deCallCommon.startScreenSharing
startVideo(LocalVideoStream)
Commencez à envoyer un flux vidéo dans l’appel. Les participants distants à l’appel recevront votre flux vidéo afin qu’ils puissent le restituer 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>
Hérité deCallCommon.startVideo
stopAudio()
Arrêtez l’audio personnalisé dans l’appel et basculez vers périphérique audio par défaut du Gestionnaire de périphériques.
function stopAudio()
Hérité deCallCommon.stopAudio
stopScreenSharing()
Arrêtez le partage d’écran local.
function stopScreenSharing(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.stopScreenSharing
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>
Hérité deCallCommon.stopScreenSharing
stopVideo(LocalVideoStream)
Arrêtez l’envoi de flux vidéo dans l’appel. Doit passer le même objet LocalVideoStream que celui 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 à arrêter.
Retours
Promise<void>
Hérité deCallCommon.stopVideo
unmute()
Réactivez le microphone local.
function unmute(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.unmute
unmuteIncomingAudio()
Réactivez le son entrant.
function unmuteIncomingAudio(): Promise<void>
Retours
Promise<void>
Hérité deCallCommon.unmuteIncomingAudio