Inventar der öffentlichen API

Dokumentation für Version v0.1.0-beta.3Quelle auf GitHub ansehen

Übersetzung der englischen Originalseite für OmsiLaunch 0.1.0-beta3. Maßgeblich ist die englische Seite: Bei Abweichungen gelten die englische Seite und der Code.

Diese Seite wird von tests/OmsiLaunch.DocumentationTests aus den kompilierten Assemblies erzeugt (dotnet run --project tests/OmsiLaunch.DocumentationTests -- --write-inventory); die Dokumentationsprüfung schlägt fehl, sobald sie nicht mehr zum Code passt. Sie führt jeden exportierten Typ von OmsiLaunch.Api, OmsiLaunch.Core und OmsiLaunch.Process mit seiner Stabilität und der Signatur jedes öffentlichen Members auf. Semantik, Vorbedingungen, Fehler und Beispiele sind auf der Seite dokumentiert, die in der jeweiligen Überschrift genannt ist (Standard: öffentliche API). Stabilitätsstufen: STABLE_BETA, EXPERIMENTAL, PARTIAL, INTERNAL (aus technischen Gründen öffentlich, keine Integrationsschnittstelle), UNAVAILABLE (siehe öffentliche API). Vom Compiler erzeugte Record-Member (Equals, GetHashCode, ToString, Deconstruct, <Clone>$, EqualityContract) werden nicht aufgeführt.

OmsiLaunch.Api#

Capability#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorCapability(string Name, bool Available, string EvidenceState, string Reason = null)
Eigenschaftstring Name { get; init; }
Eigenschaftbool Available { get; init; }
Eigenschaftstring EvidenceState { get; init; }
Eigenschaftstring Reason { get; init; }

ContentIdentity#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorContentIdentity(string Identity, string Kind, string DisplayName = null)
Eigenschaftstring Identity { get; init; }
Eigenschaftstring Kind { get; init; }
Eigenschaftstring DisplayName { get; init; }

ContentQueryKind#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
WertMaps = 0
WertSituations = 1
WertVehicles = 2
WertRepaints = 3
WertHofs = 4
WertFleetNumbers = 5
WertRegistrations = 6
WertAddons = 7
WertEntrypoints = 8

D3DDeviceState#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
WertNotReady = 0
WertReady = 1
WertLost = 2
WertResetting = 3
WertStopping = 4
WertStopped = 5

D3DDeviceStatus#

Versiegelter Record in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
KonstruktorD3DDeviceStatus(bool Available, D3DDeviceState State, uint Generation, uint LiveTextureCount, bool ResetHookInstalled, uint ExecutionThreadId, uint LastResetThreadId, int QueryInterfaceHResult, int CooperativeLevelHResult, uint OwnedDeviceReferences)
Eigenschaftbool Available { get; init; }
EigenschaftD3DDeviceState State { get; init; }
Eigenschaftuint Generation { get; init; }
Eigenschaftuint LiveTextureCount { get; init; }
Eigenschaftbool ResetHookInstalled { get; init; }
Eigenschaftuint ExecutionThreadId { get; init; }
Eigenschaftuint LastResetThreadId { get; init; }
Eigenschaftint QueryInterfaceHResult { get; init; }
Eigenschaftint CooperativeLevelHResult { get; init; }
Eigenschaftuint OwnedDeviceReferences { get; init; }

D3DRuntimeApi#

Statische Klasse in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
ErweiterungsmethodeTask<D3DTextureDescription> CreateD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, uint width, uint height, D3DTextureFormat format, uint levels = 1, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
ErweiterungsmethodeTask<D3DTextureDescription> DescribeD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, uint level = 0, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
ErweiterungsmethodeTask<D3DDeviceStatus> GetD3DStatusAsync(this IOmsiLaunch launch, SessionHandle session, TimeSpan timeout, CancellationToken cancellationToken = default)
ErweiterungsmethodeTask<D3DTextureDescription> ReleaseD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
ErweiterungsmethodeTask<D3DTextureDescription> UpdateD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, D3DTextureUpdate update, TimeSpan? timeout = default, CancellationToken cancellationToken = default)

D3DTextureDescription#

Versiegelter Record in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
KonstruktorD3DTextureDescription(D3DTextureHandle Handle, D3DTextureResourceState State, D3DDeviceState DeviceState, uint Generation, uint Width, uint Height, D3DTextureFormat Format, uint Levels, uint Level, uint LevelWidth, uint LevelHeight, int HResult, uint ExecutionThreadId)
EigenschaftD3DTextureHandle Handle { get; init; }
EigenschaftD3DTextureResourceState State { get; init; }
EigenschaftD3DDeviceState DeviceState { get; init; }
Eigenschaftuint Generation { get; init; }
Eigenschaftuint Width { get; init; }
Eigenschaftuint Height { get; init; }
EigenschaftD3DTextureFormat Format { get; init; }
Eigenschaftuint Levels { get; init; }
Eigenschaftuint Level { get; init; }
Eigenschaftuint LevelWidth { get; init; }
Eigenschaftuint LevelHeight { get; init; }
Eigenschaftint HResult { get; init; }
Eigenschaftuint ExecutionThreadId { get; init; }

D3DTextureFormat#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
WertA8R8G8B8 = 0
WertX8R8G8B8 = 1
WertR5G6B5 = 2
WertX1R5G5B5 = 3
WertA1R5G5B5 = 4
WertA4R4G4B4 = 5
WertA8 = 6
WertL8 = 7
WertA8L8 = 8

D3DTextureHandle#

Versiegelter Record in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
KonstruktorD3DTextureHandle(string Value)
Eigenschaftstring Value { get; init; }

D3DTextureResourceState#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
WertLive = 0
WertReleased = 1
WertStale = 2

D3DTextureUpdate#

Versiegelter Record in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
KonstruktorD3DTextureUpdate(uint Level, uint X, uint Y, uint Width, uint Height, ReadOnlyMemory<byte> Pixels)
Eigenschaftuint Level { get; init; }
Eigenschaftuint X { get; init; }
Eigenschaftuint Y { get; init; }
Eigenschaftuint Width { get; init; }
Eigenschaftuint Height { get; init; }
EigenschaftReadOnlyMemory<byte> Pixels { get; init; }

DateSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorDateSpec(DateTimeMode Mode, OptionalValue<SemanticDate> Value)
EigenschaftDateTimeMode Mode { get; init; }
EigenschaftOptionalValue<SemanticDate> Value { get; init; }

DateTimeMode#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertUnset = 0
WertExplicit = 1
WertSystem = 2

DiagnosticsSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorDiagnosticsSpec(bool Log = true, bool Verbose = false, bool OmsiLogAll = false, bool ProcessTrace = false, bool PluginTrace = false, bool NativeTrace = false)
Eigenschaftbool Log { get; init; }
Eigenschaftbool Verbose { get; init; }
Eigenschaftbool OmsiLogAll { get; init; }
Eigenschaftbool ProcessTrace { get; init; }
Eigenschaftbool PluginTrace { get; init; }
Eigenschaftbool NativeTrace { get; init; }

EntrypointMode#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertUnset = 0
WertPresentedIndex = 1
WertIdentity = 2

EntrypointSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorEntrypointSpec(EntrypointMode Mode, OptionalValue<int> PresentedIndex, OptionalValue<string> Identity)
EigenschaftEntrypointMode Mode { get; init; }
EigenschaftOptionalValue<int> PresentedIndex { get; init; }
EigenschaftOptionalValue<string> Identity { get; init; }
statische EigenschaftEntrypointSpec Unset { get; }

EnvironmentSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorEnvironmentSpec(IReadOnlyDictionary<string, OptionalValue<string>> General, IReadOnlyDictionary<string, OptionalValue<string>> Advanced, IReadOnlyDictionary<string, OptionalValue<string>> Graphics, IReadOnlyDictionary<string, OptionalValue<string>> AdvancedGraphics, IReadOnlyDictionary<string, OptionalValue<string>> Sound, IReadOnlyDictionary<string, OptionalValue<string>> AiPassengers, IReadOnlyDictionary<string, OptionalValue<string>> Keyboard, IReadOnlyDictionary<string, OptionalValue<string>> Controllers)
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> General { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> Advanced { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> Graphics { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> AdvancedGraphics { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> Sound { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> AiPassengers { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> Keyboard { get; init; }
EigenschaftIReadOnlyDictionary<string, OptionalValue<string>> Controllers { get; init; }

IOmsiLaunch#

Interface in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
MethodeTask CloseAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<IReadOnlyList<ContentIdentity>> DiscoverAsync(InstallationSpec installation, ContentQueryKind query, OptionalValue<string> scope = default, CancellationToken cancellationToken = default)
MethodeTask<RuntimeCommandResult> ExecuteRuntimeAsync(SessionHandle session, RuntimeCommand command, TimeSpan timeout, CancellationToken cancellationToken = default)
MethodeTask<IReadOnlyList<Capability>> GetCapabilitiesAsync(InstallationSpec installation, CancellationToken cancellationToken = default)
MethodeTask<SessionStatus> GetStatusAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<SessionPlan> PlanSessionAsync(LaunchSpec spec, CancellationToken cancellationToken = default)
MethodeTask<RecoveryStatus> RecoverPendingAsync(InstallationSpec installation, bool restore, CancellationToken cancellationToken = default)
MethodeTask<SessionHandle> StartSessionAsync(SessionPlan plan, CancellationToken cancellationToken = default)
MethodeTask StopAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<SessionStatus> WaitForAsync(SessionHandle session, SessionState state, TimeSpan timeout, CancellationToken cancellationToken = default)

InputSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorInputSpec(OptionalValue<string> KeyboardDocument, OptionalValue<string> ControllerDocument)
EigenschaftOptionalValue<string> KeyboardDocument { get; init; }
EigenschaftOptionalValue<string> ControllerDocument { get; init; }

InstallationPaths#

Statische Klasse in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
statische Methodestring IdentityKey(string root)
statische Methodestring NormalizeRoot(string root)
statische MethodeIReadOnlyList<string> Segments(string relativePath)
statische Methodebool TryGetContainedRelativePath(string root, string candidate, out string relativePath)

InstallationSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorInstallationSpec(string RootPath, string ExpectedExecutableSha256 = null)
Eigenschaftstring RootPath { get; init; }
Eigenschaftstring ExpectedExecutableSha256 { get; init; }

InternetTexturesMode#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertNative = 0
WertDisabled = 1
WertOverride = 2

InternetTexturesSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorInternetTexturesSpec(InternetTexturesMode Mode = Native, OptionalValue<string> OverrideProfilePath = default)
EigenschaftInternetTexturesMode Mode { get; init; }
EigenschaftOptionalValue<string> OverrideProfilePath { get; init; }

LaunchBehaviorSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorLaunchBehaviorSpec(bool RestoreConfiguration = true, bool SuppressStaleClosecheckWarning = true, int StartupTimeoutSeconds = 180, int ShutdownTimeoutSeconds = 30)
Eigenschaftbool RestoreConfiguration { get; init; }
Eigenschaftbool SuppressStaleClosecheckWarning { get; init; }
Eigenschaftint StartupTimeoutSeconds { get; init; }
Eigenschaftint ShutdownTimeoutSeconds { get; init; }

LaunchDiagnostic#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorLaunchDiagnostic(string Code, string Message, IReadOnlyDictionary<string, string> Data = null)
Eigenschaftstring Code { get; init; }
Eigenschaftstring Message { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Data { get; init; }

LaunchSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorLaunchSpec(InstallationSpec Installation, WorldSpec World, DateSpec Date, TimeSpec Time, OptionalValue<PlayerVehicleSpec> PlayerVehicle, EnvironmentSpec Environment, LaunchBehaviorSpec Behavior, YearSpec Year = null, WeatherSpec Weather = null, InputSpec Input = null, DiagnosticsSpec Diagnostics = null, SessionPresentationSpec Presentation = null, InternetTexturesSpec InternetTextures = null, SessionProfileMetadata SessionProfile = null)
EigenschaftInstallationSpec Installation { get; init; }
EigenschaftWorldSpec World { get; init; }
EigenschaftDateSpec Date { get; init; }
EigenschaftTimeSpec Time { get; init; }
EigenschaftOptionalValue<PlayerVehicleSpec> PlayerVehicle { get; init; }
EigenschaftEnvironmentSpec Environment { get; init; }
EigenschaftLaunchBehaviorSpec Behavior { get; init; }
EigenschaftYearSpec Year { get; init; }
EigenschaftWeatherSpec Weather { get; init; }
EigenschaftInputSpec Input { get; init; }
EigenschaftDiagnosticsSpec Diagnostics { get; init; }
EigenschaftSessionPresentationSpec Presentation { get; init; }
EigenschaftInternetTexturesSpec InternetTextures { get; init; }
EigenschaftSessionProfileMetadata SessionProfile { get; init; }
EigenschaftYearSpec EffectiveYear { get; }
EigenschaftWeatherSpec EffectiveWeather { get; }
EigenschaftInputSpec EffectiveInput { get; }
EigenschaftDiagnosticsSpec EffectiveDiagnostics { get; }
EigenschaftSessionPresentationSpec EffectivePresentation { get; }
EigenschaftInternetTexturesSpec EffectiveInternetTextures { get; }

OmsiRuntimeException#

Versiegelte Klasse in OmsiLaunch.Api. Stabilität: EXPERIMENTAL. Semantik: public-api.

MemberSignatur
KonstruktorOmsiRuntimeException(string code, string detail = null)
Eigenschaftstring Code { get; }

OptionalValue#

Record struct in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorOptionalValue(Presence Presence, T Value)
EigenschaftPresence Presence { get; init; }
EigenschaftT Value { get; init; }
Eigenschaftbool IsSet { get; }
statische EigenschaftOptionalValue<T> Unset { get; }
statische MethodeOptionalValue<T> Set(T value)

PlannedMutation#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorPlannedMutation(string RelativePath, string SemanticKey, string RequestedValue, string Operation)
Eigenschaftstring RelativePath { get; init; }
Eigenschaftstring SemanticKey { get; init; }
Eigenschaftstring RequestedValue { get; init; }
Eigenschaftstring Operation { get; init; }

PlayerVehicleSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorPlayerVehicleSpec(OptionalValue<string> Model, OptionalValue<string> Repaint, OptionalValue<string> Hof, OptionalValue<string> FleetNumber, OptionalValue<string> Registration)
EigenschaftOptionalValue<string> Model { get; init; }
EigenschaftOptionalValue<string> Repaint { get; init; }
EigenschaftOptionalValue<string> Hof { get; init; }
EigenschaftOptionalValue<string> FleetNumber { get; init; }
EigenschaftOptionalValue<string> Registration { get; init; }
Eigenschaftbool Enabled { get; }

Presence#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertUnset = 0
WertSet = 1

PublicCapabilityClassification#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: capabilities.

MemberSignatur
WertPublicStableBeta = 0
WertPublicExperimental = 1
WertInternalOnly = 2
WertUnsupported = 3

PublicCapabilityDescriptor#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: capabilities.

MemberSignatur
KonstruktorPublicCapabilityDescriptor(string Id, string Family, PublicCapabilityClassification Classification, PublicCapabilityKind Kind, bool RequiresSession, bool RequiresExactProfile, string ApiRoute, string CliRoute, string RuntimeValidation, string Description, IReadOnlyList<string> HandleTypes = null)
Eigenschaftstring Id { get; init; }
Eigenschaftstring Family { get; init; }
EigenschaftPublicCapabilityClassification Classification { get; init; }
EigenschaftPublicCapabilityKind Kind { get; init; }
Eigenschaftbool RequiresSession { get; init; }
Eigenschaftbool RequiresExactProfile { get; init; }
Eigenschaftstring ApiRoute { get; init; }
Eigenschaftstring CliRoute { get; init; }
Eigenschaftstring RuntimeValidation { get; init; }
Eigenschaftstring Description { get; init; }
EigenschaftIReadOnlyList<string> HandleTypes { get; init; }

PublicCapabilityKind#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: capabilities.

MemberSignatur
WertRead = 0
WertWrite = 1
WertAction = 2
WertEvent = 3

PublicCapabilityRegistry#

Statische Klasse in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: capabilities.

MemberSignatur
Konstantestring ProtocolVersion = "0.1"
statisches FeldIReadOnlyList<PublicCapabilityDescriptor> All
statische EigenschaftIReadOnlyCollection<string> PublicRuntimeOperationIds { get; }
statische MethodeIReadOnlyList<PublicRuntimeArgumentDescriptor> GetRuntimeArguments(string operation)
statische Methodebool IsInternalResultKey(string key)
statische Methodebool IsPublicRuntimeOperation(string operation)
statische MethodePublicRuntimeArgumentValidation ValidateRuntimeArguments(string operation, IReadOnlyDictionary<string, string> arguments)

PublicErrorCategory#

Statische Klasse in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: errors.

MemberSignatur
Konstantestring InvalidArgument = "invalid_argument"
Konstantestring UnsupportedProfile = "unsupported_profile"
Konstantestring Session = "session"
Konstantestring Runtime = "runtime"
Konstantestring NotFound = "not_found"
Konstantestring Transaction = "transaction"
Konstantestring Internal = "internal"

PublicErrorCodes#

Statische Klasse in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: errors.

MemberSignatur
Konstantestring CANCELLED = "OL_E_CANCELLED"
Konstantestring INTERNAL = "OL_E_INTERNAL"
Konstantestring TIMEOUT = "OL_E_TIMEOUT"
Konstantestring WINDOWS_HOST_MISSING = "OL_E_WINDOWS_HOST_MISSING"
Konstantestring WINDOWS_HOST_START_FAILED = "OL_E_WINDOWS_HOST_START_FAILED"
Konstantestring BUILD_VALIDATION_FAILED = "OL_E_BUILD_VALIDATION_FAILED"
Konstantestring UNSUPPORTED_BUILD = "OL_E_UNSUPPORTED_BUILD"
Konstantestring UNSUPPORTED_OPERATING_SYSTEM = "OL_E_UNSUPPORTED_OPERATING_SYSTEM"
Konstantestring UNSUPPORTED_OS_ARCHITECTURE = "OL_E_UNSUPPORTED_OS_ARCHITECTURE"
Konstantestring ENTRYPOINT_NOT_FOUND = "OL_E_ENTRYPOINT_NOT_FOUND"
Konstantestring ENTRYPOINT_REQUIRED = "OL_E_ENTRYPOINT_REQUIRED"
Konstantestring HOF_NOT_FOUND = "OL_E_HOF_NOT_FOUND"
Konstantestring MAP_NOT_FOUND = "OL_E_MAP_NOT_FOUND"
Konstantestring NOT_FOUND = "OL_E_NOT_FOUND"
Konstantestring REPAINT_NOT_FOUND = "OL_E_REPAINT_NOT_FOUND"
Konstantestring SITUATION_MAP_NOT_FOUND = "OL_E_SITUATION_MAP_NOT_FOUND"
Konstantestring SITUATION_NOT_FOUND = "OL_E_SITUATION_NOT_FOUND"
Konstantestring VEHICLE_NOT_FOUND = "OL_E_VEHICLE_NOT_FOUND"
Konstantestring INSTALLATION_BUSY = "OL_E_INSTALLATION_BUSY"
Konstantestring INSTALLATION_NOT_FOUND = "OL_E_INSTALLATION_NOT_FOUND"
Konstantestring INSTALLATION_NOT_WRITABLE = "OL_E_INSTALLATION_NOT_WRITABLE"
Konstantestring PERMANENT_PLUGIN_HASH_MISMATCH = "OL_E_PERMANENT_PLUGIN_HASH_MISMATCH"
Konstantestring PERMANENT_PLUGIN_MANIFEST_INCOMPLETE = "OL_E_PERMANENT_PLUGIN_MANIFEST_INCOMPLETE"
Konstantestring PERMANENT_PLUGIN_MISSING = "OL_E_PERMANENT_PLUGIN_MISSING"
Konstantestring PLATFORM_CAPABILITY_MISSING = "OL_E_PLATFORM_CAPABILITY_MISSING"
Konstantestring RELEASE_MANIFEST_INVALID = "OL_E_RELEASE_MANIFEST_INVALID"
Konstantestring INVALID_ARGUMENT = "OL_E_INVALID_ARGUMENT"
Konstantestring INVALID_SETTING_VALUE = "OL_E_INVALID_SETTING_VALUE"
Konstantestring SETTING_NOT_WRITABLE = "OL_E_SETTING_NOT_WRITABLE"
Konstantestring UNKNOWN_SETTING = "OL_E_UNKNOWN_SETTING"
Konstantestring SPEC_INVALID = "OL_E_SPEC_INVALID"
Konstantestring SPEC_NOT_FOUND = "OL_E_SPEC_NOT_FOUND"
Konstantestring SPEC_TOO_LARGE = "OL_E_SPEC_TOO_LARGE"
Konstantestring SPEC_UNKNOWN_PROPERTY = "OL_E_SPEC_UNKNOWN_PROPERTY"
Konstantestring CONTROL_COMMAND_UNKNOWN = "OL_E_CONTROL_COMMAND_UNKNOWN"
Konstantestring CONTROL_FAILED = "OL_E_CONTROL_FAILED"
Konstantestring CONTROL_HANDLER_FAILED = "OL_E_CONTROL_HANDLER_FAILED"
Konstantestring CONTROL_MESSAGE_INVALID = "OL_E_CONTROL_MESSAGE_INVALID"
Konstantestring CONTROL_MESSAGE_TOO_LARGE = "OL_E_CONTROL_MESSAGE_TOO_LARGE"
Konstantestring CONTROL_PROTOCOL = "OL_E_CONTROL_PROTOCOL"
Konstantestring CONTROL_RESPONSE_TOO_LARGE = "OL_E_CONTROL_RESPONSE_TOO_LARGE"
Konstantestring CONTROL_SESSION_MISMATCH = "OL_E_CONTROL_SESSION_MISMATCH"
Konstantestring PLAN_NOT_RUNNABLE = "OL_E_PLAN_NOT_RUNNABLE"
Konstantestring ITX_PROFILE_INVALID = "OL_E_ITX_PROFILE_INVALID"
Konstantestring ITX_PROFILE_MISSING = "OL_E_ITX_PROFILE_MISSING"
Konstantestring ITX_PROFILE_REQUIRED = "OL_E_ITX_PROFILE_REQUIRED"
Konstantestring ITX_TARGET_OUTSIDE_TEXTURE_PATH = "OL_E_ITX_TARGET_OUTSIDE_TEXTURE_PATH"
Konstantestring SPLASH_ASSET_DIRECTORY_MISSING = "OL_E_SPLASH_ASSET_DIRECTORY_MISSING"
Konstantestring SPLASH_ASSET_MISSING = "OL_E_SPLASH_ASSET_MISSING"
Konstantestring SPLASH_FORMAT_UNSUPPORTED = "OL_E_SPLASH_FORMAT_UNSUPPORTED"
Konstantestring PROCESS_CLEANUP_FAILED = "OL_E_PROCESS_CLEANUP_FAILED"
Konstantestring PROCESS_CREATION_TIME_FAILED = "OL_E_PROCESS_CREATION_TIME_FAILED"
Konstantestring PROCESS_EXITED_EARLY = "OL_E_PROCESS_EXITED_EARLY"
Konstantestring PROCESS_START_FAILED = "OL_E_PROCESS_START_FAILED"
Konstantestring PROCESS_SUPERVISION = "OL_E_PROCESS_SUPERVISION"
Konstantestring PROCESS_TERMINATE_FAILED = "OL_E_PROCESS_TERMINATE_FAILED"
Konstantestring PROCESS_WAIT_FAILED = "OL_E_PROCESS_WAIT_FAILED"
Konstantestring CAMERA_PRESET_FAMILY_UNSUPPORTED = "OL_E_CAMERA_PRESET_FAMILY_UNSUPPORTED"
Konstantestring DATE_TIME_APPLY_FAILED = "OL_E_DATE_TIME_APPLY_FAILED"
Konstantestring MAKEVEHICLE_BUS_NOT_FOUND = "OL_E_MAKEVEHICLE_BUS_NOT_FOUND"
Konstantestring MAKEVEHICLE_DELTA_MULTIPLE = "OL_E_MAKEVEHICLE_DELTA_MULTIPLE"
Konstantestring MAKEVEHICLE_DELTA_ZERO = "OL_E_MAKEVEHICLE_DELTA_ZERO"
Konstantestring MAKEVEHICLE_NATIVE_FAILED = "OL_E_MAKEVEHICLE_NATIVE_FAILED"
Konstantestring PLACE_RANDOM_BUS_FAILED = "OL_E_PLACE_RANDOM_BUS_FAILED"
Konstantestring RUNTIME_ARGUMENT_REQUIRED = "OL_E_RUNTIME_ARGUMENT_REQUIRED"
Konstantestring RUNTIME_ARTIFACT_MISSING = "OL_E_RUNTIME_ARTIFACT_MISSING"
Konstantestring RUNTIME_BASELINE_UNAVAILABLE = "OL_E_RUNTIME_BASELINE_UNAVAILABLE"
Konstantestring RUNTIME_BUS_IDENTITY_INVALID = "OL_E_RUNTIME_BUS_IDENTITY_INVALID"
Konstantestring RUNTIME_CHANNEL_BUSY = "OL_E_RUNTIME_CHANNEL_BUSY"
Konstantestring RUNTIME_CHANNEL_CLOSED = "OL_E_RUNTIME_CHANNEL_CLOSED"
Konstantestring RUNTIME_CHANNEL_STATE_INVALID = "OL_E_RUNTIME_CHANNEL_STATE_INVALID"
Konstantestring RUNTIME_CONSTANTS_UNAVAILABLE = "OL_E_RUNTIME_CONSTANTS_UNAVAILABLE"
Konstantestring RUNTIME_CONSTANT_NOT_FOUND = "OL_E_RUNTIME_CONSTANT_NOT_FOUND"
Konstantestring RUNTIME_CREATED_OBJECT_INVALID = "OL_E_RUNTIME_CREATED_OBJECT_INVALID"
Konstantestring RUNTIME_CREATED_OBJECT_NOT_IN_COLLECTION = "OL_E_RUNTIME_CREATED_OBJECT_NOT_IN_COLLECTION"
Konstantestring RUNTIME_CURVE_DEGENERATE = "OL_E_RUNTIME_CURVE_DEGENERATE"
Konstantestring RUNTIME_CURVE_EMPTY = "OL_E_RUNTIME_CURVE_EMPTY"
Konstantestring RUNTIME_CURVE_INVALID = "OL_E_RUNTIME_CURVE_INVALID"
Konstantestring RUNTIME_CURVE_NOT_FOUND = "OL_E_RUNTIME_CURVE_NOT_FOUND"
Konstantestring RUNTIME_HOF_UNAVAILABLE = "OL_E_RUNTIME_HOF_UNAVAILABLE"
Konstantestring RUNTIME_INSTALLATION_INCOMPLETE = "OL_E_RUNTIME_INSTALLATION_INCOMPLETE"
Konstantestring RUNTIME_OBJECT_HANDLE_REQUIRED = "OL_E_RUNTIME_OBJECT_HANDLE_REQUIRED"
Konstantestring RUNTIME_OBJECT_HANDLE_STALE = "OL_E_RUNTIME_OBJECT_HANDLE_STALE"
Konstantestring RUNTIME_OPERATION_FAILED = "OL_E_RUNTIME_OPERATION_FAILED"
Konstantestring RUNTIME_OPERATION_UNAVAILABLE = "OL_E_RUNTIME_OPERATION_UNAVAILABLE"
Konstantestring RUNTIME_OPERATION_UNKNOWN = "OL_E_RUNTIME_OPERATION_UNKNOWN"
Konstantestring RUNTIME_PLAYER_VEHICLE_UNAVAILABLE = "OL_E_RUNTIME_PLAYER_VEHICLE_UNAVAILABLE"
Konstantestring RUNTIME_PROTOCOL_MISMATCH = "OL_E_RUNTIME_PROTOCOL_MISMATCH"
Konstantestring RUNTIME_REQUEST_ID_REUSED = "OL_E_RUNTIME_REQUEST_ID_REUSED"
Konstantestring RUNTIME_REQUEST_TIMEOUT = "OL_E_RUNTIME_REQUEST_TIMEOUT"
Konstantestring RUNTIME_RESPONSE_INVALID = "OL_E_RUNTIME_RESPONSE_INVALID"
Konstantestring RUNTIME_RESPONSE_TOO_LARGE = "OL_E_RUNTIME_RESPONSE_TOO_LARGE"
Konstantestring RUNTIME_SCRIPT_OBJECT_UNAVAILABLE = "OL_E_RUNTIME_SCRIPT_OBJECT_UNAVAILABLE"
Konstantestring RUNTIME_SESSION_MISMATCH = "OL_E_RUNTIME_SESSION_MISMATCH"
Konstantestring RUNTIME_SETTING_NOT_PERSISTENT = "OL_E_RUNTIME_SETTING_NOT_PERSISTENT"
Konstantestring RUNTIME_SETTING_UNAVAILABLE = "OL_E_RUNTIME_SETTING_UNAVAILABLE"
Konstantestring RUNTIME_STRING_VARIABLE_NOT_FOUND = "OL_E_RUNTIME_STRING_VARIABLE_NOT_FOUND"
Konstantestring RUNTIME_VALUE_INVALID = "OL_E_RUNTIME_VALUE_INVALID"
Konstantestring RUNTIME_VALUE_OUT_OF_RANGE = "OL_E_RUNTIME_VALUE_OUT_OF_RANGE"
Konstantestring RUNTIME_VARIABLE_NOT_FOUND = "OL_E_RUNTIME_VARIABLE_NOT_FOUND"
Konstantestring RUNTIME_VARIABLE_UNAVAILABLE = "OL_E_RUNTIME_VARIABLE_UNAVAILABLE"
Konstantestring TIME_APPLY_FAILED = "OL_E_TIME_APPLY_FAILED"
Konstantestring D3D_DEVICE_LOST = "OL_E_D3D_DEVICE_LOST"
Konstantestring D3D_INVALID_ARGUMENT = "OL_E_D3D_INVALID_ARGUMENT"
Konstantestring D3D_INVALID_PIXEL_BUFFER = "OL_E_D3D_INVALID_PIXEL_BUFFER"
Konstantestring D3D_INVALID_TEXTURE_FORMAT = "OL_E_D3D_INVALID_TEXTURE_FORMAT"
Konstantestring D3D_NATIVE_CALL_FAILED = "OL_E_D3D_NATIVE_CALL_FAILED"
Konstantestring D3D_NOT_READY = "OL_E_D3D_NOT_READY"
Konstantestring D3D_RESET_IN_PROGRESS = "OL_E_D3D_RESET_IN_PROGRESS"
Konstantestring D3D_RESOURCE_RELEASED = "OL_E_D3D_RESOURCE_RELEASED"
Konstantestring D3D_STALE_RESOURCE_HANDLE = "OL_E_D3D_STALE_RESOURCE_HANDLE"
Konstantestring CAPABILITY_UNAVAILABLE = "OL_E_CAPABILITY_UNAVAILABLE"
Konstantestring HEADLESS_ARM_FAILED = "OL_E_HEADLESS_ARM_FAILED"
Konstantestring NO_ACTIVE_SESSION = "OL_E_NO_ACTIVE_SESSION"
Konstantestring PLUGIN_NOT_LOADED = "OL_E_PLUGIN_NOT_LOADED"
Konstantestring PLUGIN_PROTOCOL_MISMATCH = "OL_E_PLUGIN_PROTOCOL_MISMATCH"
Konstantestring SESSION_ALREADY_ACTIVE = "OL_E_SESSION_ALREADY_ACTIVE"
Konstantestring SESSION_NOT_RUNNING = "OL_E_SESSION_NOT_RUNNING"
Konstantestring SESSION_PRESENTATION_INVALID = "OL_E_SESSION_PRESENTATION_INVALID"
Konstantestring SESSION_START_FAILED = "OL_E_SESSION_START_FAILED"
Konstantestring SITUATION_LOAD_FAILED = "OL_E_SITUATION_LOAD_FAILED"
Konstantestring STARTUP_TIMEOUT = "OL_E_STARTUP_TIMEOUT"
Konstantestring START_SESSION = "OL_E_START_SESSION"
Konstantestring WORLD_START_FAILED = "OL_E_WORLD_START_FAILED"
Konstantestring SESSION_PROFILE_ASSET_MISSING = "OL_E_SESSION_PROFILE_ASSET_MISSING"
Konstantestring SESSION_PROFILE_INVALID = "OL_E_SESSION_PROFILE_INVALID"
Konstantestring SESSION_PROFILE_MAP_MISMATCH = "OL_E_SESSION_PROFILE_MAP_MISMATCH"
Konstantestring SESSION_PROFILE_NOT_FOUND = "OL_E_SESSION_PROFILE_NOT_FOUND"
Konstantestring SESSION_PROFILE_OVERRIDE_CONFLICT = "OL_E_SESSION_PROFILE_OVERRIDE_CONFLICT"
Konstantestring SESSION_PROFILE_PATH_ESCAPE = "OL_E_SESSION_PROFILE_PATH_ESCAPE"
Konstantestring SESSION_PROFILE_PRESET_NOT_FOUND = "OL_E_SESSION_PROFILE_PRESET_NOT_FOUND"
Konstantestring SESSION_PROFILE_SCHEMA_UNSUPPORTED = "OL_E_SESSION_PROFILE_SCHEMA_UNSUPPORTED"
Konstantestring SESSION_PROFILE_SETTING_NOT_WRITABLE = "OL_E_SESSION_PROFILE_SETTING_NOT_WRITABLE"
Konstantestring SESSION_PROFILE_SETTING_UNKNOWN = "OL_E_SESSION_PROFILE_SETTING_UNKNOWN"
Konstantestring CLOSECHECK_REMOVE_FAILED = "OL_E_CLOSECHECK_REMOVE_FAILED"
Konstantestring RECOVERY_ABSENT_OWNERSHIP_MISMATCH = "OL_E_RECOVERY_ABSENT_OWNERSHIP_MISMATCH"
Konstantestring RECOVERY_ABSENT_OWNERSHIP_UNVERIFIED = "OL_E_RECOVERY_ABSENT_OWNERSHIP_UNVERIFIED"
Konstantestring RECOVERY_BACKUP_CORRUPT = "OL_E_RECOVERY_BACKUP_CORRUPT"
Konstantestring RECOVERY_JOURNAL_MISSING = "OL_E_RECOVERY_JOURNAL_MISSING"
Konstantestring RECOVERY_JOURNAL_REMOVE_FAILED = "OL_E_RECOVERY_JOURNAL_REMOVE_FAILED"
Konstantestring RESTORE_DEFERRED = "OL_E_RESTORE_DEFERRED"
Konstantestring RESTORE_FAILED = "OL_E_RESTORE_FAILED"
Konstantestring RESTORE_FOREIGN_FILE_RETAINED = "OL_W_RESTORE_FOREIGN_FILE_RETAINED"
statisches FeldIReadOnlyList<PublicErrorDescriptor> All

PublicErrorDescriptor#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: errors.

MemberSignatur
KonstruktorPublicErrorDescriptor(string Code, string Category)
Eigenschaftstring Code { get; init; }
Eigenschaftstring Category { get; init; }

PublicExitCode#

Enumeration (int) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: exit-codes.

MemberSignatur
WertSuccess = 0
WertSessionFailed = 1
WertInvalidArguments = 2
WertUnsupportedProfile = 3
WertNoActiveSession = 4
WertRuntimeUnavailable = 5
WertNotFound = 6
WertOperationRejected = 7
WertTransactionRecoveryFailed = 8
WertInternalError = 10

PublicRuntimeArgumentDescriptor#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorPublicRuntimeArgumentDescriptor(string Name, bool Required, string Description)
Eigenschaftstring Name { get; init; }
Eigenschaftbool Required { get; init; }
Eigenschaftstring Description { get; init; }

PublicRuntimeArgumentValidation#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorPublicRuntimeArgumentValidation(bool Accepted, string ErrorCode = null, string Message = null)
Eigenschaftbool Accepted { get; init; }
Eigenschaftstring ErrorCode { get; init; }
Eigenschaftstring Message { get; init; }

RecoveryStatus#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorRecoveryStatus(bool Pending, bool Recovered, IReadOnlyList<LaunchDiagnostic> Diagnostics)
Eigenschaftbool Pending { get; init; }
Eigenschaftbool Recovered { get; init; }
EigenschaftIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }

RuntimeCommand#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: runtime-control.

MemberSignatur
KonstruktorRuntimeCommand(Guid SessionId, ulong RequestId, string Operation, IReadOnlyDictionary<string, string> Arguments = null)
EigenschaftGuid SessionId { get; init; }
Eigenschaftulong RequestId { get; init; }
Eigenschaftstring Operation { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Arguments { get; init; }

RuntimeCommandResult#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: runtime-control.

MemberSignatur
KonstruktorRuntimeCommandResult(Guid SessionId, ulong RequestId, bool Succeeded, string ErrorCode = null, IReadOnlyDictionary<string, string> Values = null)
EigenschaftGuid SessionId { get; init; }
Eigenschaftulong RequestId { get; init; }
Eigenschaftbool Succeeded { get; init; }
Eigenschaftstring ErrorCode { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Values { get; init; }

RuntimeCommandWire#

Statische Klasse in OmsiLaunch.Api. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Konstanteuint Magic = 1330401859
Konstanteushort Version = 1
Konstanteint HeaderSize = 72
statische Methodebyte[] SerializeRequest(RuntimeCommand command)
statische Methodebyte[] SerializeResponse(RuntimeCommandResult result)
statische Methodebool TryDeserializeRequest(ReadOnlySpan<byte> bytes, out RuntimeCommand command)
statische Methodebool TryDeserializeResponse(ReadOnlySpan<byte> bytes, out RuntimeCommandResult result)
statische Methodebool TryReadRequestId(ReadOnlySpan<byte> bytes, out ulong requestId)

RuntimeEvent#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorRuntimeEvent(string Type, DateTimeOffset TimestampUtc, long Sequence, IReadOnlyDictionary<string, string> Data)
Eigenschaftstring Type { get; init; }
EigenschaftDateTimeOffset TimestampUtc { get; init; }
Eigenschaftlong Sequence { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Data { get; init; }

RuntimePlatformInfo#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorRuntimePlatformInfo(string OsFamily, string OsVersion, string OsArchitecture, string HostArchitecture, string OmsiArchitecture, string PluginArchitecture, bool CurrentPlatformSupported, bool LegacyPlatform, bool Wow64Available, bool InstallationWritable, bool ProcessLaunchSupported, bool PluginRuntimeSupported, bool NativeInteropSupported, bool SharedMemorySupported, bool ExactRestoreSupported)
Eigenschaftstring OsFamily { get; init; }
Eigenschaftstring OsVersion { get; init; }
Eigenschaftstring OsArchitecture { get; init; }
Eigenschaftstring HostArchitecture { get; init; }
Eigenschaftstring OmsiArchitecture { get; init; }
Eigenschaftstring PluginArchitecture { get; init; }
Eigenschaftbool CurrentPlatformSupported { get; init; }
Eigenschaftbool LegacyPlatform { get; init; }
Eigenschaftbool Wow64Available { get; init; }
Eigenschaftbool InstallationWritable { get; init; }
Eigenschaftbool ProcessLaunchSupported { get; init; }
Eigenschaftbool PluginRuntimeSupported { get; init; }
Eigenschaftbool NativeInteropSupported { get; init; }
Eigenschaftbool SharedMemorySupported { get; init; }
Eigenschaftbool ExactRestoreSupported { get; init; }

SemanticDate#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorSemanticDate(int Year, int Month, int Day)
Eigenschaftint Year { get; init; }
Eigenschaftint Month { get; init; }
Eigenschaftint Day { get; init; }

SemanticTime#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorSemanticTime(int Hour, int Minute, int Second)
Eigenschaftint Hour { get; init; }
Eigenschaftint Minute { get; init; }
Eigenschaftint Second { get; init; }

SessionHandle#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorSessionHandle(Guid SessionId)
EigenschaftGuid SessionId { get; init; }

SessionPlan#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorSessionPlan(Guid SessionId, string BuildProfileId, LaunchSpec Spec, RuntimePlatformInfo Platform, IReadOnlyList<ContentIdentity> ResolvedContent, IReadOnlyList<string> TouchedFiles, IReadOnlyList<string> RuntimeArtifacts, IReadOnlyList<Capability> RequiredCapabilities, IReadOnlyList<Capability> UnsupportedRequestedFeatures, IReadOnlyList<PlannedMutation> PlannedMutations, IReadOnlyList<LaunchDiagnostic> Diagnostics, bool IsRunnable)
EigenschaftGuid SessionId { get; init; }
Eigenschaftstring BuildProfileId { get; init; }
EigenschaftLaunchSpec Spec { get; init; }
EigenschaftRuntimePlatformInfo Platform { get; init; }
EigenschaftIReadOnlyList<ContentIdentity> ResolvedContent { get; init; }
EigenschaftIReadOnlyList<string> TouchedFiles { get; init; }
EigenschaftIReadOnlyList<string> RuntimeArtifacts { get; init; }
EigenschaftIReadOnlyList<Capability> RequiredCapabilities { get; init; }
EigenschaftIReadOnlyList<Capability> UnsupportedRequestedFeatures { get; init; }
EigenschaftIReadOnlyList<PlannedMutation> PlannedMutations { get; init; }
EigenschaftIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
Eigenschaftbool IsRunnable { get; init; }

SessionPresentationSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorSessionPresentationSpec(SplashMode Splash = Managed, OptionalValue<string> Language = default, OptionalValue<string> CustomAssetDirectory = default, bool SuppressTrayIcon = false)
EigenschaftSplashMode Splash { get; init; }
EigenschaftOptionalValue<string> Language { get; init; }
EigenschaftOptionalValue<string> CustomAssetDirectory { get; init; }
Eigenschaftbool SuppressTrayIcon { get; init; }

SessionProfileMetadata#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorSessionProfileMetadata(string Id, string Name, string Version, string Author, string PresetId, int PresetIndex, string PresetName, string PackagePath)
Eigenschaftstring Id { get; init; }
Eigenschaftstring Name { get; init; }
Eigenschaftstring Version { get; init; }
Eigenschaftstring Author { get; init; }
Eigenschaftstring PresetId { get; init; }
Eigenschaftint PresetIndex { get; init; }
Eigenschaftstring PresetName { get; init; }
Eigenschaftstring PackagePath { get; init; }

SessionState#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
WertCreated = 0
WertValidatingPlatform = 1
WertPlanning = 2
WertAcquiringInstallationLock = 3
WertRecoveringPreviousTransaction = 4
WertSnapshotting = 5
WertApplyingConfiguration = 6
WertDeployingRuntime = 7
WertCreatingStartupHandoff = 8
WertStartingProcess = 9
WertWaitingForPlugin = 10
WertPluginBootstrap = 11
WertStartingWorld = 12
WertEnteringGameplay = 13
WertRunning = 14
WertProcessExited = 15
WertRestoring = 16
WertCleaningRuntime = 17
WertCompleted = 18
WertFailed = 19

SessionStatus#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorSessionStatus(Guid SessionId, SessionState State, IReadOnlyList<LaunchDiagnostic> Diagnostics, IReadOnlyList<RuntimeEvent> RuntimeEvents = null)
EigenschaftGuid SessionId { get; init; }
EigenschaftSessionState State { get; init; }
EigenschaftIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
EigenschaftIReadOnlyList<RuntimeEvent> RuntimeEvents { get; init; }

SplashMode#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertUnset = 0
WertNative = 0
WertManaged = 1

StartupHandoff#

Versiegelter Record in OmsiLaunch.Api. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorStartupHandoff(Guid SessionId, string BuildProfileId, WorldMode WorldMode, string MapIdentity, int PresentedEntrypointIndex, bool HeadlessStart, bool PlayerVehicleEnabled, DateTimeMode DateMode, DateTimeMode TimeMode, string EntrypointIdentity = "", string SituationIdentity = "")
EigenschaftGuid SessionId { get; init; }
Eigenschaftstring BuildProfileId { get; init; }
EigenschaftWorldMode WorldMode { get; init; }
Eigenschaftstring MapIdentity { get; init; }
Eigenschaftint PresentedEntrypointIndex { get; init; }
Eigenschaftbool HeadlessStart { get; init; }
Eigenschaftbool PlayerVehicleEnabled { get; init; }
EigenschaftDateTimeMode DateMode { get; init; }
EigenschaftDateTimeMode TimeMode { get; init; }
Eigenschaftstring EntrypointIdentity { get; init; }
Eigenschaftstring SituationIdentity { get; init; }

StartupHandoffWire#

Statische Klasse in OmsiLaunch.Api. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Konstanteuint Magic = 1330402120
Konstanteushort Version = 4
statische Methodebyte[] Serialize(StartupHandoff value)
statische Methodebool TryDeserialize(ReadOnlySpan<byte> bytes, out StartupHandoff value)

TimeSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorTimeSpec(DateTimeMode Mode, OptionalValue<SemanticTime> Value)
EigenschaftDateTimeMode Mode { get; init; }
EigenschaftOptionalValue<SemanticTime> Value { get; init; }

WeatherMode#

Enumeration (byte) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertUnset = 0
WertPreset = 1
WertIcao = 2
WertRealCurrent = 3

WeatherSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorWeatherSpec(WeatherMode Mode, OptionalValue<string> Preset, OptionalValue<string> Icao)
EigenschaftWeatherMode Mode { get; init; }
EigenschaftOptionalValue<string> Preset { get; init; }
EigenschaftOptionalValue<string> Icao { get; init; }

WorldMode#

Enumeration (int) in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
WertNewMap = 0
WertSavedSituation = 1
WertLastMapState = 2
WertLastSituation = 2

WorldSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: STABLE_BETA. Semantik: launchspec.

MemberSignatur
KonstruktorWorldSpec(WorldMode Mode, OptionalValue<string> MapIdentity, OptionalValue<string> SituationIdentity, OptionalValue<int> PresentedEntrypointIndex, OptionalValue<string> EntrypointIdentity = default)
EigenschaftWorldMode Mode { get; init; }
EigenschaftOptionalValue<string> MapIdentity { get; init; }
EigenschaftOptionalValue<string> SituationIdentity { get; init; }
EigenschaftOptionalValue<int> PresentedEntrypointIndex { get; init; }
EigenschaftOptionalValue<string> EntrypointIdentity { get; init; }
EigenschaftEntrypointSpec Entrypoint { get; }

YearSpec#

Versiegelter Record in OmsiLaunch.Api. Stabilität: PARTIAL. Semantik: launchspec.

MemberSignatur
KonstruktorYearSpec(DateTimeMode Mode, OptionalValue<int> Value)
EigenschaftDateTimeMode Mode { get; init; }
EigenschaftOptionalValue<int> Value { get; init; }

OmsiLaunch.Core#

LaunchValidation#

Statische Klasse in OmsiLaunch.Core. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
statische Methodebool IsMapIdentity(string value)
statische MethodeIReadOnlyList<LaunchDiagnostic> Validate(LaunchSpec spec)

OmsiLaunchRuntimePaths#

Versiegelter Record in OmsiLaunch.Core. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorOmsiLaunchRuntimePaths(string PluginBuildDirectory, string NativeBridgePath, string ReleaseManifestPath = null)
Eigenschaftstring PluginBuildDirectory { get; init; }
Eigenschaftstring NativeBridgePath { get; init; }
Eigenschaftstring ReleaseManifestPath { get; init; }

OmsiLaunchService#

Versiegelte Klasse in OmsiLaunch.Core. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorOmsiLaunchService(IRuntimePlatform platform, OmsiLaunchRuntimePaths runtimePaths)
MethodeTask CloseAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<IReadOnlyList<ContentIdentity>> DiscoverAsync(InstallationSpec installation, ContentQueryKind query, OptionalValue<string> scope = default, CancellationToken cancellationToken = default)
MethodeTask<RuntimeCommandResult> ExecuteRuntimeAsync(SessionHandle session, RuntimeCommand command, TimeSpan timeout, CancellationToken cancellationToken = default)
MethodeTask<IReadOnlyList<Capability>> GetCapabilitiesAsync(InstallationSpec installation, CancellationToken cancellationToken = default)
MethodeTask<SessionStatus> GetStatusAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<SessionPlan> PlanSessionAsync(LaunchSpec spec, CancellationToken cancellationToken = default)
MethodeTask<RecoveryStatus> RecoverPendingAsync(InstallationSpec installation, bool restore, CancellationToken cancellationToken = default)
MethodeTask<SessionHandle> StartSessionAsync(SessionPlan plan, CancellationToken cancellationToken = default)
MethodeTask StopAsync(SessionHandle session, CancellationToken cancellationToken = default)
MethodeTask<SessionStatus> WaitForAsync(SessionHandle session, SessionState state, TimeSpan timeout, CancellationToken cancellationToken = default)

ProfileNew#

Versiegelter Record in OmsiLaunch.Core. Stabilität: EXPERIMENTAL. Semantik: session-profiles.

MemberSignatur
KonstruktorProfileNew(string Map = null, int? EntrypointIndex = default, string EntrypointIdentity = null, SemanticDate Date = null, SemanticTime Time = null, int? Year = default, WeatherSpec Weather = null)
Eigenschaftstring Map { get; init; }
Eigenschaftint? EntrypointIndex { get; init; }
Eigenschaftstring EntrypointIdentity { get; init; }
EigenschaftSemanticDate Date { get; init; }
EigenschaftSemanticTime Time { get; init; }
Eigenschaftint? Year { get; init; }
EigenschaftWeatherSpec Weather { get; init; }

ProfilePreset#

Versiegelter Record in OmsiLaunch.Core. Stabilität: EXPERIMENTAL. Semantik: session-profiles.

MemberSignatur
KonstruktorProfilePreset(int Index, string Id, string Name, IReadOnlyDictionary<string, string> Settings, SessionPresentationSpec Presentation, InternetTexturesSpec InternetTextures, LaunchBehaviorSpec Behavior)
Eigenschaftint Index { get; init; }
Eigenschaftstring Id { get; init; }
Eigenschaftstring Name { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Settings { get; init; }
EigenschaftSessionPresentationSpec Presentation { get; init; }
EigenschaftInternetTexturesSpec InternetTextures { get; init; }
EigenschaftLaunchBehaviorSpec Behavior { get; init; }

SessionPlanner#

Versiegelte Klasse in OmsiLaunch.Core. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorSessionPlanner(IRuntimePlatform platform)
MethodeTask<SessionPlan> PlanAsync(LaunchSpec spec, CancellationToken cancellationToken = default)

SessionProfileCompiler#

Statische Klasse in OmsiLaunch.Core. Stabilität: EXPERIMENTAL. Semantik: session-profiles.

MemberSignatur
Konstantestring Schema = "omsilaunch.session-profile/v1"
Konstantelong MaxBytes = 262144
statisches FeldIReadOnlyDictionary<string, IReadOnlyList<string>> SchemaKeys
statische MethodeLaunchSpec Apply(SessionProfilePackage profile, LaunchSpec baseline, WorldMode selectedWorldMode)
statische MethodeSessionProfilePackage Load(string installationRoot, string id, int presetIndex)
statische Methodevoid ValidateCompatibility(SessionProfilePackage profile, string installationRoot, WorldSpec world, WorldMode mode)

SessionProfileException#

Versiegelte Klasse in OmsiLaunch.Core. Stabilität: EXPERIMENTAL. Semantik: session-profiles.

MemberSignatur
KonstruktorSessionProfileException(string code, string message)
Eigenschaftstring Code { get; }

SessionProfilePackage#

Versiegelter Record in OmsiLaunch.Core. Stabilität: EXPERIMENTAL. Semantik: session-profiles.

MemberSignatur
KonstruktorSessionProfilePackage(string RootPath, SessionProfileMetadata Metadata, IReadOnlyList<string> CompatibleMaps, ProfileNew New, ProfilePreset Preset)
Eigenschaftstring RootPath { get; init; }
EigenschaftSessionProfileMetadata Metadata { get; init; }
EigenschaftIReadOnlyList<string> CompatibleMaps { get; init; }
EigenschaftProfileNew New { get; init; }
EigenschaftProfilePreset Preset { get; init; }

OmsiLaunch.Process#

CurrentRuntimeCommandStore#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Eigenschaftstring Name { get; }
EigenschaftGuid SessionId { get; }
statische MethodeCurrentRuntimeCommandStore Create(Guid sessionId)
Methodevoid Dispose()
MethodeTask<RuntimeCommandResult> RequestAsync(RuntimeCommand command, TimeSpan timeout, CancellationToken cancellationToken = default)

CurrentStartupHandoffStore#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Eigenschaftstring Name { get; }
EigenschaftGuid SessionId { get; }
statische MethodeCurrentStartupHandoffStore Create(StartupHandoff handoff)
Methodevoid Dispose()

CurrentTelemetryStore#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Eigenschaftstring Name { get; }
statische MethodeCurrentTelemetryStore Create(Guid sessionId)
Methodevoid Dispose()
MethodeValueTuple<int, string>? ReadLatest()

CurrentWindowsX64Platform#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
KonstruktorCurrentWindowsX64Platform()
MethodeRuntimePlatformInfo Detect(string root)
Methodebool HasExited(LaunchedProcess p)
Methodebool IsInstallationWritable(string root)
MethodeTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
Methodevoid Terminate(LaunchedProcess p)
Methodevoid ValidateCurrent(RuntimePlatformInfo p)
MethodeTask WaitForExitAsync(LaunchedProcess process, CancellationToken token)

IOmsiProcessController#

Interface in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
MethodeOmsiProcessState Observe()
MethodeTask<int> StartAsync(string installation, CancellationToken cancellationToken = default)
MethodeTask StopAsync(CancellationToken cancellationToken = default)

IRuntimePlatform#

Interface in OmsiLaunch.Process. Stabilität: STABLE_BETA. Semantik: public-api.

MemberSignatur
MethodeRuntimePlatformInfo Detect(string installationRoot)
Methodebool HasExited(LaunchedProcess process)
Methodebool IsInstallationWritable(string installationRoot)
MethodeTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
Methodevoid Terminate(LaunchedProcess process)
Methodevoid ValidateCurrent(RuntimePlatformInfo platform)
MethodeTask WaitForExitAsync(LaunchedProcess process, CancellationToken cancellationToken)

InstallationLease#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
statische MethodeInstallationLease Acquire(string installationRoot)
Methodevoid Dispose()
statische Methodestring NormalizeRoot(string installationRoot)

LaunchedProcess#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Eigenschaftint ProcessId { get; }
Eigenschaftint ThreadId { get; }
EigenschaftProcessIdentity Identity { get; }
Methodevoid Dispose()

OmsiProcessState#

Versiegelter Record in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorOmsiProcessState(string State, int? ProcessId, bool Responding)
Eigenschaftstring State { get; init; }
Eigenschaftint? ProcessId { get; init; }
Eigenschaftbool Responding { get; init; }

ProcessIdentity#

Versiegelter Record in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorProcessIdentity(int ProcessId, DateTimeOffset CreationTimeUtc, string ExecutablePath, string ExecutableSha256)
Eigenschaftint ProcessId { get; init; }
EigenschaftDateTimeOffset CreationTimeUtc { get; init; }
Eigenschaftstring ExecutablePath { get; init; }
Eigenschaftstring ExecutableSha256 { get; init; }

ReleaseManifest#

Statische Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
Konstantestring FileName = "release-manifest.json"
statische MethodeIReadOnlyDictionary<string, string> ParsePluginHashes(byte[] bytes)
statische MethodeIReadOnlyDictionary<string, string> TryReadPluginHashes(string manifestPath)

RuntimeArtifact#

Versiegelter Record in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorRuntimeArtifact(string SourcePath, string DestinationRelativePath, string Sha256, long Size)
Eigenschaftstring SourcePath { get; init; }
Eigenschaftstring DestinationRelativePath { get; init; }
Eigenschaftstring Sha256 { get; init; }
Eigenschaftlong Size { get; init; }

RuntimeArtifactSet#

Versiegelte Klasse in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
EigenschaftIReadOnlyList<RuntimeArtifact> Artifacts { get; }
EigenschaftIReadOnlyDictionary<string, string> ExpectedHashes { get; }
Eigenschaftstring IntegrityReference { get; }
statische MethodeRuntimeArtifactSet Load(string pluginBuildDirectory, string nativeBuildPath, IReadOnlyDictionary<string, string> expectedHashes = null)
Methodevoid ValidateInstalled(string installationRoot)

StartupProcessRequest#

Versiegelter Record in OmsiLaunch.Process. Stabilität: INTERNAL. Semantik: public-api.

MemberSignatur
KonstruktorStartupProcessRequest(string ExecutablePath, string WorkingDirectory, IReadOnlyDictionary<string, string> Environment)
Eigenschaftstring ExecutablePath { get; init; }
Eigenschaftstring WorkingDirectory { get; init; }
EigenschaftIReadOnlyDictionary<string, string> Environment { get; init; }