matrix-js-sdk

    Class CallMembership

    Index

    Constructors

    Accessors

    • 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

    Methods

    • Gets the absolute expiry timestamp of the membership.

      Returns undefined | number

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

    • Returns undefined | number

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

    • 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.

      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 undefined | Transport

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

    MMNEPVFCICPMFPCPTTAAATR