API (python)#

Module Summary:

omni.kit.app	This module contains bindings to C++ omni::kit::IApp interface, core C++ part of Omniverse Kit.
omni.ext	This module contains bindings to C++ omni::ext::IExtensions interface. Extension system of Omniverse Kit.
carb	This package is the gateway to all things Carbonite. If you are starting from scratch:
carb.settings	Bindings for carb::settings::ISettings interface. Settings is a runtime representation of typical configuration formats (like json, toml, xml), it is a nested dictionary of values.
carb.tokens	Bindings for carb::tokens::ITokens interface. It is used for storing tokens and resolving strings containing them.
carb.events	This module contains bindings to C++ carb::IEvents interface.
omni.str
carb.audio
carb.dictionary	This module contains bindings to C++ carb::IDictionary interface.
carb.input	pybind11 carb.input bindings
carb.profiler	This module contains bindings to C++ carb::profiler::IProfiler interface.
carb.windowing	pybind11 carb.windowing bindings
carb.eventdispatcher	This module contains bindings to C++ carb::eventdispatcher::IEventDispatcher interface.
carb.variant	This module contains bindings to C++ carb::variant::IVariant interface.
omni.core
omni.structuredlog

Module Details::

omni.kit.app:

This module contains bindings to C++ omni::kit::IApp interface, core C++ part of Omniverse Kit.

All the function are in omni.kit.IApp class, to get it use get_app_interface method, which caches acquire interface call:

>>> import omni.kit.app
>>> a = omni.kit.app.get_app()

omni.ext:

This module contains bindings to C++ omni::ext::IExtensions interface. Extension system of Omniverse Kit.

carb:

This package is the gateway to all things Carbonite. If you are starting from scratch:

>>> import carb
>>> f = carb.get_framework()
>>> f.startup()

There is however no need to start up the framework if you are working within a Carbonite based application. This has already been handled.

Attributes:

logging (carb.pycarb.logging.ILogging): Gives access to the ILogging interface, which: can be used to set configuration for logging.
filesystem (carb.pycarb.filesystem.IFileSystem): Gives access to the IFileSystem interface, which is used to: read and write files in a platform independent manner, using a uniform path format that supports utf8 and long paths.

carb.settings:

Bindings for carb::settings::ISettings interface. Settings is a runtime representation of typical configuration formats (like json, toml, xml), it is a nested dictionary of values.

This module contains bindings to C++ carb::ISettings interface.

carb.tokens:

Bindings for carb::tokens::ITokens interface. It is used for storing tokens and resolving strings containing them.

This module contains bindings to C++ carb::ITokens interface.

carb.events:

This module contains bindings to C++ carb::IEvents interface.

Use get_events_interface method, which caches acquire interface call:

import carb.events
events = carb.events.get_events_interface()
s = events.create_event_stream()
s.push(0, { "x" : 2 })
e = s.pop()
print(e.type)
print(e.payload)

You also can subscribe to IEventStream

import carb.events
events = carb.events.get_events_interface()
s = events.create_event_stream()

def on_event(e):
    print(e.type)
    print(e.payload)

subscription = s.create_subscription_to_pop(on_event)

# Some code which pushes events
# ...

# unsubscribe
subscription = None