LiveSessionStartWindow#

class omni.kit.widget.live_session_management_ui.LiveSessionStartWindow(
session_model: LiveSessionComboBoxModel,
prim_path: str,
join_session_cb: Callable[[LiveSessionInterface, str, str], bool],
create_live_session_cb: Callable[[str, str], LiveSessionInterface],
)#

Bases: object

A dialog window for joining existing live sessions or creating new ones.

This window provides a user interface that allows users to either join an existing live collaboration session or create a new session. It displays available sessions in a dropdown, shows current participants for selected sessions, and provides input fields for creating new sessions with proper validation.

Parameters:

  • session_model (LiveSessionComboBoxModel) – Model containing available live sessions and their data.

  • prim_path (str) – USD prim path for the live session.

  • join_session_cb (Callable[[LiveSessionInterface, str, str], bool]) – Callback function to join a session. Takes session interface, layer identifier, and prim path as arguments. Returns True if successful.

  • create_live_session_cb (Callable[[str, str], LiveSessionInterface]) – Callback function to create a new session. Takes layer identifier and session name as arguments. Returns the created session interface.

Methods

__init__(session_model, prim_path, ...)

Initializes a new live session start window for joining or creating live sessions.

destroy()

Destroys the window and cleans up all UI elements and event handlers.

select_default_session()

Selects the default session in the sessions model.

set_focus(join_session)

Sets the focus to either join session or create session mode.

Attributes

visible

Gets the visibility state of the live session start window.
__init__(
session_model: LiveSessionComboBoxModel,
prim_path: str,
join_session_cb: Callable[[LiveSessionInterface, str, str], bool],
create_live_session_cb: Callable[[str, str], LiveSessionInterface],
)#

Initializes a new live session start window for joining or creating live sessions.

destroy()#

Destroys the window and cleans up all UI elements and event handlers.

select_default_session()#

Selects the default session in the sessions model.

set_focus(join_session)#

Sets the focus to either join session or create session mode.

Parameters:

join_session (bool) – True to focus on join mode, False for create mode.

property visible#

Gets the visibility state of the live session start window.

Returns:

True if the window is visible, False otherwise.

Return type:

bool