TeamsCall interface

Get information about this Teams Call.

info: TeamsCallInfo

Property Value

Containing code/subCode indicating how this call ended.

callEndReason?: CallEndReason

Property Value

Inherited From CallCommon.callEndReason

Caller Information if this call is incoming.

callerInfo: CallerInfo

Property Value

Inherited From CallCommon.callerInfo

Get the call direction, whether it is Incoming or Outgoing.

direction: CallDirection

Property Value

Inherited From CallCommon.direction

Get the unique Id for this Call.

id: string

Property Value

Inherited From CallCommon.id

Whether local user muted incoming audio.

isIncomingAudioMuted: boolean

Property Value

Inherited From CallCommon.isIncomingAudioMuted

Whether local video is on.

isLocalVideoStarted: boolean

Property Value

Inherited From CallCommon.isLocalVideoStarted

Whether local user is muted, locally or remotely.

isMuted: boolean

Property Value

Inherited From CallCommon.isMuted

Whether screen sharing is on.

isScreenSharingOn: boolean

Property Value

Inherited From CallCommon.isScreenSharingOn

Get the kind of call object.

kind: CallKind

Property Value

Inherited From CallCommon.kind

Get the Teams meeting lobby.

lobby: Lobby

Property Value

Inherited From CallCommon.lobby

Collection of local audio streams being sent to other participants in a call.

localAudioStreams: readonly LocalAudioStream[]

Property Value

Inherited From CallCommon.localAudioStreams

Collection of local video streams being sent to other participants in a call.

localVideoStreams: readonly LocalVideoStream[]

Property Value

Inherited From CallCommon.localVideoStreams

Collection of remote audio streams being received from the call.

remoteAudioStreams: readonly RemoteAudioStream[]

Property Value

Inherited From CallCommon.remoteAudioStreams

Collection of remote participants in this call. In case of calls with participants of hundred or more, only media active participants are present in this collection.

remoteParticipants: readonly RemoteParticipant[]

Property Value

Inherited From CallCommon.remoteParticipants

Get the role of the local user in the Call.

role: ParticipantRole

Property Value

Inherited From CallCommon.role

Get the state of this Call.

state: CallState

Property Value

Inherited From CallCommon.state

Count of total number of participants in this call.

totalParticipantCount: number

Property Value

Inherited From CallCommon.totalParticipantCount

Add a participant.

function addParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: AddTeamsParticipantOptions): RemoteParticipant

Parameters

Returns

Remove a participant from this call.

function removeParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier): Promise<void>

Parameters

Returns

function dispose()

Inherited From CallCommon.dispose

Retrieves an initialized and memoized Feature object with extended API. Check the object Features.* for all available extended call features in this package, example:

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

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

Parameters

Returns

Inherited From CallCommon.feature

Hang up the call.

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

Parameters

Returns

Inherited From CallCommon.hangUp

Put this Call on hold.

function hold(): Promise<void>

Returns

Inherited From CallCommon.hold

Mute local microphone.

function mute(): Promise<void>

Returns

Inherited From CallCommon.mute

Mute all remote participants.

function muteAllRemoteParticipants(): Promise<void>

Returns

Inherited From CallCommon.muteAllRemoteParticipants

Mute incoming audio.

function muteIncomingAudio(): Promise<void>

Returns

Inherited From CallCommon.muteIncomingAudio

Unsubscribe function for idChanged event.

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

Parameters

Inherited From CallCommon.off

Subscribe function for isIncomingAudioMutedChanged event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for isLocalVideoStartedChanged event.

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

Parameters

Inherited From CallCommon.off

Subscribe function for isMutedChanged event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for isScreenSharingChanged event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for localAudioStreamsUpdated event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for localVideoStreamsUpdated event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for mutedByOthers event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for remoteAudioStreamsUpdated event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for remoteParticipantsUpdated event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for roleChanged event.

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

Parameters

Inherited From CallCommon.off

Unsubscribe function for stateChanged event.

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

Parameters

Inherited From CallCommon.off

unsubscribe function for totalParticipantCountChanged event.

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

Parameters

Inherited From CallCommon.off

Subscribe function for idChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for isIncomingAudioMutedChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for isLocalVideoStartedChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for isMutedChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for isScreenSharingChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for localAudioStreamsUpdated event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for localVideoStreamsUpdated event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for mutedByOthers event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for remoteAudioStreamsUpdated event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for remoteParticipantsUpdated event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for roleChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for stateChanged event.

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

Parameters

Inherited From CallCommon.on

Subscribe function for totalParticipantCountChanged event.

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

Parameters

Inherited From CallCommon.on

Resume this Call if it is on 'LocalHold' state.

function resume(): Promise<void>

Returns

Inherited From CallCommon.resume

Send DTMF tone.

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

Parameters

Returns

Inherited From CallCommon.sendDtmf

Set call constraints. This method sets the max constraints of based on the values provided. The final applied constraints will be less than or equal to the values provided here to this method. If 0 value is provided, then no constraint will be applied for that constraint. If undefined value is provided, then the previous value used will be used for that constraint.

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

Parameters

Returns

Inherited From CallCommon.setConstraints

Start audio in the call with custom audio. LocalAudioStream source should be a MediaStream.

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

Parameters

Returns

Inherited From CallCommon.startAudio

• Start sending screen sharing stream in a call. Browser will prompt to select the screen, app, or browser tab.
• Sending screen sharing stream is not supported on iOS nor Android.
• Incoming screen sharing stream is supported on iOS and Android.

function startScreenSharing(): Promise<void>

Returns

Inherited From CallCommon.startScreenSharing

• Start sending raw screen sharing stream in a call.
• Sending raw screen sharing is not supported on iOS nor Android.
• Incoming raw screen sharing is supported on iOS and Android.

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

Parameters

Returns

Inherited From CallCommon.startScreenSharing

Start sending video stream in the call. Remote participants in the call will receive your video stream so that they can render it in their UIs.

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

Parameters

Returns

Inherited From CallCommon.startVideo

Stop custom audio in the call and switch to Device manager default audio device.

function stopAudio()

Inherited From CallCommon.stopAudio

Stop local screen sharing.

function stopScreenSharing(): Promise<void>

Returns

Inherited From CallCommon.stopScreenSharing

Stop local screen sharing.

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

Parameters

Returns

Inherited From CallCommon.stopScreenSharing

Stop sending video stream in the call. Must pass the same LocalVideoStream object that was used to start video in the CallAgent.startCall() API, CallAgent.join() API , IncomingCall.accept() API, or Call.startVideo() API.

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

Parameters

Returns

Inherited From CallCommon.stopVideo

Unmute local microphone.

function unmute(): Promise<void>

Returns

Inherited From CallCommon.unmute

Unmute incoming audio.

function unmuteIncomingAudio(): Promise<void>

Returns

Inherited From CallCommon.unmuteIncomingAudio