Call interface

Få information om det här samtalet.

info: CallInfo

Egenskapsvärde

Innehåller kod/underkod som anger hur det här anropet avslutades.

callEndReason?: CallEndReason

Egenskapsvärde

ärvd frånCallCommon.callEndReason

Uppringarinformation om det här samtalet är inkommande.

callerInfo: CallerInfo

Egenskapsvärde

ärvd frånCallCommon.callerInfo

Hämta samtalsriktningen, oavsett om det är Inkommande eller Utgående.

direction: CallDirection

Egenskapsvärde

ärvd frånCallCommon.direction

Hämta det unika ID:t för det här samtalet.

id: string

Egenskapsvärde

ärvs frånCallCommon.id

Om den lokala användaren stängde av inkommande ljud.

isIncomingAudioMuted: boolean

Egenskapsvärde

ärvd frånCallCommon.isIncomingAudioMuted

Om lokal video är på.

isLocalVideoStarted: boolean

Egenskapsvärde

ärvs frånCallCommon.isLocalVideoStarted

Om den lokala användaren är avstängd, lokalt eller via fjärranslutning.

isMuted: boolean

Egenskapsvärde

ärvs frånCallCommon.isMuted

Om skärmdelning är aktiverat.

isScreenSharingOn: boolean

Egenskapsvärde

ärvd frånCallCommon.isScreenSharingOn

Hämta typen av anropsobjekt.

kind: CallKind

Egenskapsvärde

ärvd frånCallCommon.kind

Hämta möteslobbyn för Teams.

lobby: Lobby

Egenskapsvärde

ärvd frånCallCommon.lobby

Insamling av lokala ljudströmmar som skickas till andra deltagare i ett samtal.

localAudioStreams: readonly LocalAudioStream[]

Egenskapsvärde

ärvd frånCallCommon.localAudioStreams

Insamling av lokala videoströmmar som skickas till andra deltagare i ett samtal.

localVideoStreams: readonly LocalVideoStream[]

Egenskapsvärde

ärvd frånCallCommon.localVideoStreams

Insamling av fjärrljudströmmar som tas emot från samtalet.

remoteAudioStreams: readonly RemoteAudioStream[]

Egenskapsvärde

ärvd frånCallCommon.remoteAudioStreams

Insamling av fjärranslutna deltagare i det här samtalet. Vid samtal med deltagare på hundra eller fler finns endast mediaaktiva deltagare i den här samlingen.

remoteParticipants: readonly RemoteParticipant[]

Egenskapsvärde

ärvd frånCallCommon.remoteParticipants

Hämta rollen för den lokala användaren i anropet.

role: ParticipantRole

Egenskapsvärde

ärvs frånCallCommon.role

Hämta tillståndet för det här samtalet.

state: CallState

Egenskapsvärde

ärvs frånCallCommon.state

Antal deltagare i det här samtalet.

totalParticipantCount: number

Egenskapsvärde

ärvd frånCallCommon.totalParticipantCount

Lägg till en deltagare i det här samtalet.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parametrar

Returer

RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.

Lägg till en deltagare i det här samtalet.

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

Parametrar

Returer

RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.

Lägg till en Teams-app i det här anropet.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parametrar

Returer

RemoteParticipant-objektet som är associerat med teams-appen som har lagts till.

Lägg till en deltagare i det här samtalet.

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

Parametrar

Returer

RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.

Lägg till en deltagare i det här samtalet.

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

Parametrar

Returer

RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.

Ta bort en deltagare från det här samtalet.

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

Parametrar

Returer

function dispose()

ärvs frånCallCommon.dispose

Hämtar ett initierat och memorerat funktionsobjekt med utökat API. Kontrollera objektfunktionerna.* för alla tillgängliga funktioner för utökade anrop i det här paketet, till exempel:

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

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

Parametrar

Returer

ärvd frånCallCommon.feature

Lägg på samtalet.

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

Parametrar

Returer

ärvd frånCallCommon.hangUp

Spärra samtalet.

function hold(): Promise<void>

Returer

ärvs frånCallCommon.hold

Stäng av den lokala mikrofonen.

function mute(): Promise<void>

Returer

ärvd frånCallCommon.mute

Stäng av ljudet för alla fjärranslutna deltagare.

