Inventario de la API pública

Documentación de la versión v0.1.0-beta.3Ver fuente en GitHub

Traducción de la página original en inglés de OmsiLaunch 0.1.0-beta3. La página en inglés es la referencia normativa: si difieren, prevalecen la página en inglés y el código.

Esta página se genera a partir de los ensamblados compilados mediante tests/OmsiLaunch.DocumentationTests (dotnet run --project tests/OmsiLaunch.DocumentationTests -- --write-inventory); la comprobación de la documentación falla cuando deja de coincidir con el código. Enumera cada tipo exportado de OmsiLaunch.Api, OmsiLaunch.Core y OmsiLaunch.Process, con su estabilidad y la firma de cada miembro público. La semántica, las precondiciones, los errores y los ejemplos se documentan en la página indicada en cada encabezado (por defecto: API pública). Vocabulario de estabilidad: STABLE_BETA, EXPERIMENTAL, PARTIAL, INTERNAL (público por motivos técnicos, no es una superficie de integración), UNAVAILABLE (véase API pública). Se omiten los miembros de record generados por el compilador (Equals, GetHashCode, ToString, Deconstruct, <Clone>$, EqualityContract).

OmsiLaunch.Api#

Capability#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorCapability(string Name, bool Available, string EvidenceState, string Reason = null)
propiedadstring Name { get; init; }
propiedadbool Available { get; init; }
propiedadstring EvidenceState { get; init; }
propiedadstring Reason { get; init; }

ContentIdentity#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorContentIdentity(string Identity, string Kind, string DisplayName = null)
propiedadstring Identity { get; init; }
propiedadstring Kind { get; init; }
propiedadstring DisplayName { get; init; }

ContentQueryKind#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

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

D3DDeviceState#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

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

D3DDeviceStatus#

Record sellado en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
constructorD3DDeviceStatus(bool Available, D3DDeviceState State, uint Generation, uint LiveTextureCount, bool ResetHookInstalled, uint ExecutionThreadId, uint LastResetThreadId, int QueryInterfaceHResult, int CooperativeLevelHResult, uint OwnedDeviceReferences)
propiedadbool Available { get; init; }
propiedadD3DDeviceState State { get; init; }
propiedaduint Generation { get; init; }
propiedaduint LiveTextureCount { get; init; }
propiedadbool ResetHookInstalled { get; init; }
propiedaduint ExecutionThreadId { get; init; }
propiedaduint LastResetThreadId { get; init; }
propiedadint QueryInterfaceHResult { get; init; }
propiedadint CooperativeLevelHResult { get; init; }
propiedaduint OwnedDeviceReferences { get; init; }

D3DRuntimeApi#

Clase estática en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
método de extensiónTask<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 extensiónTask<D3DTextureDescription> DescribeD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, uint level = 0, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
método de extensiónTask<D3DDeviceStatus> GetD3DStatusAsync(this IOmsiLaunch launch, SessionHandle session, TimeSpan timeout, CancellationToken cancellationToken = default)
método de extensiónTask<D3DTextureDescription> ReleaseD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, TimeSpan? timeout = default, CancellationToken cancellationToken = default)
método de extensiónTask<D3DTextureDescription> UpdateD3DTextureAsync(this IOmsiLaunch launch, SessionHandle session, D3DTextureHandle handle, D3DTextureUpdate update, TimeSpan? timeout = default, CancellationToken cancellationToken = default)

D3DTextureDescription#

Record sellado en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
constructorD3DTextureDescription(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)
propiedadD3DTextureHandle Handle { get; init; }
propiedadD3DTextureResourceState State { get; init; }
propiedadD3DDeviceState DeviceState { get; init; }
propiedaduint Generation { get; init; }
propiedaduint Width { get; init; }
propiedaduint Height { get; init; }
propiedadD3DTextureFormat Format { get; init; }
propiedaduint Levels { get; init; }
propiedaduint Level { get; init; }
propiedaduint LevelWidth { get; init; }
propiedaduint LevelHeight { get; init; }
propiedadint HResult { get; init; }
propiedaduint ExecutionThreadId { get; init; }

D3DTextureFormat#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

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

D3DTextureHandle#

Record sellado en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
constructorD3DTextureHandle(string Value)
propiedadstring Value { get; init; }

D3DTextureResourceState#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
valorLive = 0
valorReleased = 1
valorStale = 2

D3DTextureUpdate#

