Class MatrixCall

Construct a new Matrix Call.

Param

Config options.

Param

The room ID for this call.

Param

The WebRTC globals from the browser.

Param

whether relay through TURN should be forced.

Param

The URL global.

Param

Optional. A list of TURN servers.

Param

The Matrix Client instance to send events to.

Hierarchy

Constructors

constructor

Properties

callId callLength callLengthInterval? callStatsAtEnd? candidateSendQueue candidateSendTries candidatesEnded client direction? feeds forceTURN? groupCallId? hangupParty? hangupReason? iceDisconnectedTimeout? ignoreOffer inviteOrAnswerSent inviteTimeout? invitee? isPtt makingOffer opponentCaps? opponentDeviceId? opponentDeviceInfo? opponentMember? opponentPartyId opponentSessionId? opponentVersion? ourPartyId peerConn? remoteAssertedIdentity? remoteCandidateBuffer remoteOnHold remoteSDPStreamMetadata? removeTrackListeners responsePromiseChain? roomId? state successor? toDeviceSeq transceivers turnServers waitForLocalAVStream

Accessors

hasLocalUserMediaAudioTrack hasLocalUserMediaVideoTrack hasPeerConnection hasRemoteUserMediaAudioTrack hasRemoteUserMediaVideoTrack localScreensharingFeed localScreensharingStream localUsermediaFeed localUsermediaStream remoteScreensharingFeed remoteScreensharingStream remoteUsermediaFeed remoteUsermediaStream type

Methods

addBufferedIceCandidates addIceCandidates addListener answer answerWithCallFeeds callHasEnded checkForErrorListener chooseOpponent collectCallStats createAnswer createDataChannel createOffer createPeerConnection deleteAllFeeds deleteFeed deleteFeedByStream discardDuplicateCandidates emit eventNames getCurrentCallStats getFeedByStreamId getFeeds getLocalFeeds getLocalOfferFailed getLocalSDPStreamMetadata getOpponentMember getOpponentSessionId getRemoteAssertedIdentity getRemoteFeeds getRidOfRTXCodecs getUserMediaFailed gotCallFeedsForAnswer gotCallFeedsForInvite gotLocalIceCandidate gotLocalOffer hangup initOpponentCrypto initWithHangup initWithInvite isLocalOnHold isLocalVideoMuted isMicrophoneMuted isRemoteOnHold isScreensharing listenerCount listeners mungeSdp noIncomingFeeds off on onAnswerReceived onAnsweredElsewhere onAssertedIdentityReceived onDataChannel onHangupReceived onIceConnectionStateChanged onIceGatheringStateChange onNegotiateReceived onNegotiationNeeded onRejectReceived onRemoteIceCandidatesReceived onSDPStreamMetadataChangedReceived onSelectAnswerReceived onSignallingStateChanged onTrack once opponentCanBeTransferred opponentSupportsDTMF opponentSupportsSDPStreamMetadata partyIdMatches placeCall placeCallWithCallFeeds placeVideoCall placeVoiceCall prependListener prependOnceListener pushLocalFeed pushNewLocalFeed pushRemoteFeed pushRemoteFeedWithoutMetadata queueCandidate queueGotCallFeedsForAnswer queueGotLocalOffer rawListeners reject removeAllListeners removeListener removeLocalFeed replacedBy sendAnswer sendCandidateQueue sendDtmfDigit sendMetadataUpdate sendVoipEvent setLocalVideoMuted setMicrophoneMuted setRemoteOnHold setScreensharingEnabled setScreensharingEnabledWithoutMetadataSupport setState shouldAnswerWithMediaType stopAllMedia terminate transfer transferToCall updateLocalUsermediaStream updateMuteStatus updateRemoteSDPStreamMetadata upgradeCall wrappedGotLocalOffer

Constructors

constructor

Properties

callId

callId: string

Private callLength

callLength: number = 0

Private Optional callLengthInterval

callLengthInterval?: Timer

Private Optional callStatsAtEnd

callStatsAtEnd?: any[]

Private candidateSendQueue

candidateSendQueue: RTCIceCandidate[] = []

Private candidateSendTries

candidateSendTries: number = 0

Private candidatesEnded

