Overview#

Extension omni.kit.widget.live_session_management provides API and utilities to implement workflow for Live Session. It includes the following extensions:

Simple and easy to use API to enter into Live Session join/leave/create/merge/share process. See omni.kit.widget.live_session_management.stop_or_show_live_session_widget() for more details.
Single line widget to track camera followers. See omni.kit.widget.live_session_management.LiveSessionCameraFollowerList for more details.
Single line widget to track user list inside a Live Session. See omni.kit.widget.live_session_management.LiveSessionUserList for more details.
Encapsulated value model for omni.ui.ComboBox to easily implement dropdown list for Live Session listening or selection. See omni.kit.widget.live_session_management.LiveSessionModel for more details.
Utils to build user icons. See omni.kit.widget.live_session_management.build_live_session_user_layout().

All of those are built on top of the API support from omni.kit.usd.layers.

Viewer Only Mode#

This extension also supports a viewer only mode, which means:

When joining a live session, if the user has unsaved changes, skip the dialog and automatically reload the stage, then join the session.
When creating a live session, if the user has unsaved changes, skip the dialog and automatically reload the stage, then create the session.
When leaving a live session, do not offer to merge changes, instead reload the stage to its original state.

This mode can be controlled by setting omni.kit.widget.live_session_management.VIEWER_ONLY_MODE_SETTING. And you can use omni.kit.widget.live_session_management.is_viewer_only_mode() to query if it’s enabled.