IApp

class omni.kit.app.IApp

Bases: pybind11_object

Methods

__init__(*args, **kwargs)
delay_app_ready(self, requester_name)	Delays reporting app readiness for the named requester.
ensure_runloop(self[, runloop_name])	Ensures the named run loop exists, creating it if necessary.
get_app_environment(self)	Name of the environment we are running in.
get_app_filename(self)	App filename.
get_app_instance_id(self)	Retrieves the cached service instance ID for this process.
get_app_name(self)	App name.
get_app_session_id(self)	Retrieves the cached telemetry session ID for this process.
get_app_version(self)	App version.
get_app_version_short(self)	Short app version, currently major.minor, e.g. `2021.3`.
get_build_version(self)	Returns the full build version string.
get_extension_manager(self)	Gets the extension manager interface.
get_kernel_version(self)	Full kit kernel version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`.
get_kit_version(self)	Full kit version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`.
get_kit_version_hash(self)	Git hash of kit build, 8 letters, e.g. `aac30830`.
get_kit_version_short(self)	Short kit version, currently major.minor.
get_log_event_stream(self)	Log event stream.
get_message_bus_event_stream(self[, ...])	Message bus event stream for a run loop.
get_platform_info(self)	Returns platform information as a dict.
get_post_update_event_stream(self[, ...])	Event stream for post-update in a run loop.
get_pre_update_event_stream(self[, runloop_name])	Event stream for pre-update in a run loop.
get_python_scripting(self)	Gets the Python scripting interface.
get_shutdown_event_stream(self)	Event stream for app shutdown events.
get_startup_event_stream(self)	Event stream for app startup events.
get_time_since_start_ms(self)	Returns milliseconds since app start.
get_time_since_start_s(self)	Returns seconds since app start.
get_update_event_stream(self[, runloop_name])	Event stream for update in a run loop.
get_update_number(self)	Returns the current update tick number.
is_app_external(self)	Is external (public) configuration
is_app_ready(self)	Returns True when the app signals readiness.
is_debug_build(self)	Returns True if this is a debug build.
is_running(self)	Returns True if the run loop is active.
next_update_async([name, order])	Wait for next frame's update of Omniverse Kit.
post_quit(self[, return_code])	Posts a quit request with an optional return code.
post_uncancellable_quit(self[, return_code])	Posts a quit request that cannot be cancelled.
post_update_async([name, order])	Wait for next frame's post-update of Omniverse Kit.
pre_update_async([name, order])	Wait for next frame's pre-update of Omniverse Kit.
print_and_log(self, message)	Prints a message and logs it via the app logger.
replay_log_messages(self, arg0)	Replays recorded log messages for the specified target.
report_alive(self)	Reports a liveness signal to the system.
restart(self[, args, overwrite_args, ...])	Requests an application restart.
run(self, app_name, app_path[, argv])	Runs the app until quit is requested.
shutdown(self)	Shuts down the app and returns its exit code.
shutdown_and_release_framework(self)	Shuts down the app and releases the Carbonite framework.
startup(self, app_name, app_path[, argv])	Starts the app instance without entering the run loop.
toggle_log_message_recording(self, arg0)	Toggles log message recording.
try_cancel_shutdown(self[, reason])	Attempts to cancel a pending shutdown.
update(self)	Runs a single update tick.

__init__(*args, **kwargs)

delay_app_ready(

self: omni.kit.app._app.IApp,

requester_name: str,

) → None

Delays reporting app readiness for the named requester.

ensure_runloop(

self: omni.kit.app._app.IApp,

runloop_name: str = 'main',

) → bool

Ensures the named run loop exists, creating it if necessary.

get_app_environment(self: omni.kit.app._app.IApp) → str

Name of the environment we are running in. (/app/environment/name setting, e.g.: teamcity, launcher, etm, default)

get_app_filename(self: omni.kit.app._app.IApp) → str

App filename. Name of a kit file

get_app_instance_id(self: omni.kit.app._app.IApp) → str

Retrieves the cached service instance ID for this process. This will be an empty string when not running as a service.

get_app_name(self: omni.kit.app._app.IApp) → str

App name. It is app/name setting if defined, otherwise same as `filename`

get_app_session_id(self: omni.kit.app._app.IApp) → str

Retrieves the cached telemetry session ID for this process. This will be statistically unique from all other session IDs.

get_app_version(self: omni.kit.app._app.IApp) → str

App version. Version in kit file or kit version

get_app_version_short(self: omni.kit.app._app.IApp) → str

Short app version, currently major.minor, e.g. `2021.3`

get_build_version(self: omni.kit.app._app.IApp) → str

Returns the full build version string.

get_extension_manager(

self: omni.kit.app._app.IApp,

) → omni.ext._extensions.ExtensionManager

Gets the extension manager interface.

get_kernel_version(self: omni.kit.app._app.IApp) → str

Full kit kernel version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`

get_kit_version(self: omni.kit.app._app.IApp) → str

Full kit version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`

get_kit_version_hash(self: omni.kit.app._app.IApp) → str