candidatesEnded: boolean = false

Private Readonly client

client: MatrixClient

Optional direction

direction?: CallDirection

Private feeds

feeds: CallFeed[] = []

Private Optional Readonly forceTURN

forceTURN?: boolean

Optional groupCallId

groupCallId?: string

Optional hangupParty

hangupParty?: CallParty

Optional hangupReason

hangupReason?: string

Private Optional iceDisconnectedTimeout

iceDisconnectedTimeout?: Timeout

Private ignoreOffer

ignoreOffer: boolean = false

Private inviteOrAnswerSent

inviteOrAnswerSent: boolean = false

Private Optional inviteTimeout

inviteTimeout?: Timeout

Optional invitee

invitee?: string

isPtt

isPtt: boolean = false

Private makingOffer

makingOffer: boolean = false

Private Optional opponentCaps

opponentCaps?: CallCapabilities

Private Optional opponentDeviceId

opponentDeviceId?: string

Private Optional opponentDeviceInfo

opponentDeviceInfo?: DeviceInfo

Private Optional opponentMember

opponentMember?: RoomMember

Private opponentPartyId

opponentPartyId: undefined | null | string

Private Optional opponentSessionId

opponentSessionId?: string

Private Optional opponentVersion

opponentVersion?: string | number

ourPartyId

ourPartyId: string

Optional peerConn

peerConn?: RTCPeerConnection

Private Optional remoteAssertedIdentity

remoteAssertedIdentity?: AssertedIdentity

Private remoteCandidateBuffer

remoteCandidateBuffer: Map<string, RTCIceCandidate[]> = ...

Private remoteOnHold

remoteOnHold: boolean = false

Private Optional remoteSDPStreamMetadata

remoteSDPStreamMetadata?: SDPStreamMetadata

Private Readonly removeTrackListeners

removeTrackListeners: Map<MediaStream, (() => void)> = ...

Private Optional responsePromiseChain

responsePromiseChain?: Promise<void>

Optional roomId

roomId?: string

state

state: CallState = CallState.Fledgling

Private Optional successor

successor?: MatrixCall

toDeviceSeq

toDeviceSeq: number = 0

Private transceivers

transceivers: Map<string, RTCRtpTransceiver> = ...

Private Readonly turnServers

turnServers: TurnServer[]

Private waitForLocalAVStream

waitForLocalAVStream: boolean = false

Accessors

hasLocalUserMediaAudioTrack

hasLocalUserMediaVideoTrack

hasPeerConnection

hasRemoteUserMediaAudioTrack

hasRemoteUserMediaVideoTrack

localScreensharingFeed

localScreensharingStream

  • get localScreensharingStream(): undefined | MediaStream

  • Returns undefined | MediaStream

localUsermediaFeed

localUsermediaStream

  • get localUsermediaStream(): undefined | MediaStream

  • Returns undefined | MediaStream

remoteScreensharingFeed

remoteScreensharingStream

  • get remoteScreensharingStream(): undefined | MediaStream

  • Returns undefined | MediaStream

remoteUsermediaFeed

remoteUsermediaStream

  • get remoteUsermediaStream(): undefined | MediaStream

  • Returns undefined | MediaStream

type

Methods

Private addBufferedIceCandidates

Private addIceCandidates

  • Parameters

    • candidates: RTCIceCandidate[]

    Returns Promise<void>

addListener

answer

  • Answer a call.

    Parameters

    • Optional audio: boolean
    • Optional video: boolean

    Returns Promise<void>

answerWithCallFeeds

callHasEnded

Private checkForErrorListener

Private chooseOpponent

Private collectCallStats

  • Returns Promise<undefined | any[]>

Private createAnswer

  • Returns Promise<RTCSessionDescriptionInit>

createDataChannel

  • Create a datachannel using this call's peer connection.

    Parameters

    • label: string

      A human readable label for this datachannel

    • options: undefined | RTCDataChannelInit

      An object providing configuration options for the data channel.

    Returns RTCDataChannel

Private createOffer

  • Returns Promise<RTCSessionDescriptionInit>

Private createPeerConnection

Private deleteAllFeeds

Private deleteFeed

