Class CallMembership

constructor

• new CallMembership(
      matrixEvent: Pick<MatrixEvent, "getId" | "getSender" | "getTs">,
      membershipData: MembershipData,
      rtcBackendIdentity: string,
      logger?: Logger,
  ): CallMembership

  Parameters

  • matrixEvent: Pick<MatrixEvent, "getId" | "getSender" | "getTs">

    The required parts of the Matrix event that this membership is based on

  • membershipData: MembershipData

    The type checked membership data {data: (content of the matrix event), kind: (type hint)}

  • rtcBackendIdentity: string

    Anonymized identity to use with the RTC backend.

    The rtcBackendIdentity is a hashed version of all the identity parts: sha256(${this.userId}|${this.deviceId}|${this.memberId})

    It is used to anonymize the identity of the user in the RTC backend.

  • Optionallogger: Logger

    The constructor will automatically create a properly tagged child logger instance.

  Returns CallMembership

ReadonlyrtcBackendIdentity

application

• get application(): string

  Returns string

applicationData

• get applicationData(): { type: string; [key: string]: unknown }

  Returns { type: string; [key: string]: unknown }

callIntent

• get callIntent(): string | undefined

  Returns string | undefined

deviceId

• get deviceId(): string

  Returns string

eventId

• get eventId(): string

  Returns string

kind

• get kind(): "session" | "rtc"

  Returns "session" | "rtc"

memberId

• get memberId(): string

  This computes the membership ID for the membership. For the sticky event based rtcSessionData this is trivial it is member.id. This is not supposed to be used to identity on an rtc backend. This is just a nouance for a generated (sha256) anonymised identity. Only send rtcBackendIdentity to any rtc backend service.

  For the legacy sessionMemberEvents it is a bit more complex. Here we sometimes do not have this data in the event content and we expected the SFU and the client to use ${this.matrixEventData.sender}:${data.device_id}.

  So if there is no membershipID we use the hard coded jwt id default (${this.matrixEventData.sender}:${data.device_id}) value (used until version 0.16.0)

  It is also possible for a session event to set a custom membershipID. in that case this will be used.

  Returns string

membershipID

• get membershipID(): string

  Returns string

  Deprecated

  renamed to memberId

scope

• get scope(): CallScope | undefined

  Returns CallScope | undefined

  Deprecated

  scope is not used and will be removed in future versions. replaced by application specific types.

sender

• get sender(): string

  Returns string

  Deprecated

  use userId instead

slotDescription

• get slotDescription(): SlotDescription

  Parsed slot_id (format {application}#{id}) into its components (application and id).

  Returns SlotDescription

slotId

• get slotId(): string

  The ID of the MatrixRTC slot that this membership belongs to (format {application}#{id}). This is computed in case SessionMembershipData is used.

  Returns string

transports

• get transports(): Transport[]

  The value of the rtc_transports field for RTC memberships (m.rtc.member). Or the value of the foci_preferred field for legacy session memberships (m.call.member).

  Returns Transport[]

userId

• get userId(): string

  Returns string

createdTs

• createdTs(): number

  Returns number

getAbsoluteExpiry

• getAbsoluteExpiry(): number | undefined

  Gets the absolute expiry timestamp of the membership.

  Returns number | undefined

  The absolute expiry time of the membership as a unix timestamp in milliseconds or undefined if not applicable

getFocusActive

• getFocusActive(): LivekitFocusSelection | undefined

  The focus_active filed of the session membership (m.call.member).

  Returns LivekitFocusSelection | undefined

  Deprecated

  focus_active is not used and will be removed in future versions.

getMsUntilExpiry

• getMsUntilExpiry(): number | undefined

  Returns number | undefined

  The number of milliseconds until the membership expires or undefined if applicable

getTransport

• getTransport(oldestMembership: CallMembership): Transport | undefined

  RTC Membership

  Gets the primary transport to use for this RTC membership (m.rtc.member). This will return the primary transport that is used by this call membership to publish their media. Directly relates to the rtc_transports field.

  Legacy session membership

  In case of a legacy session membership (m.call.member) this will return the selected transport where media is published. How this selection happens depends on the focus_active field of the session membership. If the focus_selection is oldest_membership this will return the transport of the oldest membership in the room (based on the created_ts field of the session membership). If the focus_selection is multi_sfu it will return the first transport of the foci_preferred list. (multi_sfu is equivalent to how m.rtc.member rtc_transports work).

  Parameters

  • oldestMembership: CallMembership

    For backwards compatibility with session membership (legacy). Unused in case of RTC membership. Always required to make the consumer not care if it deals with RTC or session memberships.

  Returns Transport | undefined

  The transport this membership uses to publish media or undefined if no transport is available.

isExpired

• isExpired(): boolean

  Returns boolean

  true if the membership has expired, otherwise false

StaticcomputeRtcBackendIdentity

• computeRtcBackendIdentity(
      matrixEvent: Pick<MatrixEvent, "getSender">,
      membershipData: MembershipData,
  ): Promise<string>

  sha256(${this.userId}|${this.deviceId}|${this.memberId}) for sticky events (kind = rtc) ${this.userId}:${this.deviceId} for state events (kind = session)

  Parameters

  • matrixEvent: Pick<MatrixEvent, "getSender">
  • membershipData: MembershipData

  Returns Promise<string>

StaticcomputeRtcIdentityRaw

• computeRtcIdentityRaw(
      userId: string,
      deviceId: string,
      memberId: string,
  ): Promise<string>

  Parameters

  • userId: string
  • deviceId: string
  • memberId: string

  Returns Promise<string>

Staticequal

• equal(a?: CallMembership, b?: CallMembership): boolean

  Parameters

  • Optionala: CallMembership
  • Optionalb: CallMembership

  Returns boolean

StaticmembershipDataFromMatrixEvent

• membershipDataFromMatrixEvent(matrixEvent: MatrixEvent): MembershipData

  Parameters

  • matrixEvent: MatrixEvent

  Returns MembershipData