Inventario dell’API pubblica

Documentazione della versione v0.1.0-beta.3Vedi il sorgente su GitHub

Traduzione della pagina originale in inglese di OmsiLaunch 0.1.0-beta3. La pagina inglese è normativa: in caso di differenze prevalgono la pagina inglese e il codice.

Questa pagina è generata dagli assembly compilati tramite tests/OmsiLaunch.DocumentationTests (dotnet run --project tests/OmsiLaunch.DocumentationTests -- --write-inventory); il controllo della documentazione fallisce quando non corrisponde più al codice. Elenca ogni tipo esportato da OmsiLaunch.Api, OmsiLaunch.Core e OmsiLaunch.Process, con la sua stabilità e la firma di ogni membro pubblico. Semantica, precondizioni, errori ed esempi sono documentati nella pagina indicata in ciascun titolo (predefinita: API pubblica). Vocabolario di stabilità: STABLE_BETA, EXPERIMENTAL, PARTIAL, INTERNAL (pubblico per motivi tecnici, non è una superficie di integrazione), UNAVAILABLE (vedere API pubblica). I membri dei record generati dal compilatore (Equals, GetHashCode, ToString, Deconstruct, <Clone>$, EqualityContract) sono omessi.

OmsiLaunch.Api#

Capability#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreCapability(string Name, bool Available, string EvidenceState, string Reason = null)
proprietàstring Name { get; init; }
proprietàbool Available { get; init; }
proprietàstring EvidenceState { get; init; }
proprietàstring Reason { get; init; }

ContentIdentity#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreContentIdentity(string Identity, string Kind, string DisplayName = null)
proprietàstring Identity { get; init; }
proprietàstring Kind { get; init; }
proprietàstring DisplayName { get; init; }

ContentQueryKind#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
valoreMaps = 0
valoreSituations = 1
valoreVehicles = 2
valoreRepaints = 3
valoreHofs = 4
valoreFleetNumbers = 5
valoreRegistrations = 6
valoreAddons = 7
valoreEntrypoints = 8

D3DDeviceState#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
valoreNotReady = 0
valoreReady = 1
valoreLost = 2
valoreResetting = 3
valoreStopping = 4
valoreStopped = 5

D3DDeviceStatus#

Record sealed in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
costruttoreD3DDeviceStatus(bool Available, D3DDeviceState State, uint Generation, uint LiveTextureCount, bool ResetHookInstalled, uint ExecutionThreadId, uint LastResetThreadId, int QueryInterfaceHResult, int CooperativeLevelHResult, uint OwnedDeviceReferences)
proprietàbool Available { get; init; }
proprietàD3DDeviceState State { get; init; }
proprietàuint Generation { get; init; }
proprietàuint LiveTextureCount { get; init; }
proprietàbool ResetHookInstalled { get; init; }
proprietàuint ExecutionThreadId { get; init; }
proprietàuint LastResetThreadId { get; init; }
proprietàint QueryInterfaceHResult { get; init; }
proprietàint CooperativeLevelHResult { get; init; }
proprietàuint OwnedDeviceReferences { get; init; }

D3DRuntimeApi#

Classe statica in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

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

D3DTextureDescription#

Record sealed in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
costruttoreD3DTextureDescription(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)
proprietàD3DTextureHandle Handle { get; init; }
proprietàD3DTextureResourceState State { get; init; }
proprietàD3DDeviceState DeviceState { get; init; }
proprietàuint Generation { get; init; }
proprietàuint Width { get; init; }
proprietàuint Height { get; init; }
proprietàD3DTextureFormat Format { get; init; }
proprietàuint Levels { get; init; }
proprietàuint Level { get; init; }
proprietàuint LevelWidth { get; init; }
proprietàuint LevelHeight { get; init; }
proprietàint HResult { get; init; }
proprietàuint ExecutionThreadId { get; init; }

D3DTextureFormat#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
valoreA8R8G8B8 = 0
valoreX8R8G8B8 = 1
valoreR5G6B5 = 2
valoreX1R5G5B5 = 3
valoreA1R5G5B5 = 4
valoreA4R4G4B4 = 5
valoreA8 = 6
valoreL8 = 7
valoreA8L8 = 8