Record sellado en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
constructorD3DTextureUpdate(uint Level, uint X, uint Y, uint Width, uint Height, ReadOnlyMemory<byte> Pixels)
propiedaduint Level { get; init; }
propiedaduint X { get; init; }
propiedaduint Y { get; init; }
propiedaduint Width { get; init; }
propiedaduint Height { get; init; }
propiedadReadOnlyMemory<byte> Pixels { get; init; }

DateSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorDateSpec(DateTimeMode Mode, OptionalValue<SemanticDate> Value)
propiedadDateTimeMode Mode { get; init; }
propiedadOptionalValue<SemanticDate> Value { get; init; }

DateTimeMode#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
valorUnset = 0
valorExplicit = 1
valorSystem = 2

DiagnosticsSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorDiagnosticsSpec(bool Log = true, bool Verbose = false, bool OmsiLogAll = false, bool ProcessTrace = false, bool PluginTrace = false, bool NativeTrace = false)
propiedadbool Log { get; init; }
propiedadbool Verbose { get; init; }
propiedadbool OmsiLogAll { get; init; }
propiedadbool ProcessTrace { get; init; }
propiedadbool PluginTrace { get; init; }
propiedadbool NativeTrace { get; init; }

EntrypointMode#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
valorUnset = 0
valorPresentedIndex = 1
valorIdentity = 2

EntrypointSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorEntrypointSpec(EntrypointMode Mode, OptionalValue<int> PresentedIndex, OptionalValue<string> Identity)
propiedadEntrypointMode Mode { get; init; }
propiedadOptionalValue<int> PresentedIndex { get; init; }
propiedadOptionalValue<string> Identity { get; init; }
propiedad estáticaEntrypointSpec Unset { get; }

EnvironmentSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

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

IOmsiLaunch#

Interfaz en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorInputSpec(OptionalValue<string> KeyboardDocument, OptionalValue<string> ControllerDocument)
propiedadOptionalValue<string> KeyboardDocument { get; init; }
propiedadOptionalValue<string> ControllerDocument { get; init; }

InstallationPaths#

Clase estática en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorInstallationSpec(string RootPath, string ExpectedExecutableSha256 = null)
propiedadstring RootPath { get; init; }
propiedadstring ExpectedExecutableSha256 { get; init; }

InternetTexturesMode#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
valorNative = 0
valorDisabled = 1
valorOverride = 2

InternetTexturesSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorInternetTexturesSpec(InternetTexturesMode Mode = Native, OptionalValue<string> OverrideProfilePath = default)
propiedadInternetTexturesMode Mode { get; init; }
propiedadOptionalValue<string> OverrideProfilePath { get; init; }

LaunchBehaviorSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorLaunchBehaviorSpec(bool RestoreConfiguration = true, bool SuppressStaleClosecheckWarning = true, int StartupTimeoutSeconds = 180, int ShutdownTimeoutSeconds = 30)
propiedadbool RestoreConfiguration { get; init; }
propiedadbool SuppressStaleClosecheckWarning { get; init; }
propiedadint StartupTimeoutSeconds { get; init; }
propiedadint ShutdownTimeoutSeconds { get; init; }

LaunchDiagnostic#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorLaunchDiagnostic(string Code, string Message, IReadOnlyDictionary<string, string> Data = null)
propiedadstring Code { get; init; }
propiedadstring Message { get; init; }
propiedadIReadOnlyDictionary<string, string> Data { get; init; }

LaunchSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorLaunchSpec(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)
propiedadInstallationSpec Installation { get; init; }
propiedadWorldSpec World { get; init; }
propiedadDateSpec Date { get; init; }
propiedadTimeSpec Time { get; init; }
propiedadOptionalValue<PlayerVehicleSpec> PlayerVehicle { get; init; }
propiedadEnvironmentSpec Environment { get; init; }
propiedadLaunchBehaviorSpec Behavior { get; init; }
propiedadYearSpec Year { get; init; }
propiedadWeatherSpec Weather { get; init; }
propiedadInputSpec Input { get; init; }
propiedadDiagnosticsSpec Diagnostics { get; init; }
propiedadSessionPresentationSpec Presentation { get; init; }
propiedadInternetTexturesSpec InternetTextures { get; init; }
propiedadSessionProfileMetadata SessionProfile { get; init; }
propiedadYearSpec EffectiveYear { get; }
propiedadWeatherSpec EffectiveWeather { get; }
propiedadInputSpec EffectiveInput { get; }
propiedadDiagnosticsSpec EffectiveDiagnostics { get; }
propiedadSessionPresentationSpec EffectivePresentation { get; }
propiedadInternetTexturesSpec EffectiveInternetTextures { get; }

