Extension: omni.kit.collaboration.stage_columns-1.1.1

Documentation Generated: Sep 22, 2025

Overview#

The Live Session Stage Columns extension provides additional stage window columns to display and manage live session data. It enhances the stage window by adding customized UI columns that offer real-time live status, participant information, and auto-reload indications during live sessions. The extension is designed to integrate seamlessly with the stage window, delivering a smooth and interactive experience for users working in live collaborative environments.

_images/preview.png

Concepts#

  • Live Session Integration: These delegates leverage live session data to present real-time information. For example, one column displays live status changes, another shows the state of stage participants, and another indicates when a reload is required.

Functionality#

  • Live Column: This column delegate displays live status information and allows users to track the current live state directly from the stage window. It features a header and interactive widget that reflects live toggle states.

  • Participants Column: This delegate shows participant-related information, offering a view into the active users or collaborators in the live session. It builds its own header and interactive element to display the needed data.

  • Reload Column: This delegate manages the display of auto-reload status. It provides a visual indicator when stage data is out-of-date and requires refreshing. The delegate also supports custom sort policies to prioritize outdated versus updated elements.

Relationships#

  • Dependencies: The extension builds on top of the stage window functionality provided by the Omni Kit stage widget and relies on the live session management extension. It leverages Omni UI components to build lightweight, interactive widgets.

  • Integrated Workflow: The additional columns integrate with the live session system, which in turn supports collaborative workflows within the stage window. This integration is designed to enhance user awareness and control during live sessions.

Considerations#

  • The extension is intended for users who need quick insights into live session states directly within the stage window. It streamlines the workflow by incorporating live status, participant details, and reload indicators in-place.

  • As this extension relies on live session data, its functionality is best experienced in environments where live collaboration features are active and fully supported.

  • Customizations such as column order, width, or sort policies are provided through the delegate properties, ensuring that the implementation remains flexible without introducing unnecessary complexity.