Inventário da API pública

Documentação da versão v0.1.0-beta.3Ver código-fonte no GitHub

Tradução da página original em inglês do OmsiLaunch 0.1.0-beta3. A página em inglês é a referência normativa: em caso de divergência, prevalecem a página em inglês e o código.

Esta página é gerada a partir dos assemblies compilados por tests/OmsiLaunch.DocumentationTests (dotnet run --project tests/OmsiLaunch.DocumentationTests -- --write-inventory); o gate de documentação falha quando deixa de corresponder ao código. Enumera todos os tipos exportados de OmsiLaunch.Api, OmsiLaunch.Core e OmsiLaunch.Process, com a respetiva estabilidade e a assinatura de cada membro público. A semântica, as pré-condições, os erros e os exemplos estão documentados na página indicada em cada título (predefinição: API pública). Vocabulário de estabilidade: STABLE_BETA, EXPERIMENTAL, PARTIAL, INTERNAL (público por razões técnicas, não constitui uma superfície de integração), UNAVAILABLE (consulte API pública). Os membros de record gerados pelo compilador (Equals, GetHashCode, ToString, Deconstruct, <Clone>$, EqualityContract) são omitidos.

OmsiLaunch.Api#

Capability#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorCapability(string Name, bool Available, string EvidenceState, string Reason = null)
propriedadestring Name { get; init; }
propriedadebool Available { get; init; }
propriedadestring EvidenceState { get; init; }
propriedadestring Reason { get; init; }

ContentIdentity#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorContentIdentity(string Identity, string Kind, string DisplayName = null)
propriedadestring Identity { get; init; }
propriedadestring Kind { get; init; }
propriedadestring DisplayName { get; init; }

ContentQueryKind#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
valorMaps = 0
valorSituations = 1
valorVehicles = 2
valorRepaints = 3
valorHofs = 4
valorFleetNumbers = 5
valorRegistrations = 6
valorAddons = 7
valorEntrypoints = 8

D3DDeviceState#

Enum (byte) em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
valorNotReady = 0
valorReady = 1
valorLost = 2
valorResetting = 3
valorStopping = 4
valorStopped = 5

D3DDeviceStatus#

Record selado em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
construtorD3DDeviceStatus(bool Available, D3DDeviceState State, uint Generation, uint LiveTextureCount, bool ResetHookInstalled, uint ExecutionThreadId, uint LastResetThreadId, int QueryInterfaceHResult, int CooperativeLevelHResult, uint OwnedDeviceReferences)
propriedadebool Available { get; init; }
propriedadeD3DDeviceState State { get; init; }
propriedadeuint Generation { get; init; }
propriedadeuint LiveTextureCount { get; init; }
propriedadebool ResetHookInstalled { get; init; }
propriedadeuint ExecutionThreadId { get; init; }
propriedadeuint LastResetThreadId { get; init; }
propriedadeint QueryInterfaceHResult { get; init; }
propriedadeint CooperativeLevelHResult { get; init; }
propriedadeuint OwnedDeviceReferences { get; init; }

D3DRuntimeApi#

Classe estática em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
método de extensãoTask<D3DTextureDescription> CreateD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, uint width, uint height, D3DTextureFormat format, uint levels = 1, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
método de extensãoTask<D3DTextureDescription> DescribeD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, uint level = 0, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
método de extensãoTask<D3DDeviceStatus> GetD3DStatusAsync(this IOmsiLaunch launch, SessionHandle session, TimeSpan timeout, CancellationToken cancellationToken = default)
método de extensãoTask<D3DTextureDescription> ReleaseD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
método de extensãoTask<D3DTextureDescription> UpdateD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, D3DTextureUpdate update, TimeSpan? timeout = default, CancellationToken cancellationToken = default)

D3DTextureDescription#

Record selado em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
construtorD3DTextureDescription(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)
propriedadeD3DTextureHandle Handle { get; init; }
propriedadeD3DTextureResourceState State { get; init; }
propriedadeD3DDeviceState DeviceState { get; init; }
propriedadeuint Generation { get; init; }
propriedadeuint Width { get; init; }
propriedadeuint Height { get; init; }
propriedadeD3DTextureFormat Format { get; init; }
propriedadeuint Levels { get; init; }
propriedadeuint Level { get; init; }
propriedadeuint LevelWidth { get; init; }
propriedadeuint LevelHeight { get; init; }
propriedadeint HResult { get; init; }
propriedadeuint ExecutionThreadId { get; init; }