OmsiRuntimeException#

Clase sellada en OmsiLaunch.Api. Estabilidad: EXPERIMENTAL. Semántica: public-api.

MiembroFirma
constructorOmsiRuntimeException(string code, string detail = null)
propiedadstring Code { get; }

OptionalValue#

Record struct en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorOptionalValue(Presence Presence, T Value)
propiedadPresence Presence { get; init; }
propiedadT Value { get; init; }
propiedadbool IsSet { get; }
propiedad estáticaOptionalValue<T> Unset { get; }
método estáticoOptionalValue<T> Set(T value)

PlannedMutation#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorPlannedMutation(string RelativePath, string SemanticKey, string RequestedValue, string Operation)
propiedadstring RelativePath { get; init; }
propiedadstring SemanticKey { get; init; }
propiedadstring RequestedValue { get; init; }
propiedadstring Operation { get; init; }

PlayerVehicleSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorPlayerVehicleSpec(OptionalValue<string> Model, OptionalValue<string> Repaint, OptionalValue<string> Hof, OptionalValue<string> FleetNumber, OptionalValue<string> Registration)
propiedadOptionalValue<string> Model { get; init; }
propiedadOptionalValue<string> Repaint { get; init; }
propiedadOptionalValue<string> Hof { get; init; }
propiedadOptionalValue<string> FleetNumber { get; init; }
propiedadOptionalValue<string> Registration { get; init; }
propiedadbool Enabled { get; }

Presence#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
valorUnset = 0
valorSet = 1

PublicCapabilityClassification#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: capabilities.

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

PublicCapabilityDescriptor#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: capabilities.

MiembroFirma
constructorPublicCapabilityDescriptor(string Id, string Family, PublicCapabilityClassification Classification, PublicCapabilityKind Kind, bool RequiresSession, bool RequiresExactProfile, string ApiRoute, string CliRoute, string RuntimeValidation, string Description, IReadOnlyList<string> HandleTypes = null)
propiedadstring Id { get; init; }
propiedadstring Family { get; init; }
propiedadPublicCapabilityClassification Classification { get; init; }
propiedadPublicCapabilityKind Kind { get; init; }
propiedadbool RequiresSession { get; init; }
propiedadbool RequiresExactProfile { get; init; }
propiedadstring ApiRoute { get; init; }
propiedadstring CliRoute { get; init; }
propiedadstring RuntimeValidation { get; init; }
propiedadstring Description { get; init; }
propiedadIReadOnlyList<string> HandleTypes { get; init; }

PublicCapabilityKind#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: capabilities.

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

PublicCapabilityRegistry#

Clase estática en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: capabilities.

MiembroFirma
constantestring ProtocolVersion = "0.1"
campo estáticoIReadOnlyList<PublicCapabilityDescriptor> All
propiedad 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#

Clase estática en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: errors.

MiembroFirma
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#

Clase estática en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: errors.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: errors.

MiembroFirma
constructorPublicErrorDescriptor(string Code, string Category)
propiedadstring Code { get; init; }
propiedadstring Category { get; init; }

PublicExitCode#

Enumeración (int) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: exit-codes.

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

PublicRuntimeArgumentDescriptor#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorPublicRuntimeArgumentDescriptor(string Name, bool Required, string Description)
propiedadstring Name { get; init; }
propiedadbool Required { get; init; }
propiedadstring Description { get; init; }

PublicRuntimeArgumentValidation#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorPublicRuntimeArgumentValidation(bool Accepted, string ErrorCode = null, string Message = null)
propiedadbool Accepted { get; init; }
propiedadstring ErrorCode { get; init; }
propiedadstring Message { get; init; }

RecoveryStatus#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorRecoveryStatus(bool Pending, bool Recovered, IReadOnlyList<LaunchDiagnostic> Diagnostics)
propiedadbool Pending { get; init; }
propiedadbool Recovered { get; init; }
propiedadIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }

RuntimeCommand#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: runtime-control.

MiembroFirma
constructorRuntimeCommand(Guid SessionId, ulong RequestId, string Operation, IReadOnlyDictionary<string, string> Arguments = null)
propiedadGuid SessionId { get; init; }
propiedadulong RequestId { get; init; }
propiedadstring Operation { get; init; }
propiedadIReadOnlyDictionary<string, string> Arguments { get; init; }

RuntimeCommandResult#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: runtime-control.

