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.
channel_url	Gets the physical channel_url of the Live Session in the server.
name	Gets the name of the Live Session.
owner	Gets the owner name of the Live Session.
shared_link	//localhost/test/stage.usd?live_session_name=my_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 channel_url: str

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

Returns:

The physical channel_url of the Live Session in the server.

Return type:

str

Raises:

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

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

//localhost/test/stage.usd?live_session_name=my_session.

Returns:

The session link to be shared.

Return type:

str

Raises:

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

Type:

Gets the session link to be shared. Shared link is different as url, so url points to the physical location of the Live Session that local user can get access to, while session link is the URL that you can share to others, and can be launched from Omniverse launcher and other apps could parse it and decide the action from it. The session name is passed as the query parameter to the base layer url, for example, omniverse

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.