function muteAllRemoteParticipants(): Promise<void>

Returer

ärvd frånCallCommon.muteAllRemoteParticipants

Stäng av inkommande ljud.

function muteIncomingAudio(): Promise<void>

Returer

ärvd frånCallCommon.muteIncomingAudio

Avsluta prenumerationsfunktionen för idChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Prenumerationsfunktionen för isIncomingAudioMutedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Funktionen Avbryt prenumeration för isLocalVideoStartedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Prenumerationsfunktionen för isMutedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Funktionen Avbryt prenumeration för isScreenSharingChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Funktionen Avbryt prenumeration för localAudioStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Funktionen Avbryt prenumeration för localVideoStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Avsluta prenumerationsfunktionen för mutedByOthers-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Funktionen Avbryt prenumeration för remoteAudioStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Avprenumerationsfunktionen för remoteParticipantsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Avsluta prenumerationsfunktionen för roleChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Avsluta prenumerationsfunktionen för stateChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

funktionen unsubscribe för totalParticipantCountChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.off

Prenumerationsfunktion för idChanged-händelse.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för isIncomingAudioMutedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för isLocalVideoStartedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för isMutedChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för isScreenSharingChanged-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för localAudioStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för localVideoStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktion för mutedByOthers-händelse.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktionen för remoteAudioStreamsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Funktionen Prenumerera för remoteParticipantsUpdated-händelsen.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktion för roleChanged-händelse.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktion för stateChanged-händelse.

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

Parametrar

ärvd frånCallCommon.on

Prenumerationsfunktion för händelsen totalParticipantCountChanged.

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

Parametrar

ärvd frånCallCommon.on

Återuppta det här anropet om det är i tillståndet "LocalHold".

function resume(): Promise<void>

Returer

ärvs frånCallCommon.resume

Skicka DTMF-ton.

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

Parametrar

Returer

ärvd frånCallCommon.sendDtmf

Ange anropsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de värden som anges. De sista tillämpade begränsningarna är mindre än eller lika med de värden som anges här för den här metoden. Om 0-värdet anges tillämpas ingen begränsning för den begränsningen. Om odefinierat värde anges används det tidigare värdet för den begränsningen.

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

Parametrar

Returer

ärvd frånCallCommon.setConstraints

Starta ljud i samtalet med anpassat ljud. LocalAudioStream-källan ska vara en MediaStream.

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

Parametrar

Returer

ärvd frånCallCommon.startAudio

• Börja skicka skärmdelningsström i ett samtal. Webbläsaren uppmanas att välja fliken skärm, app eller webbläsare.
• Sändning av skärmdelningsström stöds inte på iOS eller Android.
• Inkommande skärmdelningsström stöds på iOS och Android.

function startScreenSharing(): Promise<void>

Returer

ärvd frånCallCommon.startScreenSharing

• Börja skicka rå skärmdelningsström i ett samtal.
• Det går inte att skicka råskärmsdelning på iOS eller Android.
• Inkommande råskärmsdelning stöds på iOS och Android.

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

Parametrar

Returer

ärvd frånCallCommon.startScreenSharing

Börja skicka videoström i samtalet. Fjärrdeltagare i samtalet får din videoström så att de kan återge den i sina UIs.

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

Parametrar

Returer

ärvd frånCallCommon.startVideo

Stoppa anpassat ljud i samtalet och växla till Enhetshanterarens standardljudenhet.

function stopAudio()

ärvd frånCallCommon.stopAudio

Stoppa lokal skärmdelning.

function stopScreenSharing(): Promise<void>

Returer

ärvd frånCallCommon.stopScreenSharing

Stoppa lokal skärmdelning.

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

Parametrar

Returer

ärvd frånCallCommon.stopScreenSharing

Sluta skicka videoström i samtalet. Måste skicka samma LocalVideoStream-objekt som användes för att starta video i API:et CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API eller Call.startVideo().

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

Parametrar

Returer

ärvd frånCallCommon.stopVideo

Slå på den lokala mikrofonen.

function unmute(): Promise<void>

Returer

ärvd frånCallCommon.unmute

Slå på ljudet för inkommande ljud.

function unmuteIncomingAudio(): Promise<void>

Returer

ärvd frånCallCommon.unmuteIncomingAudio