MiembroFirma
constructorRuntimeCommandResult(Guid SessionId, ulong RequestId, bool Succeeded, string ErrorCode = null, IReadOnlyDictionary<string, string> Values = null)
propiedadGuid SessionId { get; init; }
propiedadulong RequestId { get; init; }
propiedadbool Succeeded { get; init; }
propiedadstring ErrorCode { get; init; }
propiedadIReadOnlyDictionary<string, string> Values { get; init; }

RuntimeCommandWire#

Clase estática en OmsiLaunch.Api. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorRuntimeEvent(string Type, DateTimeOffset TimestampUtc, long Sequence, IReadOnlyDictionary<string, string> Data)
propiedadstring Type { get; init; }
propiedadDateTimeOffset TimestampUtc { get; init; }
propiedadlong Sequence { get; init; }
propiedadIReadOnlyDictionary<string, string> Data { get; init; }

RuntimePlatformInfo#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorRuntimePlatformInfo(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)
propiedadstring OsFamily { get; init; }
propiedadstring OsVersion { get; init; }
propiedadstring OsArchitecture { get; init; }
propiedadstring HostArchitecture { get; init; }
propiedadstring OmsiArchitecture { get; init; }
propiedadstring PluginArchitecture { get; init; }
propiedadbool CurrentPlatformSupported { get; init; }
propiedadbool LegacyPlatform { get; init; }
propiedadbool Wow64Available { get; init; }
propiedadbool InstallationWritable { get; init; }
propiedadbool ProcessLaunchSupported { get; init; }
propiedadbool PluginRuntimeSupported { get; init; }
propiedadbool NativeInteropSupported { get; init; }
propiedadbool SharedMemorySupported { get; init; }
propiedadbool ExactRestoreSupported { get; init; }

SemanticDate#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorSemanticDate(int Year, int Month, int Day)
propiedadint Year { get; init; }
propiedadint Month { get; init; }
propiedadint Day { get; init; }

SemanticTime#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorSemanticTime(int Hour, int Minute, int Second)
propiedadint Hour { get; init; }
propiedadint Minute { get; init; }
propiedadint Second { get; init; }

SessionHandle#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorSessionHandle(Guid SessionId)
propiedadGuid SessionId { get; init; }

SessionPlan#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorSessionPlan(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)
propiedadGuid SessionId { get; init; }
propiedadstring BuildProfileId { get; init; }
propiedadLaunchSpec Spec { get; init; }
propiedadRuntimePlatformInfo Platform { get; init; }
propiedadIReadOnlyList<ContentIdentity> ResolvedContent { get; init; }
propiedadIReadOnlyList<string> TouchedFiles { get; init; }
propiedadIReadOnlyList<string> RuntimeArtifacts { get; init; }
propiedadIReadOnlyList<Capability> RequiredCapabilities { get; init; }
propiedadIReadOnlyList<Capability> UnsupportedRequestedFeatures { get; init; }
propiedadIReadOnlyList<PlannedMutation> PlannedMutations { get; init; }
propiedadIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
propiedadbool IsRunnable { get; init; }

SessionPresentationSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorSessionPresentationSpec(SplashMode Splash = Managed, OptionalValue<string> Language = default, OptionalValue<string> CustomAssetDirectory = default, bool SuppressTrayIcon = false)
propiedadSplashMode Splash { get; init; }
propiedadOptionalValue<string> Language { get; init; }
propiedadOptionalValue<string> CustomAssetDirectory { get; init; }
propiedadbool SuppressTrayIcon { get; init; }

SessionProfileMetadata#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorSessionProfileMetadata(string Id, string Name, string Version, string Author, string PresetId, int PresetIndex, string PresetName, string PackagePath)
propiedadstring Id { get; init; }
propiedadstring Name { get; init; }
propiedadstring Version { get; init; }
propiedadstring Author { get; init; }
propiedadstring PresetId { get; init; }
propiedadint PresetIndex { get; init; }
propiedadstring PresetName { get; init; }
propiedadstring PackagePath { get; init; }

SessionState#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorSessionStatus(Guid SessionId, SessionState State, IReadOnlyList<LaunchDiagnostic> Diagnostics, IReadOnlyList<RuntimeEvent> RuntimeEvents = null)
propiedadGuid SessionId { get; init; }
propiedadSessionState State { get; init; }
propiedadIReadOnlyList<LaunchDiagnostic> Diagnostics { get; init; }
propiedadIReadOnlyList<RuntimeEvent> RuntimeEvents { get; init; }