Private deleteFeedByStream

  • Parameters

    • stream: MediaStream

    Returns void

Private discardDuplicateCandidates

emit

eventNames

getCurrentCallStats

  • Returns Promise<undefined | any[]>

Private getFeedByStreamId

getFeeds

getLocalFeeds

Private getLocalOfferFailed

Private getLocalSDPStreamMetadata

getOpponentMember

getOpponentSessionId

getRemoteAssertedIdentity

getRemoteFeeds

Private getRidOfRTXCodecs

  • This method removes all video/rtx codecs from screensharing video transceivers. This is necessary since they can cause problems. Without this the following steps should produce an error: Chromium calls Firefox Firefox answers Firefox starts screen-sharing Chromium starts screen-sharing Call crashes for Chromium with: [96685:23:0518/162603.933321:ERROR:webrtc_video_engine.cc(3296)] RTX codec (PT=97) mapped to PT=96 which is not in the codec list. [96685:23:0518/162603.933377:ERROR:webrtc_video_engine.cc(1171)] GetChangedRecvParameters called without any video codecs. [96685:23:0518/162603.933430:ERROR:sdp_offer_answer.cc(4302)] Failed to set local video description recv parameters for m-section with mid='2'. (INVALID_PARAMETER)

    Returns void

Private getUserMediaFailed

Private gotCallFeedsForAnswer

Private gotCallFeedsForInvite

  • Parameters

    • callFeeds: CallFeed[]
    • requestScreenshareFeed: boolean = false

    Returns void

Private gotLocalIceCandidate

  • Internal

    Parameters

    • event: RTCPeerConnectionIceEvent

    Returns void

Private gotLocalOffer

hangup

  • Hangup a call.

    Parameters

    • reason: CallErrorCode

      The reason why the call is being hung up.

    • suppressEvent: boolean

      True to suppress emitting an event.

    Returns void

Private initOpponentCrypto

initWithHangup

initWithInvite

  • Configure this call from an invite event. Used by MatrixClient.

    Parameters

    Returns Promise<void>

isLocalOnHold

  • Indicates whether we are 'on hold' to the remote party (ie. if true, they cannot hear us).

    Returns

    true if the other party has put us on hold

    Returns boolean

isLocalVideoMuted

  • Check if local video is muted.

    If there are multiple video tracks, all of the tracks need to be muted for this to return true. This means if there are no video tracks, this will return true.

    Returns

    True if the local preview video is muted, else false (including if the call is not set up yet).

    Returns boolean

isMicrophoneMuted

  • Check if the microphone is muted.

    If there are multiple audio tracks, all of the tracks need to be muted for this to return true. This means if there are no audio tracks, this will return true.

    Returns

    True if the mic is muted, else false (including if the call is not set up yet).

    Returns boolean

isRemoteOnHold

  • Returns

    true if we have put the party on the other side of the call on hold (that is, we are signalling to them that we are not listening)

    Returns boolean

isScreensharing

  • If there is a screensharing stream returns true, otherwise returns false

    Returns

    is screensharing

    Returns boolean

listenerCount

listeners

Private mungeSdp

noIncomingFeeds

  • Returns true if there are no incoming feeds, otherwise returns false

    Returns

    no incoming feeds

    Returns boolean

off

on

onAnswerReceived

onAnsweredElsewhere

onAssertedIdentityReceived

Private onDataChannel

  • Parameters

    • ev: RTCDataChannelEvent

    Returns void

onHangupReceived

Private onIceConnectionStateChanged

Private onIceGatheringStateChange

  • Parameters

    • event: Event

    Returns void

onNegotiateReceived

Private onNegotiationNeeded

onRejectReceived

onRemoteIceCandidatesReceived

onSDPStreamMetadataChangedReceived

onSelectAnswerReceived

Private onSignallingStateChanged

Private onTrack

once

opponentCanBeTransferred

opponentSupportsDTMF

opponentSupportsSDPStreamMetadata

  • Returns true if this.remoteSDPStreamMetadata is defined, otherwise returns false

    Returns

    can screenshare

    Returns boolean

Private partyIdMatches

placeCall

  • Place a call to this room.

    Throws

    if you have not specified a listener for 'error' events.

    Throws

    if have passed audio=false.

    Parameters

    • audio: boolean
    • video: boolean

    Returns Promise<void>

