Call interface

Obtenez des informations sur cet appel.

info: CallInfo

Valeur de propriété

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

callEndReason?: CallEndReason

Valeur de propriété

héritée deCallCommon.callEndReason

Informations de l’appelant si cet appel est entrant.

callerInfo: CallerInfo

Valeur de propriété

héritée deCallCommon.callerInfo

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

direction: CallDirection

Valeur de propriété

héritée deCallCommon.direction

Obtenez l’ID unique de cet appel.

id: string

Valeur de propriété

héritée deCallCommon.id

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

isIncomingAudioMuted: boolean

Valeur de propriété

héritée deCallCommon.isIncomingAudioMuted

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

isLocalVideoStarted: boolean

Valeur de propriété

héritée deCallCommon.isLocalVideoStarted

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

isMuted: boolean

Valeur de propriété

héritée deCallCommon.isMuted

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

isScreenSharingOn: boolean

Valeur de propriété

héritée deCallCommon.isScreenSharingOn

Obtenez le type d’objet d’appel.

kind: CallKind

Valeur de propriété

héritée deCallCommon.kind

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

lobby: Lobby

Valeur de propriété

héritée deCallCommon.lobby

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

localAudioStreams: readonly LocalAudioStream[]

Valeur de propriété

héritée deCallCommon.localAudioStreams

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

localVideoStreams: readonly LocalVideoStream[]

Valeur de propriété

héritée deCallCommon.localVideoStreams

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

remoteAudioStreams: readonly RemoteAudioStream[]

Valeur de propriété

héritée deCallCommon.remoteAudioStreams

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é

héritée deCallCommon.remoteParticipants

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

role: ParticipantRole

Valeur de propriété

héritée deCallCommon.role

Obtenez l’état de cet appel.

state: CallState

Valeur de propriété

héritée deCallCommon.state

Nombre total de participants dans cet appel.

totalParticipantCount: number

Valeur de propriété

héritée deCallCommon.totalParticipantCount

Ajoutez un participant à cet appel.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Paramètres

Retours

Objet RemoteParticipant associé au participant ajouté avec succès.

Ajoutez un participant à cet appel.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Paramètres

Retours

Objet RemoteParticipant associé au participant ajouté avec succès.

Ajoutez une application Teams à cet appel.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Paramètres

Retours

Objet RemoteParticipant associé à l’application Teams ajoutée avec succès.

Ajoutez un participant à cet appel.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Paramètres

Retours

Objet RemoteParticipant associé au participant ajouté avec succès.

Ajoutez un participant à cet appel.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Paramètres

Retours

Objet RemoteParticipant associé au participant ajouté avec succès.

Supprimez un participant de cet appel.

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

Paramètres

Retours

function dispose()

héritée deCallCommon.dispose

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

Retours

héritée deCallCommon.feature

Raccrocher l’appel.

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

Paramètres

Retours

héritée deCallCommon.hangUp

Mettez cet appel en attente.

function hold(): Promise<void>

Retours

héritée deCallCommon.hold

Désactiver le micro local.

function mute(): Promise<void>

Retours

héritée deCallCommon.mute

Désactiver le son de tous les participants distants.

function muteAllRemoteParticipants(): Promise<void>

Retours

héritée deCallCommon.muteAllRemoteParticipants

Désactiver le son entrant.

function muteIncomingAudio(): Promise<void>

Retours

héritée deCallCommon.muteIncomingAudio

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

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

Paramètres

héritée deCallCommon.off

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

Fonction Subscribe pour l’événement isMutedChanged.

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.off

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

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement isIncomingAudioMutedChanged.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement isLocalVideoStartedChanged.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement isMutedChanged.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement isScreenSharingChanged.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement localAudioStreamsUpdated.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement localVideoStreamsUpdated.

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

Paramètres

héritée deCallCommon.on

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

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement remoteAudioStreamsUpdated.

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement remoteParticipantsUpdated.

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

Paramètres

héritée deCallCommon.on

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

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

Paramètres

héritée deCallCommon.on

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

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

Paramètres

héritée deCallCommon.on

Fonction Subscribe pour l’événement totalParticipantCountChanged.

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

Paramètres

héritée deCallCommon.on

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

function resume(): Promise<void>

Retours

héritée deCallCommon.resume

Envoyer le ton DTMF.

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

Paramètres

Retours

héritée deCallCommon.sendDtmf

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

Retours

héritée deCallCommon.setConstraints

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

Retours

héritée deCallCommon.startAudio

• 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

héritée deCallCommon.startScreenSharing

• 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

Retours

héritée deCallCommon.startScreenSharing

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

Retours

héritée deCallCommon.startVideo

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

function stopAudio()

héritée deCallCommon.stopAudio

Arrêtez le partage d’écran local.

function stopScreenSharing(): Promise<void>

Retours

héritée deCallCommon.stopScreenSharing

Arrêtez le partage d’écran local.

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

Paramètres

Retours

héritée deCallCommon.stopScreenSharing

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

Retours

héritée deCallCommon.stopVideo

Activer le microphone local.

function unmute(): Promise<void>

Retours

héritée deCallCommon.unmute

Activer l’audio entrant.

function unmuteIncomingAudio(): Promise<void>

Retours

héritée deCallCommon.unmuteIncomingAudio