LiveSessionModel

class omni.kit.widget.live_session_management.LiveSessionModel(

layers_interface,

layer_identifier,

update_users=True,

)

Bases: LiveSessionComboBoxModel

Omni UI model for omni.ui.Combobox, which can be used to build a customized combobox for listing, watching, and selecting Live Sessions for a specific layer.

Parameters:

• layers_interface (omni.kit.usd.layers.Layers) – Layers instance.

• layer_identifier (str) – Layer identifier to query.

• update_users (bool) – When True, it will listen for user list updates for the Live Session that is currently selected by this model.

Methods

__init__(layers_interface, layer_identifier)	Initializes a new instance of LiveSessionModel for managing live sessions in Omni UI.
create_new_session_name()	Generates a new live session name following a default or user-specific naming convention.
destroy()	Destroys the LiveSessionModel instance by unsubscribing from event streams and cleaning up resources.

Attributes

__init__(

layers_interface,

layer_identifier,

update_users=True,

) → None

Initializes a new instance of LiveSessionModel for managing live sessions in Omni UI.

create_new_session_name() → str

Generates a new live session name following a default or user-specific naming convention.

destroy()

Destroys the LiveSessionModel instance by unsubscribing from event streams and cleaning up resources.