Skip to content

Commit

Permalink
more details and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
toger5 committed Jan 13, 2025
1 parent 826ce78 commit 08b9849
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/matrixrtc/MembershipManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@ import { MembershipConfig } from "./MatrixRTCSession.ts";
*/
export interface IMembershipManager {
/**
* Returns true if we intend to be participating in the MatrixRTC session.
* If we are trying to join the session.
* It does not reflect if the room state is already configures to represent us being joined.
* It only means that the Manager is running.
* This is determined by checking if the relativeExpiry has been set.
* @returns true if we intend to be participating in the MatrixRTC session
*/
isJoined(): boolean;
/**
Expand All @@ -30,16 +33,16 @@ export interface IMembershipManager {
*/
join(fociPreferred: Focus[], fociActive?: Focus): void;
/**
* Send all necessary events to make this user leave the RTC session
* Send all necessary events to make this user leave the RTC session.
* @param timeout
*/
leave(timeout: number | undefined): Promise<boolean>;
/**
* call this if the MatrixRTC session members have changed
* Call this if the MatrixRTC session members have changed.
*/
onRTCSessionMemberUpdate(memberships: CallMembership[]): Promise<void>;
/**
* Returns the used active focus in the currently joined session.
* The used active focus in the currently joined session.
* @returns undefined if not joined.
*/
getActiveFocus(): Focus | undefined;
Expand Down

0 comments on commit 08b9849

Please sign in to comment.