D3DTextureFormat#

Enum (byte) em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
valorA8R8G8B8 = 0
valorX8R8G8B8 = 1
valorR5G6B5 = 2
valorX1R5G5B5 = 3
valorA1R5G5B5 = 4
valorA4R4G4B4 = 5
valorA8 = 6
valorL8 = 7
valorA8L8 = 8

D3DTextureHandle#

Record selado em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
construtorD3DTextureHandle(string Value)
propriedadestring Value { get; init; }

D3DTextureResourceState#

Enum (byte) em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
valorLive = 0
valorReleased = 1
valorStale = 2

D3DTextureUpdate#

Record selado em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
construtorD3DTextureUpdate(uint Level, uint X, uint Y, uint Width, uint Height, ReadOnlyMemory<byte> Pixels)
propriedadeuint Level { get; init; }
propriedadeuint X { get; init; }
propriedadeuint Y { get; init; }
propriedadeuint Width { get; init; }
propriedadeuint Height { get; init; }
propriedadeReadOnlyMemory<byte> Pixels { get; init; }

DateSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorDateSpec(DateTimeMode Mode, OptionalValue<SemanticDate> Value)
propriedadeDateTimeMode Mode { get; init; }
propriedadeOptionalValue<SemanticDate> Value { get; init; }

DateTimeMode#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorUnset = 0
valorExplicit = 1
valorSystem = 2

DiagnosticsSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorDiagnosticsSpec(bool Log = true, bool Verbose = false, bool OmsiLogAll = false, bool ProcessTrace = false, bool PluginTrace = false, bool NativeTrace = false)
propriedadebool Log { get; init; }
propriedadebool Verbose { get; init; }
propriedadebool OmsiLogAll { get; init; }
propriedadebool ProcessTrace { get; init; }
propriedadebool PluginTrace { get; init; }
propriedadebool NativeTrace { get; init; }

EntrypointMode#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorUnset = 0
valorPresentedIndex = 1
valorIdentity = 2

EntrypointSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorEntrypointSpec(EntrypointMode Mode, OptionalValue<int> PresentedIndex, OptionalValue<string> Identity)
propriedadeEntrypointMode Mode { get; init; }
propriedadeOptionalValue<int> PresentedIndex { get; init; }
propriedadeOptionalValue<string> Identity { get; init; }
propriedade estáticaEntrypointSpec Unset { get; }

EnvironmentSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorEnvironmentSpec(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)
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> General { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> Advanced { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> Graphics { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> AdvancedGraphics { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> Sound { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> AiPassengers { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> Keyboard { get; init; }
propriedadeIReadOnlyDictionary<string, OptionalValue<string>> Controllers { get; init; }

IOmsiLaunch#

Interface em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

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

InputSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorInputSpec(OptionalValue<string> KeyboardDocument, OptionalValue<string> ControllerDocument)
propriedadeOptionalValue<string> KeyboardDocument { get; init; }
propriedadeOptionalValue<string> ControllerDocument { get; init; }

InstallationPaths#

Classe estática em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
método estáticostring IdentityKey(string root)
método estáticostring NormalizeRoot(string root)
método estáticoIReadOnlyList<string> Segments(string relativePath)
método estáticobool TryGetContainedRelativePath(string root, string candidate, out string relativePath)

InstallationSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorInstallationSpec(string RootPath, string ExpectedExecutableSha256 = null)
propriedadestring RootPath { get; init; }
propriedadestring ExpectedExecutableSha256 { get; init; }

InternetTexturesMode#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorNative = 0
valorDisabled = 1
valorOverride = 2

InternetTexturesSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorInternetTexturesSpec(InternetTexturesMode Mode = Native, OptionalValue<string> OverrideProfilePath = default)
propriedadeInternetTexturesMode Mode { get; init; }
propriedadeOptionalValue<string> OverrideProfilePath { get; init; }

LaunchBehaviorSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorLaunchBehaviorSpec(bool RestoreConfiguration = true, bool SuppressStaleClosecheckWarning = true, int StartupTimeoutSeconds = 180, int ShutdownTimeoutSeconds = 30)
propriedadebool RestoreConfiguration { get; init; }
propriedadebool SuppressStaleClosecheckWarning { get; init; }
propriedadeint StartupTimeoutSeconds { get; init; }
propriedadeint ShutdownTimeoutSeconds { get; init; }

LaunchDiagnostic#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorLaunchDiagnostic(string Code, string Message, IReadOnlyDictionary<string, string> Data = null)
propriedadestring Code { get; init; }
propriedadestring Message { get; init; }
propriedadeIReadOnlyDictionary<string, string> Data { get; init; }

LaunchSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorLaunchSpec(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)
propriedadeInstallationSpec Installation { get; init; }
propriedadeWorldSpec World { get; init; }
propriedadeDateSpec Date { get; init; }
propriedadeTimeSpec Time { get; init; }
propriedadeOptionalValue<PlayerVehicleSpec> PlayerVehicle { get; init; }
propriedadeEnvironmentSpec Environment { get; init; }
propriedadeLaunchBehaviorSpec Behavior { get; init; }
propriedadeYearSpec Year { get; init; }
propriedadeWeatherSpec Weather { get; init; }
propriedadeInputSpec Input { get; init; }
propriedadeDiagnosticsSpec Diagnostics { get; init; }
propriedadeSessionPresentationSpec Presentation { get; init; }
propriedadeInternetTexturesSpec InternetTextures { get; init; }
propriedadeSessionProfileMetadata SessionProfile { get; init; }
propriedadeYearSpec EffectiveYear { get; }
propriedadeWeatherSpec EffectiveWeather { get; }
propriedadeInputSpec EffectiveInput { get; }
propriedadeDiagnosticsSpec EffectiveDiagnostics { get; }
propriedadeSessionPresentationSpec EffectivePresentation { get; }
propriedadeInternetTexturesSpec EffectiveInternetTextures { get; }

OmsiRuntimeException#

Classe selada em OmsiLaunch.Api. Estabilidade: EXPERIMENTAL. Semântica: public-api.

MembroAssinatura
construtorOmsiRuntimeException(string code, string detail = null)
propriedadestring Code { get; }

OptionalValue#

Record struct em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorOptionalValue(Presence Presence, T Value)
propriedadePresence Presence { get; init; }
propriedadeT Value { get; init; }
propriedadebool IsSet { get; }
propriedade estáticaOptionalValue<T> Unset { get; }
método estáticoOptionalValue<T> Set(T value)

PlannedMutation#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorPlannedMutation(string RelativePath, string SemanticKey, string RequestedValue, string Operation)
propriedadestring RelativePath { get; init; }
propriedadestring SemanticKey { get; init; }
propriedadestring RequestedValue { get; init; }
propriedadestring Operation { get; init; }

PlayerVehicleSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorPlayerVehicleSpec(OptionalValue<string> Model, OptionalValue<string> Repaint, OptionalValue<string> Hof, OptionalValue<string> FleetNumber, OptionalValue<string> Registration)
propriedadeOptionalValue<string> Model { get; init; }
propriedadeOptionalValue<string> Repaint { get; init; }
propriedadeOptionalValue<string> Hof { get; init; }
propriedadeOptionalValue<string> FleetNumber { get; init; }
propriedadeOptionalValue<string> Registration { get; init; }
propriedadebool Enabled { get; }

Presence#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorUnset = 0
valorSet = 1

PublicCapabilityClassification#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: capabilities.

MembroAssinatura
valorPublicStableBeta = 0
valorPublicExperimental = 1
valorInternalOnly = 2
valorUnsupported = 3

PublicCapabilityDescriptor#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: capabilities.

MembroAssinatura
construtorPublicCapabilityDescriptor(string Id, string Family, PublicCapabilityClassification Classification, PublicCapabilityKind Kind, bool RequiresSession, bool RequiresExactProfile, string ApiRoute, string CliRoute, string RuntimeValidation, string Description, IReadOnlyList<string> HandleTypes = null)
propriedadestring Id { get; init; }
propriedadestring Family { get; init; }
propriedadePublicCapabilityClassification Classification { get; init; }
propriedadePublicCapabilityKind Kind { get; init; }
propriedadebool RequiresSession { get; init; }
propriedadebool RequiresExactProfile { get; init; }
propriedadestring ApiRoute { get; init; }
propriedadestring CliRoute { get; init; }
propriedadestring RuntimeValidation { get; init; }
propriedadestring Description { get; init; }
propriedadeIReadOnlyList<string> HandleTypes { get; init; }

PublicCapabilityKind#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: capabilities.

MembroAssinatura
valorRead = 0
valorWrite = 1
valorAction = 2
valorEvent = 3

PublicCapabilityRegistry#

Classe estática em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: capabilities.

MembroAssinatura
constantestring ProtocolVersion = "0.1"
campo estáticoIReadOnlyList<PublicCapabilityDescriptor> All
propriedade estáticaIReadOnlyCollection<string> PublicRuntimeOperationIds { get; }
método estáticoIReadOnlyList<PublicRuntimeArgumentDescriptor> GetRuntimeArguments(string operation)
método estáticobool IsInternalResultKey(string key)
método estáticobool IsPublicRuntimeOperation(string operation)
método estáticoPublicRuntimeArgumentValidation ValidateRuntimeArguments(string operation, IReadOnlyDictionary<string, string> arguments)

PublicErrorCategory#

Classe estática em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: errors.

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

PublicErrorCodes#

Classe estática em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: errors.

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

PublicErrorDescriptor#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: errors.

MembroAssinatura
construtorPublicErrorDescriptor(string Code, string Category)
propriedadestring Code { get; init; }
propriedadestring Category { get; init; }

PublicExitCode#

Enum (int) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: exit-codes.

MembroAssinatura
valorSuccess = 0
valorSessionFailed = 1
valorInvalidArguments = 2
valorUnsupportedProfile = 3
valorNoActiveSession = 4
valorRuntimeUnavailable = 5
valorNotFound = 6
valorOperationRejected = 7
valorTransactionRecoveryFailed = 8
valorInternalError = 10

PublicRuntimeArgumentDescriptor#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorPublicRuntimeArgumentDescriptor(string Name, bool Required, string Description)
propriedadestring Name { get; init; }
propriedadebool Required { get; init; }
propriedadestring Description { get; init; }

PublicRuntimeArgumentValidation#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorPublicRuntimeArgumentValidation(bool Accepted, string ErrorCode = null, string Message = null)
propriedadebool Accepted { get; init; }
propriedadestring ErrorCode { get; init; }
propriedadestring Message { get; init; }

RecoveryStatus#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorRecoveryStatus(bool Pending, bool Recovered, IReadOnlyList<LaunchDiagnostic> Diagnostics)
propriedadebool Pending { get; init; }
propriedadebool Recovered { get; init; }
propriedadeIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }

RuntimeCommand#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: runtime-control.

MembroAssinatura
construtorRuntimeCommand(Guid SessionId, ulong RequestId, string Operation, IReadOnlyDictionary<string, string> Arguments = null)
propriedadeGuid SessionId { get; init; }
propriedadeulong RequestId { get; init; }
propriedadestring Operation { get; init; }
propriedadeIReadOnlyDictionary<string, string> Arguments { get; init; }

RuntimeCommandResult#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: runtime-control.

MembroAssinatura
construtorRuntimeCommandResult(Guid SessionId, ulong RequestId, bool Succeeded, string ErrorCode = null, IReadOnlyDictionary<string, string> Values = null)
propriedadeGuid SessionId { get; init; }
propriedadeulong RequestId { get; init; }
propriedadebool Succeeded { get; init; }
propriedadestring ErrorCode { get; init; }
propriedadeIReadOnlyDictionary<string, string> Values { get; init; }

RuntimeCommandWire#

Classe estática em OmsiLaunch.Api. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
constanteuint Magic = 1330401859
constanteushort Version = 1
constanteint HeaderSize = 72
método estáticobyte[] SerializeRequest(RuntimeCommand command)
método estáticobyte[] SerializeResponse(RuntimeCommandResult result)
método estáticobool TryDeserializeRequest(ReadOnlySpan<byte> bytes, out RuntimeCommand command)
método estáticobool TryDeserializeResponse(ReadOnlySpan<byte> bytes, out RuntimeCommandResult result)
método estáticobool TryReadRequestId(ReadOnlySpan<byte> bytes, out ulong requestId)

RuntimeEvent#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorRuntimeEvent(string Type, DateTimeOffset TimestampUtc, long Sequence, IReadOnlyDictionary<string, string> Data)
propriedadestring Type { get; init; }
propriedadeDateTimeOffset TimestampUtc { get; init; }
propriedadelong Sequence { get; init; }
propriedadeIReadOnlyDictionary<string, string> Data { get; init; }

RuntimePlatformInfo#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorRuntimePlatformInfo(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)
propriedadestring OsFamily { get; init; }
propriedadestring OsVersion { get; init; }
propriedadestring OsArchitecture { get; init; }
propriedadestring HostArchitecture { get; init; }
propriedadestring OmsiArchitecture { get; init; }
propriedadestring PluginArchitecture { get; init; }
propriedadebool CurrentPlatformSupported { get; init; }
propriedadebool LegacyPlatform { get; init; }
propriedadebool Wow64Available { get; init; }
propriedadebool InstallationWritable { get; init; }
propriedadebool ProcessLaunchSupported { get; init; }
propriedadebool PluginRuntimeSupported { get; init; }
propriedadebool NativeInteropSupported { get; init; }
propriedadebool SharedMemorySupported { get; init; }
propriedadebool ExactRestoreSupported { get; init; }

SemanticDate#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorSemanticDate(int Year, int Month, int Day)
propriedadeint Year { get; init; }
propriedadeint Month { get; init; }
propriedadeint Day { get; init; }

SemanticTime#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorSemanticTime(int Hour, int Minute, int Second)
propriedadeint Hour { get; init; }
propriedadeint Minute { get; init; }
propriedadeint Second { get; init; }

SessionHandle#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorSessionHandle(Guid SessionId)
propriedadeGuid SessionId { get; init; }

SessionPlan#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorSessionPlan(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)
propriedadeGuid SessionId { get; init; }
propriedadestring BuildProfileId { get; init; }
propriedadeLaunchSpec Spec { get; init; }
propriedadeRuntimePlatformInfo Platform { get; init; }
propriedadeIReadOnlyList<ContentIdentity> ResolvedContent { get; init; }
propriedadeIReadOnlyList<string> TouchedFiles { get; init; }
propriedadeIReadOnlyList<string> RuntimeArtifacts { get; init; }
propriedadeIReadOnlyList<Capability> RequiredCapabilities { get; init; }
propriedadeIReadOnlyList<Capability> UnsupportedRequestedFeatures { get; init; }
propriedadeIReadOnlyList<PlannedMutation> PlannedMutations { get; init; }
propriedadeIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
propriedadebool IsRunnable { get; init; }

SessionPresentationSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorSessionPresentationSpec(SplashMode Splash = Managed, OptionalValue<string> Language = default, OptionalValue<string> CustomAssetDirectory = default, bool SuppressTrayIcon = false)
propriedadeSplashMode Splash { get; init; }
propriedadeOptionalValue<string> Language { get; init; }
propriedadeOptionalValue<string> CustomAssetDirectory { get; init; }
propriedadebool SuppressTrayIcon { get; init; }

SessionProfileMetadata#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorSessionProfileMetadata(string Id, string Name, string Version, string Author, string PresetId, int PresetIndex, string PresetName, string PackagePath)
propriedadestring Id { get; init; }
propriedadestring Name { get; init; }
propriedadestring Version { get; init; }
propriedadestring Author { get; init; }
propriedadestring PresetId { get; init; }
propriedadeint PresetIndex { get; init; }
propriedadestring PresetName { get; init; }
propriedadestring PackagePath { get; init; }

SessionState#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
valorCreated = 0
valorValidatingPlatform = 1
valorPlanning = 2
valorAcquiringInstallationLock = 3
valorRecoveringPreviousTransaction = 4
valorSnapshotting = 5
valorApplyingConfiguration = 6
valorDeployingRuntime = 7
valorCreatingStartupHandoff = 8
valorStartingProcess = 9
valorWaitingForPlugin = 10
valorPluginBootstrap = 11
valorStartingWorld = 12
valorEnteringGameplay = 13
valorRunning = 14
valorProcessExited = 15
valorRestoring = 16
valorCleaningRuntime = 17
valorCompleted = 18
valorFailed = 19

SessionStatus#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorSessionStatus(Guid SessionId, SessionState State, IReadOnlyList<LaunchDiagnostic> Diagnostics, IReadOnlyList<RuntimeEvent> RuntimeEvents = null)
propriedadeGuid SessionId { get; init; }
propriedadeSessionState State { get; init; }
propriedadeIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
propriedadeIReadOnlyList<RuntimeEvent> RuntimeEvents { get; init; }

SplashMode#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorUnset = 0
valorNative = 0
valorManaged = 1

StartupHandoff#

Record selado em OmsiLaunch.Api. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorStartupHandoff(Guid SessionId, string BuildProfileId, WorldMode WorldMode, string MapIdentity, int PresentedEntrypointIndex, bool HeadlessStart, bool PlayerVehicleEnabled, DateTimeMode DateMode, DateTimeMode TimeMode, string EntrypointIdentity = "", string SituationIdentity = "")
propriedadeGuid SessionId { get; init; }
propriedadestring BuildProfileId { get; init; }
propriedadeWorldMode WorldMode { get; init; }
propriedadestring MapIdentity { get; init; }
propriedadeint PresentedEntrypointIndex { get; init; }
propriedadebool HeadlessStart { get; init; }
propriedadebool PlayerVehicleEnabled { get; init; }
propriedadeDateTimeMode DateMode { get; init; }
propriedadeDateTimeMode TimeMode { get; init; }
propriedadestring EntrypointIdentity { get; init; }
propriedadestring SituationIdentity { get; init; }

StartupHandoffWire#

Classe estática em OmsiLaunch.Api. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
constanteuint Magic = 1330402120
constanteushort Version = 4
método estáticobyte[] Serialize(StartupHandoff value)
método estáticobool TryDeserialize(ReadOnlySpan<byte> bytes, out StartupHandoff value)

TimeSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorTimeSpec(DateTimeMode Mode, OptionalValue<SemanticTime> Value)
propriedadeDateTimeMode Mode { get; init; }
propriedadeOptionalValue<SemanticTime> Value { get; init; }

WeatherMode#

Enum (byte) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorUnset = 0
valorPreset = 1
valorIcao = 2
valorRealCurrent = 3

WeatherSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorWeatherSpec(WeatherMode Mode, OptionalValue<string> Preset, OptionalValue<string> Icao)
propriedadeWeatherMode Mode { get; init; }
propriedadeOptionalValue<string> Preset { get; init; }
propriedadeOptionalValue<string> Icao { get; init; }

WorldMode#

Enum (int) em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
valorNewMap = 0
valorSavedSituation = 1
valorLastMapState = 2
valorLastSituation = 2

WorldSpec#

Record selado em OmsiLaunch.Api. Estabilidade: STABLE_BETA. Semântica: launchspec.

MembroAssinatura
construtorWorldSpec(WorldMode Mode, OptionalValue<string> MapIdentity, OptionalValue<string> SituationIdentity, OptionalValue<int> PresentedEntrypointIndex, OptionalValue<string> EntrypointIdentity = default)
propriedadeWorldMode Mode { get; init; }
propriedadeOptionalValue<string> MapIdentity { get; init; }
propriedadeOptionalValue<string> SituationIdentity { get; init; }
propriedadeOptionalValue<int> PresentedEntrypointIndex { get; init; }
propriedadeOptionalValue<string> EntrypointIdentity { get; init; }
propriedadeEntrypointSpec Entrypoint { get; }

YearSpec#

Record selado em OmsiLaunch.Api. Estabilidade: PARTIAL. Semântica: launchspec.

MembroAssinatura
construtorYearSpec(DateTimeMode Mode, OptionalValue<int> Value)
propriedadeDateTimeMode Mode { get; init; }
propriedadeOptionalValue<int> Value { get; init; }

OmsiLaunch.Core#

LaunchValidation#

Classe estática em OmsiLaunch.Core. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
método estáticobool IsMapIdentity(string value)
método estáticoIReadOnlyList<LaunchDiagnostic> Validate(LaunchSpec spec)

OmsiLaunchRuntimePaths#

Record selado em OmsiLaunch.Core. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorOmsiLaunchRuntimePaths(string PluginBuildDirectory, string NativeBridgePath, string ReleaseManifestPath = null)
propriedadestring PluginBuildDirectory { get; init; }
propriedadestring NativeBridgePath { get; init; }
propriedadestring ReleaseManifestPath { get; init; }

OmsiLaunchService#

Classe selada em OmsiLaunch.Core. Estabilidade: STABLE_BETA. Semântica: public-api.

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

ProfileNew#

Record selado em OmsiLaunch.Core. Estabilidade: EXPERIMENTAL. Semântica: session-profiles.

MembroAssinatura
construtorProfileNew(string Map = null, int? EntrypointIndex = default, string EntrypointIdentity = null, SemanticDate Date = null, SemanticTime Time = null, int? Year = default, WeatherSpec Weather = null)
propriedadestring Map { get; init; }
propriedadeint? EntrypointIndex { get; init; }
propriedadestring EntrypointIdentity { get; init; }
propriedadeSemanticDate Date { get; init; }
propriedadeSemanticTime Time { get; init; }
propriedadeint? Year { get; init; }
propriedadeWeatherSpec Weather { get; init; }

ProfilePreset#

Record selado em OmsiLaunch.Core. Estabilidade: EXPERIMENTAL. Semântica: session-profiles.

MembroAssinatura
construtorProfilePreset(int Index, string Id, string Name, IReadOnlyDictionary<string, string> Settings, SessionPresentationSpec Presentation, InternetTexturesSpec InternetTextures, LaunchBehaviorSpec Behavior)
propriedadeint Index { get; init; }
propriedadestring Id { get; init; }
propriedadestring Name { get; init; }
propriedadeIReadOnlyDictionary<string, string> Settings { get; init; }
propriedadeSessionPresentationSpec Presentation { get; init; }
propriedadeInternetTexturesSpec InternetTextures { get; init; }
propriedadeLaunchBehaviorSpec Behavior { get; init; }

SessionPlanner#

Classe selada em OmsiLaunch.Core. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorSessionPlanner(IRuntimePlatform platform)
métodoTask<SessionPlan> PlanAsync(LaunchSpec spec, CancellationToken cancellationToken = default)

SessionProfileCompiler#

Classe estática em OmsiLaunch.Core. Estabilidade: EXPERIMENTAL. Semântica: session-profiles.

MembroAssinatura
constantestring Schema = "omsilaunch.session-profile/v1"
constantelong MaxBytes = 262144
campo estáticoIReadOnlyDictionary<string, IReadOnlyList<string>> SchemaKeys
método estáticoLaunchSpec Apply(SessionProfilePackage profile, LaunchSpec baseline, WorldMode selectedWorldMode)
método estáticoSessionProfilePackage Load(string installationRoot, string id, int presetIndex)
método estáticovoid ValidateCompatibility(SessionProfilePackage profile, string installationRoot, WorldSpec world, WorldMode mode)

SessionProfileException#

Classe selada em OmsiLaunch.Core. Estabilidade: EXPERIMENTAL. Semântica: session-profiles.

MembroAssinatura
construtorSessionProfileException(string code, string message)
propriedadestring Code { get; }

SessionProfilePackage#

Record selado em OmsiLaunch.Core. Estabilidade: EXPERIMENTAL. Semântica: session-profiles.

MembroAssinatura
construtorSessionProfilePackage(string RootPath, SessionProfileMetadata Metadata, IReadOnlyList<string> CompatibleMaps, ProfileNew New, ProfilePreset Preset)
propriedadestring RootPath { get; init; }
propriedadeSessionProfileMetadata Metadata { get; init; }
propriedadeIReadOnlyList<string> CompatibleMaps { get; init; }
propriedadeProfileNew New { get; init; }
propriedadeProfilePreset Preset { get; init; }

OmsiLaunch.Process#

CurrentRuntimeCommandStore#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
propriedadestring Name { get; }
propriedadeGuid SessionId { get; }
método estáticoCurrentRuntimeCommandStore Create(Guid sessionId)
métodovoid Dispose()
métodoTask<RuntimeCommandResult> RequestAsync(RuntimeCommand command, TimeSpan timeout, CancellationToken cancellationToken = default)

CurrentStartupHandoffStore#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
propriedadestring Name { get; }
propriedadeGuid SessionId { get; }
método estáticoCurrentStartupHandoffStore Create(StartupHandoff handoff)
métodovoid Dispose()

CurrentTelemetryStore#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
propriedadestring Name { get; }
método estáticoCurrentTelemetryStore Create(Guid sessionId)
métodovoid Dispose()
métodoValueTuple<int, string>? ReadLatest()

CurrentWindowsX64Platform#

Classe selada em OmsiLaunch.Process. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
construtorCurrentWindowsX64Platform()
métodoRuntimePlatformInfo Detect(string root)
métodobool HasExited(LaunchedProcess p)
métodobool IsInstallationWritable(string root)
métodoTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
métodovoid Terminate(LaunchedProcess p)
métodovoid ValidateCurrent(RuntimePlatformInfo p)
métodoTask WaitForExitAsync(LaunchedProcess process, CancellationToken token)

IOmsiProcessController#

Interface em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
métodoOmsiProcessState Observe()
métodoTask<int> StartAsync(string installation, CancellationToken cancellationToken = default)
métodoTask StopAsync(CancellationToken cancellationToken = default)

IRuntimePlatform#

Interface em OmsiLaunch.Process. Estabilidade: STABLE_BETA. Semântica: public-api.

MembroAssinatura
métodoRuntimePlatformInfo Detect(string installationRoot)
métodobool HasExited(LaunchedProcess process)
métodobool IsInstallationWritable(string installationRoot)
métodoTask<LaunchedProcess> StartAsync(StartupProcessRequest request, string executableSha256, CancellationToken cancellationToken)
métodovoid Terminate(LaunchedProcess process)
métodovoid ValidateCurrent(RuntimePlatformInfo platform)
métodoTask WaitForExitAsync(LaunchedProcess process, CancellationToken cancellationToken)

InstallationLease#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
método estáticoInstallationLease Acquire(string installationRoot)
métodovoid Dispose()
método estáticostring NormalizeRoot(string installationRoot)

LaunchedProcess#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
propriedadeint ProcessId { get; }
propriedadeint ThreadId { get; }
propriedadeProcessIdentity Identity { get; }
métodovoid Dispose()

OmsiProcessState#

Record selado em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorOmsiProcessState(string State, int? ProcessId, bool Responding)
propriedadestring State { get; init; }
propriedadeint? ProcessId { get; init; }
propriedadebool Responding { get; init; }

ProcessIdentity#

Record selado em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorProcessIdentity(int ProcessId, DateTimeOffset CreationTimeUtc, string ExecutablePath, string ExecutableSha256)
propriedadeint ProcessId { get; init; }
propriedadeDateTimeOffset CreationTimeUtc { get; init; }
propriedadestring ExecutablePath { get; init; }
propriedadestring ExecutableSha256 { get; init; }

ReleaseManifest#

Classe estática em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
constantestring FileName = "release-manifest.json"
método estáticoIReadOnlyDictionary<string, string> ParsePluginHashes(byte[] bytes)
método estáticoIReadOnlyDictionary<string, string> TryReadPluginHashes(string manifestPath)

RuntimeArtifact#

Record selado em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorRuntimeArtifact(string SourcePath, string DestinationRelativePath, string Sha256, long Size)
propriedadestring SourcePath { get; init; }
propriedadestring DestinationRelativePath { get; init; }
propriedadestring Sha256 { get; init; }
propriedadelong Size { get; init; }

RuntimeArtifactSet#

Classe selada em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
propriedadeIReadOnlyList<RuntimeArtifact> Artifacts { get; }
propriedadeIReadOnlyDictionary<string, string> ExpectedHashes { get; }
propriedadestring IntegrityReference { get; }
método estáticoRuntimeArtifactSet Load(string pluginBuildDirectory, string nativeBuildPath, IReadOnlyDictionary<string, string> expectedHashes = null)
métodovoid ValidateInstalled(string installationRoot)

StartupProcessRequest#

Record selado em OmsiLaunch.Process. Estabilidade: INTERNAL. Semântica: public-api.

MembroAssinatura
construtorStartupProcessRequest(string ExecutablePath, string WorkingDirectory, IReadOnlyDictionary<string, string> Environment)
propriedadestring ExecutablePath { get; init; }
propriedadestring WorkingDirectory { get; init; }
propriedadeIReadOnlyDictionary<string, string> Environment { get; init; }