Extension: omni.kit.collaboration.settings-1.1.2

Documentation Generated: Sep 13, 2025

Overview#

The Collaboration Settings extension manages settings for the live collaboration workflow in Omniverse Kit. It provides a dedicated user interface to adjust and monitor preferences related to collaboration during live sessions. By streamlining the configuration of user and session settings, it supports a smoother collaborative experience without requiring direct code integration.

_images/preview.png

Concepts#

  • Collaboration Preferences: The extension centralizes settings that affect live collaboration, including session parameters and user-specific options.

Functionality#

  • UI-Based Settings Management: The extension uses Omni UI to present a clear, collapsible window containing various panels for managing live session settings and user configurations.

  • User and Session Management: Built-in widgets enable users to view and modify settings specific to their collaboration session, such as simulated user activity and session state information.

Key Components#

  • Collaboration Settings Window: This is the main interface for accessing and adjusting live collaboration settings. It houses both session and user configuration panels.

Relationships#

The extension integrates with several key components of the Omniverse Kit ecosystem:

  • It depends on Omni UI for its user interface components.

  • It works alongside Omni USD and live session management extensions, such as the live session management widget and preference window extension.

  • Its design supports consistent settings management within the broader context of collaborative live sessions.

Considerations#

  • Live Session Focus: The settings provided by this extension are optimized for use during live collaboration workflows. They are not intended for offline or static USD stage configurations.

  • UI Consistency: The built-in UI components follow a consistent design established by the WidgetBuilder, ensuring that changes in one panel are reflected uniformly across the overall interface.

This extension is ready to use out-of-the-box, providing a practical and cohesive interface for managing live collaboration settings within the Omniverse Kit environment.