LiveSessionUserList

class omni.kit.widget.live_session_management.LiveSessionUserList(

usd_context: UsdContext,

base_layer_identifier: str,

**kwargs,

)

Bases: object

Widget to build a user list to show all live session users of the interested layer.

Parameters:

• usd_context (omni.usd.UsdContext) – USD Context instance.

• base_layer_identifier (str) – Interested layer to listen to.

Keyword Arguments:

• icon_size (int) – The width and height of the user icon. 16 pixel by default.

• spacing (int) – The horizontal spacing between two icons. 2 pixel by default.

• show_myself (bool) – Whether to show local user or not. True by default.

• show_myself_to_leftmost (bool) – Whether to show local user to the leftmost, or rightmost otherwise. True by default.

• maximum_users (int) – The maximum users to show, and show others with overflow. Unlimited by default.

• prim_path (Sdf.Path) – Track Live Session for this prim only.

• allow_timeline_settings (bool) – Whether to allow timeline settings. False by default.

Methods

__init__(usd_context, base_layer_identifier, ...)	Initializes the LiveSessionUserList widget.
destroy()	Destroys the LiveSessionUserList widget and clears all references, subscriptions, and layouts.
empty()	Checks if any user icons have been added.
track_layer(layer_identifier)	Switches the base layer to listen to.

Attributes

layout

Gets the root widget of the list.

__init__(

usd_context: UsdContext,

base_layer_identifier: str,

**kwargs,

)

Initializes the LiveSessionUserList widget.

destroy()

Destroys the LiveSessionUserList widget and clears all references, subscriptions, and layouts.

empty()

Checks if any user icons have been added.

Returns:

True if the user list is empty, False otherwise.

Return type:

bool

track_layer(layer_identifier)

Switches the base layer to listen to.

Parameters:

layer_identifier (str) – Identifier of layer to update.

property layout: HStack

Gets the root widget of the list.

Returns:

The root layout widget.

Return type:

ui.HStack