SplashMode#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
valorUnset = 0
valorNative = 0
valorManaged = 1

StartupHandoff#

Record sellado en OmsiLaunch.Api. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
constructorStartupHandoff(Guid SessionId, string BuildProfileId, WorldMode WorldMode, string MapIdentity, int PresentedEntrypointIndex, bool HeadlessStart, bool PlayerVehicleEnabled, DateTimeMode DateMode, DateTimeMode TimeMode, string EntrypointIdentity = "", string SituationIdentity = "")
propiedadGuid SessionId { get; init; }
propiedadstring BuildProfileId { get; init; }
propiedadWorldMode WorldMode { get; init; }
propiedadstring MapIdentity { get; init; }
propiedadint PresentedEntrypointIndex { get; init; }
propiedadbool HeadlessStart { get; init; }
propiedadbool PlayerVehicleEnabled { get; init; }
propiedadDateTimeMode DateMode { get; init; }
propiedadDateTimeMode TimeMode { get; init; }
propiedadstring EntrypointIdentity { get; init; }
propiedadstring SituationIdentity { get; init; }

StartupHandoffWire#

Clase estática en OmsiLaunch.Api. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorTimeSpec(DateTimeMode Mode, OptionalValue<SemanticTime> Value)
propiedadDateTimeMode Mode { get; init; }
propiedadOptionalValue<SemanticTime> Value { get; init; }

WeatherMode#

Enumeración (byte) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

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

WeatherSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorWeatherSpec(WeatherMode Mode, OptionalValue<string> Preset, OptionalValue<string> Icao)
propiedadWeatherMode Mode { get; init; }
propiedadOptionalValue<string> Preset { get; init; }
propiedadOptionalValue<string> Icao { get; init; }

WorldMode#

Enumeración (int) en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

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

WorldSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: STABLE_BETA. Semántica: launchspec.

MiembroFirma
constructorWorldSpec(WorldMode Mode, OptionalValue<string> MapIdentity, OptionalValue<string> SituationIdentity, OptionalValue<int> PresentedEntrypointIndex, OptionalValue<string> EntrypointIdentity = default)
propiedadWorldMode Mode { get; init; }
propiedadOptionalValue<string> MapIdentity { get; init; }
propiedadOptionalValue<string> SituationIdentity { get; init; }
propiedadOptionalValue<int> PresentedEntrypointIndex { get; init; }
propiedadOptionalValue<string> EntrypointIdentity { get; init; }
propiedadEntrypointSpec Entrypoint { get; }

YearSpec#

Record sellado en OmsiLaunch.Api. Estabilidad: PARTIAL. Semántica: launchspec.

MiembroFirma
constructorYearSpec(DateTimeMode Mode, OptionalValue<int> Value)
propiedadDateTimeMode Mode { get; init; }
propiedadOptionalValue<int> Value { get; init; }

OmsiLaunch.Core#

LaunchValidation#

Clase estática en OmsiLaunch.Core. Estabilidad: INTERNAL. Semántica: public-api.

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

OmsiLaunchRuntimePaths#

Record sellado en OmsiLaunch.Core. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorOmsiLaunchRuntimePaths(string PluginBuildDirectory, string NativeBridgePath, string ReleaseManifestPath = null)
propiedadstring PluginBuildDirectory { get; init; }
propiedadstring NativeBridgePath { get; init; }
propiedadstring ReleaseManifestPath { get; init; }

OmsiLaunchService#

