Overview#

omni.kit.widget.live_session_management_ui provides a comprehensive set of UI widgets for managing live collaboration sessions. This extension creates modal dialog windows and interface components that enable users to start, join, end, and share live sessions through standardized user interfaces. It serves as a reusable widget library for other extensions that need to integrate live session functionality.

Key Components#

Session Management Windows#

The extension provides specialized modal windows for different stages of the live session lifecycle:

LiveSessionStartWindow enables users to either join existing sessions or create new ones. It displays available sessions in a dropdown with participant information and provides validation for new session creation.

JoinWithSessionLinkWindow offers a streamlined interface for joining sessions using shared session links. It validates link formats and handles error messaging for invalid entries.

LiveSessionEndWindow manages the session termination process, providing merge options for incorporating changes from the ending session. Users can choose between merging to corresponding layers or creating new layers, with checkpoint description capabilities.

ShareSessionLinkWindow facilitates session link sharing by providing selection and copy functionality for distributing session access to other users.

Session Interface and Modeling#

LiveSessionInterface defines the abstract interface that session implementations must follow. It specifies essential properties like session name, URLs, owner information, and modification timestamps, ensuring consistent behavior across different session providers.

LiveSessionComboBoxModel manages session data for dropdown components, automatically sorting sessions by last modification time and tracking user presence. It maintains real-time communication with collaboration channels to track user presence and provides callbacks for UI updates when sessions or participants change.