D3DTextureHandle#

Record sealed in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
costruttoreD3DTextureHandle(string Value)
proprietàstring Value { get; init; }

D3DTextureResourceState#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
valoreLive = 0
valoreReleased = 1
valoreStale = 2

D3DTextureUpdate#

Record sealed in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
costruttoreD3DTextureUpdate(uint Level, uint X, uint Y, uint Width, uint Height, ReadOnlyMemory<byte> Pixels)
proprietàuint Level { get; init; }
proprietàuint X { get; init; }
proprietàuint Y { get; init; }
proprietàuint Width { get; init; }
proprietàuint Height { get; init; }
proprietàReadOnlyMemory<byte> Pixels { get; init; }

DateSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreDateSpec(DateTimeMode Mode, OptionalValue<SemanticDate> Value)
proprietàDateTimeMode Mode { get; init; }
proprietàOptionalValue<SemanticDate> Value { get; init; }

DateTimeMode#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreUnset = 0
valoreExplicit = 1
valoreSystem = 2

DiagnosticsSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreDiagnosticsSpec(bool Log = true, bool Verbose = false, bool OmsiLogAll = false, bool ProcessTrace = false, bool PluginTrace = false, bool NativeTrace = false)
proprietàbool Log { get; init; }
proprietàbool Verbose { get; init; }
proprietàbool OmsiLogAll { get; init; }
proprietàbool ProcessTrace { get; init; }
proprietàbool PluginTrace { get; init; }
proprietàbool NativeTrace { get; init; }

EntrypointMode#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreUnset = 0
valorePresentedIndex = 1
valoreIdentity = 2

EntrypointSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreEntrypointSpec(EntrypointMode Mode, OptionalValue<int> PresentedIndex, OptionalValue<string> Identity)
proprietàEntrypointMode Mode { get; init; }
proprietàOptionalValue<int> PresentedIndex { get; init; }
proprietàOptionalValue<string> Identity { get; init; }
proprietà staticaEntrypointSpec Unset { get; }

EnvironmentSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreEnvironmentSpec(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)
proprietàIReadOnlyDictionary<string, OptionalValue<string>> General { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> Advanced { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> Graphics { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> AdvancedGraphics { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> Sound { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> AiPassengers { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> Keyboard { get; init; }
proprietàIReadOnlyDictionary<string, OptionalValue<string>> Controllers { get; init; }

IOmsiLaunch#

Interfaccia in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

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

InputSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreInputSpec(OptionalValue<string> KeyboardDocument, OptionalValue<string> ControllerDocument)
proprietàOptionalValue<string> KeyboardDocument { get; init; }
proprietàOptionalValue<string> ControllerDocument { get; init; }

InstallationPaths#

Classe statica in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
metodo staticostring IdentityKey(string root)
metodo staticostring NormalizeRoot(string root)
metodo staticoIReadOnlyList<string> Segments(string relativePath)
metodo staticobool TryGetContainedRelativePath(string root, string candidate, out string relativePath)

InstallationSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreInstallationSpec(string RootPath, string ExpectedExecutableSha256 = null)
proprietàstring RootPath { get; init; }
proprietàstring ExpectedExecutableSha256 { get; init; }

InternetTexturesMode#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreNative = 0
valoreDisabled = 1
valoreOverride = 2

InternetTexturesSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreInternetTexturesSpec(InternetTexturesMode Mode = Native, OptionalValue<string> OverrideProfilePath = default)
proprietàInternetTexturesMode Mode { get; init; }
proprietàOptionalValue<string> OverrideProfilePath { get; init; }

LaunchBehaviorSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreLaunchBehaviorSpec(bool RestoreConfiguration = true, bool SuppressStaleClosecheckWarning = true, int StartupTimeoutSeconds = 180, int ShutdownTimeoutSeconds = 30)
proprietàbool RestoreConfiguration { get; init; }
proprietàbool SuppressStaleClosecheckWarning { get; init; }
proprietàint StartupTimeoutSeconds { get; init; }
proprietàint ShutdownTimeoutSeconds { get; init; }

LaunchDiagnostic#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreLaunchDiagnostic(string Code, string Message, IReadOnlyDictionary<string, string> Data = null)
proprietàstring Code { get; init; }
proprietàstring Message { get; init; }
proprietàIReadOnlyDictionary<string, string> Data { get; init; }

LaunchSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreLaunchSpec(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)
proprietàInstallationSpec Installation { get; init; }
proprietàWorldSpec World { get; init; }
proprietàDateSpec Date { get; init; }
proprietàTimeSpec Time { get; init; }
proprietàOptionalValue<PlayerVehicleSpec> PlayerVehicle { get; init; }
proprietàEnvironmentSpec Environment { get; init; }
proprietàLaunchBehaviorSpec Behavior { get; init; }
proprietàYearSpec Year { get; init; }
proprietàWeatherSpec Weather { get; init; }
proprietàInputSpec Input { get; init; }
proprietàDiagnosticsSpec Diagnostics { get; init; }
proprietàSessionPresentationSpec Presentation { get; init; }
proprietàInternetTexturesSpec InternetTextures { get; init; }
proprietàSessionProfileMetadata SessionProfile { get; init; }
proprietàYearSpec EffectiveYear { get; }
proprietàWeatherSpec EffectiveWeather { get; }
proprietàInputSpec EffectiveInput { get; }
proprietàDiagnosticsSpec EffectiveDiagnostics { get; }
proprietàSessionPresentationSpec EffectivePresentation { get; }
proprietàInternetTexturesSpec EffectiveInternetTextures { get; }

OmsiRuntimeException#

Classe sealed in OmsiLaunch.Api. Stabilità: EXPERIMENTAL. Semantica: public-api.

MembroFirma
costruttoreOmsiRuntimeException(string code, string detail = null)
proprietàstring Code { get; }

OptionalValue#

Record struct in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreOptionalValue(Presence Presence, T Value)
proprietàPresence Presence { get; init; }
proprietàT Value { get; init; }
proprietàbool IsSet { get; }
proprietà staticaOptionalValue<T> Unset { get; }
metodo staticoOptionalValue<T> Set(T value)

PlannedMutation#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttorePlannedMutation(string RelativePath, string SemanticKey, string RequestedValue, string Operation)
proprietàstring RelativePath { get; init; }
proprietàstring SemanticKey { get; init; }
proprietàstring RequestedValue { get; init; }
proprietàstring Operation { get; init; }

PlayerVehicleSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttorePlayerVehicleSpec(OptionalValue<string> Model, OptionalValue<string> Repaint, OptionalValue<string> Hof, OptionalValue<string> FleetNumber, OptionalValue<string> Registration)
proprietàOptionalValue<string> Model { get; init; }
proprietàOptionalValue<string> Repaint { get; init; }
proprietàOptionalValue<string> Hof { get; init; }
proprietàOptionalValue<string> FleetNumber { get; init; }
proprietàOptionalValue<string> Registration { get; init; }
proprietàbool Enabled { get; }

Presence#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreUnset = 0
valoreSet = 1

PublicCapabilityClassification#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: capabilities.

MembroFirma
valorePublicStableBeta = 0
valorePublicExperimental = 1
valoreInternalOnly = 2
valoreUnsupported = 3

PublicCapabilityDescriptor#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: capabilities.

MembroFirma
costruttorePublicCapabilityDescriptor(string Id, string Family, PublicCapabilityClassification Classification, PublicCapabilityKind Kind, bool RequiresSession, bool RequiresExactProfile, string ApiRoute, string CliRoute, string RuntimeValidation, string Description, IReadOnlyList<string> HandleTypes = null)
proprietàstring Id { get; init; }
proprietàstring Family { get; init; }
proprietàPublicCapabilityClassification Classification { get; init; }
proprietàPublicCapabilityKind Kind { get; init; }
proprietàbool RequiresSession { get; init; }
proprietàbool RequiresExactProfile { get; init; }
proprietàstring ApiRoute { get; init; }
proprietàstring CliRoute { get; init; }
proprietàstring RuntimeValidation { get; init; }
proprietàstring Description { get; init; }
proprietàIReadOnlyList<string> HandleTypes { get; init; }

PublicCapabilityKind#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: capabilities.

MembroFirma
valoreRead = 0
valoreWrite = 1
valoreAction = 2
valoreEvent = 3

PublicCapabilityRegistry#

Classe statica in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: capabilities.

MembroFirma
costantestring ProtocolVersion = "0.1"
campo staticoIReadOnlyList<PublicCapabilityDescriptor> All
proprietà staticaIReadOnlyCollection<string> PublicRuntimeOperationIds { get; }
metodo staticoIReadOnlyList<PublicRuntimeArgumentDescriptor> GetRuntimeArguments(string operation)
metodo staticobool IsInternalResultKey(string key)
metodo staticobool IsPublicRuntimeOperation(string operation)
metodo staticoPublicRuntimeArgumentValidation ValidateRuntimeArguments(string operation, IReadOnlyDictionary<string, string> arguments)

PublicErrorCategory#

Classe statica in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: errors.

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

PublicErrorCodes#

Classe statica in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: errors.

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

PublicErrorDescriptor#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: errors.

MembroFirma
costruttorePublicErrorDescriptor(string Code, string Category)
proprietàstring Code { get; init; }
proprietàstring Category { get; init; }

PublicExitCode#

Enumerazione (int) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: exit-codes.

MembroFirma
valoreSuccess = 0
valoreSessionFailed = 1
valoreInvalidArguments = 2
valoreUnsupportedProfile = 3
valoreNoActiveSession = 4
valoreRuntimeUnavailable = 5
valoreNotFound = 6
valoreOperationRejected = 7
valoreTransactionRecoveryFailed = 8
valoreInternalError = 10

PublicRuntimeArgumentDescriptor#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttorePublicRuntimeArgumentDescriptor(string Name, bool Required, string Description)
proprietàstring Name { get; init; }
proprietàbool Required { get; init; }
proprietàstring Description { get; init; }

PublicRuntimeArgumentValidation#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttorePublicRuntimeArgumentValidation(bool Accepted, string ErrorCode = null, string Message = null)
proprietàbool Accepted { get; init; }
proprietàstring ErrorCode { get; init; }
proprietàstring Message { get; init; }

RecoveryStatus#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreRecoveryStatus(bool Pending, bool Recovered, IReadOnlyList<LaunchDiagnostic> Diagnostics)
proprietàbool Pending { get; init; }
proprietàbool Recovered { get; init; }
proprietàIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }

RuntimeCommand#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: runtime-control.

MembroFirma
costruttoreRuntimeCommand(Guid SessionId, ulong RequestId, string Operation, IReadOnlyDictionary<string, string> Arguments = null)
proprietàGuid SessionId { get; init; }
proprietàulong RequestId { get; init; }
proprietàstring Operation { get; init; }
proprietàIReadOnlyDictionary<string, string> Arguments { get; init; }

RuntimeCommandResult#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: runtime-control.

MembroFirma
costruttoreRuntimeCommandResult(Guid SessionId, ulong RequestId, bool Succeeded, string ErrorCode = null, IReadOnlyDictionary<string, string> Values = null)
proprietàGuid SessionId { get; init; }
proprietàulong RequestId { get; init; }
proprietàbool Succeeded { get; init; }
proprietàstring ErrorCode { get; init; }
proprietàIReadOnlyDictionary<string, string> Values { get; init; }

RuntimeCommandWire#

Classe statica in OmsiLaunch.Api. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costanteuint Magic = 1330401859
costanteushort Version = 1
costanteint HeaderSize = 72
metodo staticobyte[] SerializeRequest(RuntimeCommand command)
metodo staticobyte[] SerializeResponse(RuntimeCommandResult result)
metodo staticobool TryDeserializeRequest(ReadOnlySpan<byte> bytes, out RuntimeCommand command)
metodo staticobool TryDeserializeResponse(ReadOnlySpan<byte> bytes, out RuntimeCommandResult result)
metodo staticobool TryReadRequestId(ReadOnlySpan<byte> bytes, out ulong requestId)

RuntimeEvent#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreRuntimeEvent(string Type, DateTimeOffset TimestampUtc, long Sequence, IReadOnlyDictionary<string, string> Data)
proprietàstring Type { get; init; }
proprietàDateTimeOffset TimestampUtc { get; init; }
proprietàlong Sequence { get; init; }
proprietàIReadOnlyDictionary<string, string> Data { get; init; }

RuntimePlatformInfo#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreRuntimePlatformInfo(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)
proprietàstring OsFamily { get; init; }
proprietàstring OsVersion { get; init; }
proprietàstring OsArchitecture { get; init; }
proprietàstring HostArchitecture { get; init; }
proprietàstring OmsiArchitecture { get; init; }
proprietàstring PluginArchitecture { get; init; }
proprietàbool CurrentPlatformSupported { get; init; }
proprietàbool LegacyPlatform { get; init; }
proprietàbool Wow64Available { get; init; }
proprietàbool InstallationWritable { get; init; }
proprietàbool ProcessLaunchSupported { get; init; }
proprietàbool PluginRuntimeSupported { get; init; }
proprietàbool NativeInteropSupported { get; init; }
proprietàbool SharedMemorySupported { get; init; }
proprietàbool ExactRestoreSupported { get; init; }

SemanticDate#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreSemanticDate(int Year, int Month, int Day)
proprietàint Year { get; init; }
proprietàint Month { get; init; }
proprietàint Day { get; init; }

SemanticTime#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreSemanticTime(int Hour, int Minute, int Second)
proprietàint Hour { get; init; }
proprietàint Minute { get; init; }
proprietàint Second { get; init; }

SessionHandle#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreSessionHandle(Guid SessionId)
proprietàGuid SessionId { get; init; }

SessionPlan#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreSessionPlan(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)
proprietàGuid SessionId { get; init; }
proprietàstring BuildProfileId { get; init; }
proprietàLaunchSpec Spec { get; init; }
proprietàRuntimePlatformInfo Platform { get; init; }
proprietàIReadOnlyList<ContentIdentity> ResolvedContent { get; init; }
proprietàIReadOnlyList<string> TouchedFiles { get; init; }
proprietàIReadOnlyList<string> RuntimeArtifacts { get; init; }
proprietàIReadOnlyList<Capability> RequiredCapabilities { get; init; }
proprietàIReadOnlyList<Capability> UnsupportedRequestedFeatures { get; init; }
proprietàIReadOnlyList<PlannedMutation> PlannedMutations { get; init; }
proprietàIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
proprietàbool IsRunnable { get; init; }

SessionPresentationSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreSessionPresentationSpec(SplashMode Splash = Managed, OptionalValue<string> Language = default, OptionalValue<string> CustomAssetDirectory = default, bool SuppressTrayIcon = false)
proprietàSplashMode Splash { get; init; }
proprietàOptionalValue<string> Language { get; init; }
proprietàOptionalValue<string> CustomAssetDirectory { get; init; }
proprietàbool SuppressTrayIcon { get; init; }

SessionProfileMetadata#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreSessionProfileMetadata(string Id, string Name, string Version, string Author, string PresetId, int PresetIndex, string PresetName, string PackagePath)
proprietàstring Id { get; init; }
proprietàstring Name { get; init; }
proprietàstring Version { get; init; }
proprietàstring Author { get; init; }
proprietàstring PresetId { get; init; }
proprietàint PresetIndex { get; init; }
proprietàstring PresetName { get; init; }
proprietàstring PackagePath { get; init; }

SessionState#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
valoreCreated = 0
valoreValidatingPlatform = 1
valorePlanning = 2
valoreAcquiringInstallationLock = 3
valoreRecoveringPreviousTransaction = 4
valoreSnapshotting = 5
valoreApplyingConfiguration = 6
valoreDeployingRuntime = 7
valoreCreatingStartupHandoff = 8
valoreStartingProcess = 9
valoreWaitingForPlugin = 10
valorePluginBootstrap = 11
valoreStartingWorld = 12
valoreEnteringGameplay = 13
valoreRunning = 14
valoreProcessExited = 15
valoreRestoring = 16
valoreCleaningRuntime = 17
valoreCompleted = 18
valoreFailed = 19

SessionStatus#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreSessionStatus(Guid SessionId, SessionState State, IReadOnlyList<LaunchDiagnostic> Diagnostics, IReadOnlyList<RuntimeEvent> RuntimeEvents = null)
proprietàGuid SessionId { get; init; }
proprietàSessionState State { get; init; }
proprietàIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
proprietàIReadOnlyList<RuntimeEvent> RuntimeEvents { get; init; }

SplashMode#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreUnset = 0
valoreNative = 0
valoreManaged = 1

StartupHandoff#

Record sealed in OmsiLaunch.Api. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreStartupHandoff(Guid SessionId, string BuildProfileId, WorldMode WorldMode, string MapIdentity, int PresentedEntrypointIndex, bool HeadlessStart, bool PlayerVehicleEnabled, DateTimeMode DateMode, DateTimeMode TimeMode, string EntrypointIdentity = "", string SituationIdentity = "")
proprietàGuid SessionId { get; init; }
proprietàstring BuildProfileId { get; init; }
proprietàWorldMode WorldMode { get; init; }
proprietàstring MapIdentity { get; init; }
proprietàint PresentedEntrypointIndex { get; init; }
proprietàbool HeadlessStart { get; init; }
proprietàbool PlayerVehicleEnabled { get; init; }
proprietàDateTimeMode DateMode { get; init; }
proprietàDateTimeMode TimeMode { get; init; }
proprietàstring EntrypointIdentity { get; init; }
proprietàstring SituationIdentity { get; init; }

StartupHandoffWire#

Classe statica in OmsiLaunch.Api. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costanteuint Magic = 1330402120
costanteushort Version = 4
metodo staticobyte[] Serialize(StartupHandoff value)
metodo staticobool TryDeserialize(ReadOnlySpan<byte> bytes, out StartupHandoff value)

TimeSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreTimeSpec(DateTimeMode Mode, OptionalValue<SemanticTime> Value)
proprietàDateTimeMode Mode { get; init; }
proprietàOptionalValue<SemanticTime> Value { get; init; }

WeatherMode#

Enumerazione (byte) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreUnset = 0
valorePreset = 1
valoreIcao = 2
valoreRealCurrent = 3

WeatherSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreWeatherSpec(WeatherMode Mode, OptionalValue<string> Preset, OptionalValue<string> Icao)
proprietàWeatherMode Mode { get; init; }
proprietàOptionalValue<string> Preset { get; init; }
proprietàOptionalValue<string> Icao { get; init; }

WorldMode#

Enumerazione (int) in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
valoreNewMap = 0
valoreSavedSituation = 1
valoreLastMapState = 2
valoreLastSituation = 2

WorldSpec#

Record sealed in OmsiLaunch.Api. Stabilità: STABLE_BETA. Semantica: launchspec.

MembroFirma
costruttoreWorldSpec(WorldMode Mode, OptionalValue<string> MapIdentity, OptionalValue<string> SituationIdentity, OptionalValue<int> PresentedEntrypointIndex, OptionalValue<string> EntrypointIdentity = default)
proprietàWorldMode Mode { get; init; }
proprietàOptionalValue<string> MapIdentity { get; init; }
proprietàOptionalValue<string> SituationIdentity { get; init; }
proprietàOptionalValue<int> PresentedEntrypointIndex { get; init; }
proprietàOptionalValue<string> EntrypointIdentity { get; init; }
proprietàEntrypointSpec Entrypoint { get; }

YearSpec#

Record sealed in OmsiLaunch.Api. Stabilità: PARTIAL. Semantica: launchspec.

MembroFirma
costruttoreYearSpec(DateTimeMode Mode, OptionalValue<int> Value)
proprietàDateTimeMode Mode { get; init; }
proprietàOptionalValue<int> Value { get; init; }

OmsiLaunch.Core#

LaunchValidation#

Classe statica in OmsiLaunch.Core. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
metodo staticobool IsMapIdentity(string value)
metodo staticoIReadOnlyList<LaunchDiagnostic> Validate(LaunchSpec spec)

OmsiLaunchRuntimePaths#

Record sealed in OmsiLaunch.Core. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreOmsiLaunchRuntimePaths(string PluginBuildDirectory, string NativeBridgePath, string ReleaseManifestPath = null)
proprietàstring PluginBuildDirectory { get; init; }
proprietàstring NativeBridgePath { get; init; }
proprietàstring ReleaseManifestPath { get; init; }

OmsiLaunchService#

Classe sealed in OmsiLaunch.Core. Stabilità: STABLE_BETA. Semantica: public-api.

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

ProfileNew#

Record sealed in OmsiLaunch.Core. Stabilità: EXPERIMENTAL. Semantica: session-profiles.

MembroFirma
costruttoreProfileNew(string Map = null, int? EntrypointIndex = default, string EntrypointIdentity = null, SemanticDate Date = null, SemanticTime Time = null, int? Year = default, WeatherSpec Weather = null)
proprietàstring Map { get; init; }
proprietàint? EntrypointIndex { get; init; }
proprietàstring EntrypointIdentity { get; init; }
proprietàSemanticDate Date { get; init; }
proprietàSemanticTime Time { get; init; }
proprietàint? Year { get; init; }
proprietàWeatherSpec Weather { get; init; }

ProfilePreset#

Record sealed in OmsiLaunch.Core. Stabilità: EXPERIMENTAL. Semantica: session-profiles.

MembroFirma
costruttoreProfilePreset(int Index, string Id, string Name, IReadOnlyDictionary<string, string> Settings, SessionPresentationSpec Presentation, InternetTexturesSpec InternetTextures, LaunchBehaviorSpec Behavior)
proprietàint Index { get; init; }
proprietàstring Id { get; init; }
proprietàstring Name { get; init; }
proprietàIReadOnlyDictionary<string, string> Settings { get; init; }
proprietàSessionPresentationSpec Presentation { get; init; }
proprietàInternetTexturesSpec InternetTextures { get; init; }
proprietàLaunchBehaviorSpec Behavior { get; init; }

SessionPlanner#

Classe sealed in OmsiLaunch.Core. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreSessionPlanner(IRuntimePlatform platform)
metodoTask<SessionPlan> PlanAsync(LaunchSpec spec, CancellationToken cancellationToken = default)

SessionProfileCompiler#

Classe statica in OmsiLaunch.Core. Stabilità: EXPERIMENTAL. Semantica: session-profiles.

MembroFirma
costantestring Schema = "omsilaunch.session-profile/v1"
costantelong MaxBytes = 262144
campo staticoIReadOnlyDictionary<string, IReadOnlyList<string>> SchemaKeys
metodo staticoLaunchSpec Apply(SessionProfilePackage profile, LaunchSpec baseline, WorldMode selectedWorldMode)
metodo staticoSessionProfilePackage Load(string installationRoot, string id, int presetIndex)
metodo staticovoid ValidateCompatibility(SessionProfilePackage profile, string installationRoot, WorldSpec world, WorldMode mode)

SessionProfileException#

Classe sealed in OmsiLaunch.Core. Stabilità: EXPERIMENTAL. Semantica: session-profiles.

MembroFirma
costruttoreSessionProfileException(string code, string message)
proprietàstring Code { get; }

SessionProfilePackage#

Record sealed in OmsiLaunch.Core. Stabilità: EXPERIMENTAL. Semantica: session-profiles.

MembroFirma
costruttoreSessionProfilePackage(string RootPath, SessionProfileMetadata Metadata, IReadOnlyList<string> CompatibleMaps, ProfileNew New, ProfilePreset Preset)
proprietàstring RootPath { get; init; }
proprietàSessionProfileMetadata Metadata { get; init; }
proprietàIReadOnlyList<string> CompatibleMaps { get; init; }
proprietàProfileNew New { get; init; }
proprietàProfilePreset Preset { get; init; }

OmsiLaunch.Process#

CurrentRuntimeCommandStore#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
proprietàstring Name { get; }
proprietàGuid SessionId { get; }
metodo staticoCurrentRuntimeCommandStore Create(Guid sessionId)
metodovoid Dispose()
metodoTask<RuntimeCommandResult> RequestAsync(RuntimeCommand command, TimeSpan timeout, CancellationToken cancellationToken = default)

CurrentStartupHandoffStore#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
proprietàstring Name { get; }
proprietàGuid SessionId { get; }
metodo staticoCurrentStartupHandoffStore Create(StartupHandoff handoff)
metodovoid Dispose()

CurrentTelemetryStore#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
proprietàstring Name { get; }
metodo staticoCurrentTelemetryStore Create(Guid sessionId)
metodovoid Dispose()
metodoValueTuple<int, string>? ReadLatest()

CurrentWindowsX64Platform#

Classe sealed in OmsiLaunch.Process. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
costruttoreCurrentWindowsX64Platform()
metodoRuntimePlatformInfo Detect(string root)
metodobool HasExited(LaunchedProcess p)
metodobool IsInstallationWritable(string root)
metodoTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
metodovoid Terminate(LaunchedProcess p)
metodovoid ValidateCurrent(RuntimePlatformInfo p)
metodoTask WaitForExitAsync(LaunchedProcess process, CancellationToken token)

IOmsiProcessController#

Interfaccia in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
metodoOmsiProcessState Observe()
metodoTask<int> StartAsync(string installation, CancellationToken cancellationToken = default)
metodoTask StopAsync(CancellationToken cancellationToken = default)

IRuntimePlatform#

Interfaccia in OmsiLaunch.Process. Stabilità: STABLE_BETA. Semantica: public-api.

MembroFirma
metodoRuntimePlatformInfo Detect(string installationRoot)
metodobool HasExited(LaunchedProcess process)
metodobool IsInstallationWritable(string installationRoot)
metodoTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
metodovoid Terminate(LaunchedProcess process)
metodovoid ValidateCurrent(RuntimePlatformInfo platform)
metodoTask WaitForExitAsync(LaunchedProcess process, CancellationToken cancellationToken)

InstallationLease#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
metodo staticoInstallationLease Acquire(string installationRoot)
metodovoid Dispose()
metodo staticostring NormalizeRoot(string installationRoot)

LaunchedProcess#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
proprietàint ProcessId { get; }
proprietàint ThreadId { get; }
proprietàProcessIdentity Identity { get; }
metodovoid Dispose()

OmsiProcessState#

Record sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreOmsiProcessState(string State, int? ProcessId, bool Responding)
proprietàstring State { get; init; }
proprietàint? ProcessId { get; init; }
proprietàbool Responding { get; init; }

ProcessIdentity#

Record sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreProcessIdentity(int ProcessId, DateTimeOffset CreationTimeUtc, string ExecutablePath, string ExecutableSha256)
proprietàint ProcessId { get; init; }
proprietàDateTimeOffset CreationTimeUtc { get; init; }
proprietàstring ExecutablePath { get; init; }
proprietàstring ExecutableSha256 { get; init; }

ReleaseManifest#

Classe statica in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costantestring FileName = "release-manifest.json"
metodo staticoIReadOnlyDictionary<string, string> ParsePluginHashes(byte[] bytes)
metodo staticoIReadOnlyDictionary<string, string> TryReadPluginHashes(string manifestPath)

RuntimeArtifact#

Record sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreRuntimeArtifact(string SourcePath, string DestinationRelativePath, string Sha256, long Size)
proprietàstring SourcePath { get; init; }
proprietàstring DestinationRelativePath { get; init; }
proprietàstring Sha256 { get; init; }
proprietàlong Size { get; init; }

RuntimeArtifactSet#

Classe sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
proprietàIReadOnlyList<RuntimeArtifact> Artifacts { get; }
proprietàIReadOnlyDictionary<string, string> ExpectedHashes { get; }
proprietàstring IntegrityReference { get; }
metodo staticoRuntimeArtifactSet Load(string pluginBuildDirectory, string nativeBuildPath, IReadOnlyDictionary<string, string> expectedHashes = null)
metodovoid ValidateInstalled(string installationRoot)

StartupProcessRequest#

Record sealed in OmsiLaunch.Process. Stabilità: INTERNAL. Semantica: public-api.

MembroFirma
costruttoreStartupProcessRequest(string ExecutablePath, string WorkingDirectory, IReadOnlyDictionary<string, string> Environment)
proprietàstring ExecutablePath { get; init; }
proprietàstring WorkingDirectory { get; init; }
proprietàIReadOnlyDictionary<string, string> Environment { get; init; }