LiveSessionInterface

class omni.kit.widget.live_session_management_ui.LiveSessionInterface

Bases: object

LiveSession Interface

Methods

get_last_modified_time()

Gets the last modified time of the Live Session.

Attributes

base_layer_identifier	Gets the base layer identifier of the Live Session.
name	Gets the name of the Live Session.
owner	Gets the owner name of the Live Session.
shared_link	Gets the shareable link for this Live Session.
url	Gets the physical url of the Live Session in the server.

__init__()

abstract get_last_modified_time() → int

Gets the last modified time of the Live Session. The modified time is fetched from the session config file. It can be used to sort the Live Session list in access order.

Returns:

The last modified time of the Live Session.

Return type:

int

Raises:

NotImplementedError – This is an abstract method that must be implemented by subclasses.

abstract property base_layer_identifier: str

Gets the base layer identifier of the Live Session.

Returns:

The base layer identifier of the Live Session.

Return type:

str

abstract property name: str

Gets the name of the Live Session.

Returns:

The name of the Live Session.

Return type:

str

Raises:

NotImplementedError – This is an abstract method that must be implemented by subclasses.

abstract property owner: str

Gets the owner name of the Live Session. It returns the static owner name of the session only. If it has multiple instances of the same user join the same session, only one of the owner has the real merge_permission.

Returns:

The owner name of the Live Session.

Return type:

str

Raises:

NotImplementedError – This is an abstract method that must be implemented by subclasses.

property shared_link: str

Gets the shareable link for this Live Session.

The link points at the base layer and carries both the display name and resolved session URL as query parameters. Other Kit applications can use the resolved URL to join the exact session without relying on a potentially stale session-list lookup by name.

Returns:

The session link to be shared.

Return type:

str

Raises:

NotImplementedError – This is an abstract method that must be implemented by subclasses.

abstract property url: str

Gets the physical url of the Live Session in the server.

Returns:

The physical url of the Live Session in the server.

Return type:

str

Raises:

NotImplementedError – This is an abstract method that must be implemented by subclasses.