Git hash of kit build, 8 letters, e.g. `aac30830`

get_kit_version_short(self: omni.kit.app._app.IApp) → str

Short kit version, currently major.minor. e.g. `103.5`

get_log_event_stream(

self: omni.kit.app._app.IApp,

) → carb.events._events.IEventStream

Log event stream.

get_message_bus_event_stream(

self: omni.kit.app._app.IApp,

runloop_name: str = 'main',

) → carb.events._events.IEventStream

Message bus event stream for a run loop.

get_platform_info(self: omni.kit.app._app.IApp) → dict

Returns platform information as a dict.

get_post_update_event_stream(

self: omni.kit.app._app.IApp,

runloop_name: str = 'main',

) → carb.events._events.IEventStream

Event stream for post-update in a run loop.

get_pre_update_event_stream(

self: omni.kit.app._app.IApp,

runloop_name: str = 'main',

) → carb.events._events.IEventStream

Event stream for pre-update in a run loop.

get_python_scripting(

self: omni.kit.app._app.IApp,

) → omni::kit::IAppScripting

Gets the Python scripting interface.

get_shutdown_event_stream(

self: omni.kit.app._app.IApp,

) → carb.events._events.IEventStream

Event stream for app shutdown events.

get_startup_event_stream(

self: omni.kit.app._app.IApp,

) → carb.events._events.IEventStream

Event stream for app startup events.

get_time_since_start_ms(self: omni.kit.app._app.IApp) → float

Returns milliseconds since app start.

get_time_since_start_s(self: omni.kit.app._app.IApp) → float

Returns seconds since app start.

get_update_event_stream(

self: omni.kit.app._app.IApp,

runloop_name: str = 'main',

) → carb.events._events.IEventStream

Event stream for update in a run loop.

get_update_number(self: omni.kit.app._app.IApp) → int

Returns the current update tick number.

is_app_external(self: omni.kit.app._app.IApp) → bool

Is external (public) configuration

is_app_ready(self: omni.kit.app._app.IApp) → bool

Returns True when the app signals readiness.

is_debug_build(self: omni.kit.app._app.IApp) → bool

Returns True if this is a debug build.

is_running(self: omni.kit.app._app.IApp) → bool

Returns True if the run loop is active.

async next_update_async(

name='omni.kit.app.next_update_async',

order=50,

) → float

Wait for next frame’s update of Omniverse Kit. Return delta time in seconds

post_quit(

self: omni.kit.app._app.IApp,

return_code: int = 0,

) → None

Posts a quit request with an optional return code.

post_uncancellable_quit(

self: omni.kit.app._app.IApp,

return_code: int = 0,

) → None

Posts a quit request that cannot be cancelled.

async post_update_async(

name='omni.kit.app.post_update_async',

order=-25,

) → float

Wait for next frame’s post-update of Omniverse Kit. Return delta time in seconds

async pre_update_async(

name='omni.kit.app.pre_update_async',

order=-50,

) → float

Wait for next frame’s pre-update of Omniverse Kit. Return delta time in seconds

print_and_log(self: omni.kit.app._app.IApp, message: str) → None

Prints a message and logs it via the app logger.

replay_log_messages(

self: omni.kit.app._app.IApp,

arg0: carb._carb.logging.Logger,

) → None

Replays recorded log messages for the specified target.

report_alive(self: omni.kit.app._app.IApp) → None

Reports a liveness signal to the system.

restart(

self: omni.kit.app._app.IApp,

args: List[str] = [],

overwrite_args: bool = False,

uncancellable: bool = False,

) → None

Requests an application restart.

Parameters:

• args – New arguments to pass after restart.

• overwrite_args – If True, replace current args; otherwise append.

• uncancellable – If True, restart cannot be cancelled.

run(

self: omni.kit.app._app.IApp,

app_name: str,

app_path: str,

argv: List[str] = [],

) → int

Runs the app until quit is requested.

Parameters:

• app_name – Name to use for the app.

• app_path – Path of the app binary or kit file.

• argv – Optional argument list passed to the app.

Returns:

The app exit code.

Return type:

int

shutdown(self: omni.kit.app._app.IApp) → int

Shuts down the app and returns its exit code.

shutdown_and_release_framework(

self: omni.kit.app._app.IApp,

) → int

Shuts down the app and releases the Carbonite framework.

Returns:

The app shutdown return code.

Return type:

int

startup(

self: omni.kit.app._app.IApp,

app_name: str,

app_path: str,

argv: List[str] = [],

) → None

Starts the app instance without entering the run loop.

Parameters:

• app_name – Name to use for the app.

• app_path – Path of the app binary or kit file.

• argv – Optional argument list passed to the app.

toggle_log_message_recording(

self: omni.kit.app._app.IApp,

arg0: bool,

) → None

Toggles log message recording.

try_cancel_shutdown(

self: omni.kit.app._app.IApp,

reason: str = '',

) → bool

Attempts to cancel a pending shutdown.

update(self: omni.kit.app._app.IApp) → None

Runs a single update tick.