placeCallWithCallFeeds

  • Place a call to this room with call feed.

    Throws

    if you have not specified a listener for 'error' events.

    Throws

    if have passed audio=false.

    Parameters

    • callFeeds: CallFeed[]

      to use

    • requestScreenshareFeed: boolean = false

    Returns Promise<void>

placeVideoCall

  • Place a video call to this room.

    Throws

    If you have not specified a listener for 'error' events.

    Returns Promise<void>

placeVoiceCall

  • Place a voice call to this room.

    Throws

    If you have not specified a listener for 'error' events.

    Returns Promise<void>

prependListener

prependOnceListener

pushLocalFeed

  • Pushes supplied feed to the call

    Parameters

    • callFeed: CallFeed

      to push

    • addToPeerConnection: boolean = true

      whether to add the tracks to the peer connection

    Returns void

Private pushNewLocalFeed

Private pushRemoteFeed

  • Parameters

    • stream: MediaStream

    Returns void

Private pushRemoteFeedWithoutMetadata

  • This method is used ONLY if the other client doesn't support sending SDPStreamMetadata

    Parameters

    • stream: MediaStream

    Returns void

Private queueCandidate

  • Queue a candidate to be sent

    Parameters

    • content: null | RTCIceCandidate

      The candidate to queue up, or null if candidates have finished being generated and end-of-candidates should be signalled

    Returns void

Private queueGotCallFeedsForAnswer

Private queueGotLocalOffer

rawListeners

reject

  • Reject a call This used to be done by calling hangup, but is a separate method and protocol event as of MSC2746.

    Returns void

removeAllListeners

removeListener

removeLocalFeed

  • Removes local call feed from the call and its tracks from the peer connection

    Parameters

    Returns void

replacedBy

  • Replace this call with a new call, e.g. for glare resolution. Used by MatrixClient.

    Parameters

    Returns void

Private sendAnswer

Private sendCandidateQueue

sendDtmfDigit

  • Sends a DTMF digit to the other party

    Parameters

    • digit: string

      The digit (nb. string - '#' and '*' are dtmf too)

    Returns void

sendMetadataUpdate

Private sendVoipEvent

  • Internal

    Returns

    Parameters

    • eventType: string
    • content: object

    Returns Promise<void>

setLocalVideoMuted

  • Set whether our outbound video should be muted or not.

    Returns

    the new mute state

    Parameters

    • muted: boolean

      True to mute the outbound video.

    Returns Promise<boolean>

setMicrophoneMuted

  • Set whether the microphone should be muted or not.

    Returns

    the new mute state

    Parameters

    • muted: boolean

      True to mute the mic.

    Returns Promise<boolean>

setRemoteOnHold

setScreensharingEnabled

  • Starts/stops screensharing

    Returns

    new screensharing state

    Parameters

    Returns Promise<boolean>

Private setScreensharingEnabledWithoutMetadataSupport

  • Starts/stops screensharing Should be used ONLY if the opponent doesn't support SDPStreamMetadata

    Returns

    new screensharing state

    Parameters

    Returns Promise<boolean>

Private setState

Private shouldAnswerWithMediaType

  • Parameters

    • wantedValue: undefined | boolean
    • valueOfTheOtherSide: boolean
    • type: "audio" | "video"

    Returns boolean

Private stopAllMedia

Private terminate

transfer

  • Parameters

    • targetUserId: string

    Returns Promise<void>

transferToCall

updateLocalUsermediaStream

  • Replaces/adds the tracks from the passed stream to the localUsermediaStream

    Parameters

    • stream: MediaStream

      to use a replacement for the local usermedia stream

    • forceAudio: boolean = false
    • forceVideo: boolean = false

    Returns Promise<void>

Private updateMuteStatus

Private updateRemoteSDPStreamMetadata

Private upgradeCall

  • Adds an audio and/or video track - upgrades the call

    Parameters

    • audio: boolean

      should add an audio track

    • video: boolean

      should add an video track

    Returns Promise<void>

Private wrappedGotLocalOffer

Settings

Member Visibility

Theme

Generated using TypeDoc