Clase sellada en OmsiLaunch.Core. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorOmsiLaunchService(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 sellado en OmsiLaunch.Core. Estabilidad: EXPERIMENTAL. Semántica: session-profiles.

MiembroFirma
constructorProfileNew(string Map = null, int? EntrypointIndex = default, string EntrypointIdentity = null, SemanticDate Date = null, SemanticTime Time = null, int? Year = default, WeatherSpec Weather = null)
propiedadstring Map { get; init; }
propiedadint? EntrypointIndex { get; init; }
propiedadstring EntrypointIdentity { get; init; }
propiedadSemanticDate Date { get; init; }
propiedadSemanticTime Time { get; init; }
propiedadint? Year { get; init; }
propiedadWeatherSpec Weather { get; init; }

ProfilePreset#

Record sellado en OmsiLaunch.Core. Estabilidad: EXPERIMENTAL. Semántica: session-profiles.

MiembroFirma
constructorProfilePreset(int Index, string Id, string Name, IReadOnlyDictionary<string, string> Settings, SessionPresentationSpec Presentation, InternetTexturesSpec InternetTextures, LaunchBehaviorSpec Behavior)
propiedadint Index { get; init; }
propiedadstring Id { get; init; }
propiedadstring Name { get; init; }
propiedadIReadOnlyDictionary<string, string> Settings { get; init; }
propiedadSessionPresentationSpec Presentation { get; init; }
propiedadInternetTexturesSpec InternetTextures { get; init; }
propiedadLaunchBehaviorSpec Behavior { get; init; }

SessionPlanner#

Clase sellada en OmsiLaunch.Core. Estabilidad: INTERNAL. Semántica: public-api.

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

SessionProfileCompiler#

Clase estática en OmsiLaunch.Core. Estabilidad: EXPERIMENTAL. Semántica: session-profiles.

MiembroFirma
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#

Clase sellada en OmsiLaunch.Core. Estabilidad: EXPERIMENTAL. Semántica: session-profiles.

MiembroFirma
constructorSessionProfileException(string code, string message)
propiedadstring Code { get; }

SessionProfilePackage#

Record sellado en OmsiLaunch.Core. Estabilidad: EXPERIMENTAL. Semántica: session-profiles.

MiembroFirma
constructorSessionProfilePackage(string RootPath, SessionProfileMetadata Metadata, IReadOnlyList<string> CompatibleMaps, ProfileNew New, ProfilePreset Preset)
propiedadstring RootPath { get; init; }
propiedadSessionProfileMetadata Metadata { get; init; }
propiedadIReadOnlyList<string> CompatibleMaps { get; init; }
propiedadProfileNew New { get; init; }
propiedadProfilePreset Preset { get; init; }

OmsiLaunch.Process#

CurrentRuntimeCommandStore#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

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

CurrentStartupHandoffStore#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
propiedadstring Name { get; }
propiedadGuid SessionId { get; }
método estáticoCurrentStartupHandoffStore Create(StartupHandoff handoff)
métodovoid Dispose()

CurrentTelemetryStore#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

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

CurrentWindowsX64Platform#

Clase sellada en OmsiLaunch.Process. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
constructorCurrentWindowsX64Platform()
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#

Interfaz en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

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

IRuntimePlatform#

Interfaz en OmsiLaunch.Process. Estabilidad: STABLE_BETA. Semántica: public-api.

MiembroFirma
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#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

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

LaunchedProcess#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
propiedadint ProcessId { get; }
propiedadint ThreadId { get; }
propiedadProcessIdentity Identity { get; }
métodovoid Dispose()

OmsiProcessState#

Record sellado en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
constructorOmsiProcessState(string State, int? ProcessId, bool Responding)
propiedadstring State { get; init; }
propiedadint? ProcessId { get; init; }
propiedadbool Responding { get; init; }

ProcessIdentity#

Record sellado en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
constructorProcessIdentity(int ProcessId, DateTimeOffset CreationTimeUtc, string ExecutablePath, string ExecutableSha256)
propiedadint ProcessId { get; init; }
propiedadDateTimeOffset CreationTimeUtc { get; init; }
propiedadstring ExecutablePath { get; init; }
propiedadstring ExecutableSha256 { get; init; }

ReleaseManifest#

Clase estática en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
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 sellado en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
constructorRuntimeArtifact(string SourcePath, string DestinationRelativePath, string Sha256, long Size)
propiedadstring SourcePath { get; init; }
propiedadstring DestinationRelativePath { get; init; }
propiedadstring Sha256 { get; init; }
propiedadlong Size { get; init; }

RuntimeArtifactSet#

Clase sellada en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
propiedadIReadOnlyList<RuntimeArtifact> Artifacts { get; }
propiedadIReadOnlyDictionary<string, string> ExpectedHashes { get; }
propiedadstring IntegrityReference { get; }
método estáticoRuntimeArtifactSet Load(string pluginBuildDirectory, string nativeBuildPath, IReadOnlyDictionary<string, string> expectedHashes = null)
métodovoid ValidateInstalled(string installationRoot)

StartupProcessRequest#

Record sellado en OmsiLaunch.Process. Estabilidad: INTERNAL. Semántica: public-api.

MiembroFirma
constructorStartupProcessRequest(string ExecutablePath, string WorkingDirectory, IReadOnlyDictionary<string, string> Environment)
propiedadstring ExecutablePath { get; init; }
propiedadstring WorkingDirectory { get; init; }
propiedadIReadOnlyDictionary<string, string> Environment { get; init; }