Skip to main content
Ctrl+K
Omniverse Kit - Home Omniverse Kit - Home

Omniverse Kit

  • twitter
  • youtube
  • instagram
  • www
  • linkedin
  • twitch
Omniverse Kit - Home Omniverse Kit - Home

Omniverse Kit

  • twitter
  • youtube
  • instagram
  • www
  • linkedin
  • twitch

Table of Contents

kit-manual

  • Getting Started
    • Architecture
    • AI-Assisted Development with Kit MCP
    • Building an App
    • Omniverse Kit Core IApp interface
    • Configuration
    • Frequently Asked Questions
  • Extensions & Development
    • Extensions (Advanced)
    • Extensions (USD Schema)
    • Extensions (API)
    • Kit SDK Extensions
    • Publishing Extensions
    • Testing Extensions with Python
    • Testing Extensions with C++
    • Documenting Extensions
    • Scripting
    • Embedded Python
    • Using Python pip packages
    • Kit Python Package
    • Building and Containerizing
    • UI Styling Best Practices
  • App Streaming
    • Building and Containerizing
    • Local Streaming
  • Observability
    • Kit App Logging (OTel)
      • Architecture
      • Logging Procedure
      • Known Limitations
    • Kit Artifacts Collection
    • Metrics
    • Profiling
    • Sample Dashboards
  • Configuration
    • Events
    • Legacy Events
    • Tokens Reference
  • Migration
    • Kit Upgrade Skill
    • Kit Migration Guide: 107.x to 110
    • Kit Migration Guide: 106.x to 109
    • Omniverse Kit 108 Migration Guide
  • Troubleshooting
  • API (python)
    • Modules
      • omni.kit.app
        • Classes
          • IApp
          • IAppScripting
          • SettingChangeSubscription
        • Functions
          • deprecated
          • get_app
          • log_deprecation
          • send_telemetry_event
          • acquire_app_interface
          • crash
          • queue_event
          • register_event_alias
      • omni.ext
        • Classes
          • DownloadState
          • ExtensionManager
          • ExtensionPathType
          • ExtensionStateChangeType
          • ICppExt
          • IExt
          • IExtensionManagerHooks
          • IExtensions
          • IHookHolder
          • IRegistryProvider
        • Functions
          • create_link
          • destroy_link
          • get_all_sys_paths
          • get_dangling_references
          • get_extension_name
          • get_extension_name_and_version
          • get_extension_name_tag_version
          • get_extensions_interface
          • get_fast_importer_sys_paths
          • is_link
          • pack_extension
          • unpack_extension
          • acquire_ext_interface
          • acquire_extensions_interface
          • release_ext_interface
      • carb
        • Submodules
          • dictionary
            • Classes
              • IDictionary
              • ISerializer
              • Item
              • ItemType
              • UpdateAction
            • Functions
              • get_dictionary
              • acquire_dictionary_interface
              • acquire_serializer_interface
              • get_json_serializer
              • get_toml_serializer
              • get_yaml_serializer
          • eventdispatcher
            • Classes
              • Event
              • IEventDispatcher
              • IMessageQueue
              • IMessageQueueFactory
              • Observer
              • ObserverGuard
            • Functions
              • get_eventdispatcher
              • get_messagequeue_factory
              • acquire_eventdispatcher_interface
              • acquire_messagequeue_factory_interface
          • events
            • Classes
              • AdapterType
              • IEvent
              • IEventStream
              • IEvents
              • IEventsAdapter
              • ISubscription
              • MappingEntry
              • MappingEntry2
            • Functions
              • get_events_adapter_interface
              • get_events_interface
              • acquire_events_adapter_interface
              • acquire_events_interface
              • type_from_string
              • unregister_event_alias
          • filesystem
            • Classes
              • DirectoryItemType
              • File
              • FileWhence
              • IFileSystem
            • Functions
              • acquire_filesystem
          • logging
            • Classes
              • ILogging
              • LogSettingBehavior
              • Logger
              • LoggerHandle
            • Functions
              • acquire_logging
              • configure_default_logger
              • configure_logging
              • refresh_logging_settings
          • profiler
            • Classes
              • FlowType
              • IProfileMonitor
              • IProfiler
              • InstantType
              • ProfileEvents
            • Functions
              • begin
              • profile
              • acquire_profile_monitor_interface
              • acquire_profiler_interface
              • begin_with_location
              • end
              • is_profiler_active
              • supports_dynamic_source_locations
          • settings
            • Classes
              • ChangeEventType
              • ISettings
              • SubscriptionId
            • Functions
              • get_settings
              • lru_cache
              • acquire_settings_interface
          • tokens
            • Classes
              • ITokens
            • Functions
              • get_tokens_interface
              • acquire_tokens_interface
          • variant
            • Classes
              • IVariant
            • Functions
              • get_variant
              • acquire_variant_interface
        • Classes
          • ColorRgb
          • ColorRgbDouble
          • ColorRgba
          • ColorRgbaDouble
          • Double2
          • Double3
          • Double4
          • Float2
          • Float3
          • Float4
          • Framework
          • Int2
          • Int3
          • Int4
          • InterfaceDesc
          • PluginDesc
          • PluginHotReload
          • PluginImplDesc
          • Subscription
          • Uint2
          • Uint3
          • Uint4
          • Version
        • Functions
          • cache
          • log_error
          • log_info
          • log_verbose
          • log_warn
          • wraps
          • answer_question
          • breakpoint
          • get_framework
          • log
          • wait_for_native_debugger
      • carb.settings
        • Classes
          • ChangeEventType
          • ISettings
          • SubscriptionId
        • Functions
          • get_settings
          • lru_cache
          • acquire_settings_interface
      • carb.tokens
        • Classes
          • ITokens
        • Functions
          • get_tokens_interface
          • acquire_tokens_interface
      • carb.events
        • Classes
          • AdapterType
          • IEvent
          • IEventStream
          • IEvents
          • IEventsAdapter
          • ISubscription
          • MappingEntry
          • MappingEntry2
        • Functions
          • get_events_adapter_interface
          • get_events_interface
          • acquire_events_adapter_interface
          • acquire_events_interface
          • type_from_string
          • unregister_event_alias
      • omni.str
        • Classes
          • IReadOnlyCString
      • carb.audio
        • Submodules
          • audio
        • Classes
          • AudioResult
          • Context
          • ContextCaps
          • ContextError
          • ContextParams
          • ContextParams2
          • DecoderError
          • DeviceCaps
          • DspValuePair
          • EmitterAttributes
          • EncoderError
          • EntityAttributes
          • EntityCone
          • EventPoint
          • Guid
          • IAudioData
          • IAudioPlayback
          • LoopPointDesc
          • NotAvailable
          • OutputDesc
          • PeakVolumes
          • PlaybackContextDesc
          • ReadOnly
          • RolloffDesc
          • RolloffType
          • SampleFormat
          • SoundData
          • SoundDataError
          • SoundFormat
          • Speaker
          • UnitType
          • Voice
          • VoiceParamBalance
          • VoiceParamOcclusion
          • VoiceParams
        • Functions
          • acquire_data_interface
          • acquire_playback_interface
          • get_force_off_playback_mode_flags
          • get_force_on_playback_mode_flags
      • carb.dictionary
        • Classes
          • IDictionary
          • ISerializer
          • Item
          • ItemType
          • UpdateAction
        • Functions
          • get_dictionary
          • acquire_dictionary_interface
          • acquire_serializer_interface
          • get_json_serializer
          • get_toml_serializer
          • get_yaml_serializer
      • carb.input
        • Classes
          • ActionEvent
          • ActionMappingDesc
          • ActionMappingSet
          • DeviceType
          • EventType
          • FilterResult
          • Gamepad
          • GamepadConnectionEvent
          • GamepadConnectionEventType
          • GamepadEvent
          • GamepadInput
          • IInput
          • InputDevice
          • InputEvent
          • InputProvider
          • Keyboard
          • KeyboardEvent
          • KeyboardEventType
          • KeyboardInput
          • Mouse
          • MouseEvent
          • MouseEventType
          • MouseInput
        • Functions
          • acquire_input_interface
          • acquire_input_provider
          • get_action_mapping_desc_from_string
          • get_string_from_action_mapping_desc
      • carb.profiler
        • Classes
          • FlowType
          • IProfileMonitor
          • IProfiler
          • InstantType
          • ProfileEvents
        • Functions
          • begin
          • profile
          • acquire_profile_monitor_interface
          • acquire_profiler_interface
          • begin_with_location
          • end
          • is_profiler_active
          • supports_dynamic_source_locations
      • carb.windowing
        • Classes
          • Cursor
          • CursorMode
          • CursorStandardShape
          • GLContext
          • IGLContext
          • IWindowing
          • Image
          • InputMode
          • Monitor
          • Window
        • Functions
          • acquire_gl_context_interface
          • acquire_windowing_interface
      • carb.eventdispatcher
        • Classes
          • Event
          • IEventDispatcher
          • IMessageQueue
          • IMessageQueueFactory
          • Observer
          • ObserverGuard
        • Functions
          • get_eventdispatcher
          • get_messagequeue_factory
          • acquire_eventdispatcher_interface
          • acquire_messagequeue_factory_interface
      • carb.variant
        • Classes
          • IVariant
        • Functions
          • get_variant
          • acquire_variant_interface
      • omni.core
        • Classes
          • IObject
          • ITypeFactory
          • Result
          • TypeFactoryLoadFlags
          • UInt2
        • Functions
          • create_type
          • register_module
      • omni.structuredlog
        • Classes
          • IStructuredLogControl
          • IStructuredLogControl2
          • IStructuredLogExtraFields
          • IStructuredLogFromILog
          • IStructuredLogFromILog2
          • IStructuredLogSettings
          • IStructuredLogSettings2
          • IStructuredLogSettings3
          • IdMode
          • IdType
          • InvalidEventException
          • InvalidSchemaException
          • StructuredLogEvent
          • UniqueApp
        • Functions
          • configure_structured_logging
          • create_launch_guard
          • register_schema
          • send_event
  • API (python)
  • Modules
  • carb
  • carb Submodules
  • carb.events
  • carb.events Classes

carb.events Classes#

Classes Summary:

AdapterType

Members:

IEvent

Event.

IEventStream

A stream that queues and dispatches events.

IEvents

Top-level events service for creating streams and sender ids.

IEventsAdapter

Creates adapters that translate between event systems.

ISubscription

Subscription holder.

MappingEntry

Adapter mapping entry between event type and names.

MappingEntry2

Mapping entry with optional filters for adapter creation.

previous

carb.events

next

AdapterType

NVIDIA NVIDIA

Copyright © 2019-2026, NVIDIA Corporation.

Last updated on Sep 03, 2026.