Extension: omni.kit.widget.nucleus_connector-1.1.9 |
Documentation Generated: Nov 07, 2024 |
Overview
The extension omni.kit.widget.nucleus_connector provides a user interface for connecting to Nucleus servers, handling authentication, and managing Nucleus connections within the Omniverse environment. It includes dialogs for user input, displaying QR codes for device authentication, and showing progress or alerts during connection attempts. The extension supports both standard and device authentication flows and allows for retrying connections and cancelling ongoing connection attempts.
Important API List
NucleusConnectorExtension: Manages connections to Nucleus servers, including authentication flows and connection tasks.
ConnectorDialog: Returns an instance of
NucleusConnectorExtension.
General Use Case
This extension is used for managing connections to Nucleus servers from within the Omniverse environment. Users can prompt for server names and URLs to connect to them, handle authentication via web browser or device (QR code), and receive feedback on the connection process through progress indicators and alerts. It is particularly useful for applications that require interaction with Nucleus servers for data retrieval, storage, and collaboration in the Omniverse ecosystem. For examples of how to use the APIs, please consult the Python usage pages.