@decky/ui 4.9.2 → 4.10.1

package/src/globals/steam-client/shared.ts

@@ -0,0 +1,262 @@
+export enum EResult {
+  OK = 1,
+  Fail,
+  NoConnection,
+  InvalidPassword = 5,
+  LoggedInElsewhere,
+  InvalidProtocolVer,
+  InvalidParam,
+  FileNotFound,
+  Busy,
+  InvalidState,
+  InvalidName,
+  InvalidEmail,
+  DuplicateName,
+  AccessDenied,
+  Timeout,
+  Banned,
+  AccountNotFound,
+  InvalidSteamID,
+  ServiceUnavailable,
+  NotLoggedOn,
+  Pending,
+  EncryptionFailure,
+  InsufficientPrivilege,
+  LimitExceeded,
+  Revoked,
+  Expired,
+  AlreadyRedeemed,
+  DuplicateRequest,
+  AlreadyOwned,
+  IPNotFound,
+  PersistFailed,
+  LockingFailed,
+  LogonSessionReplaced,
+  ConnectFailed,
+  HandshakeFailed,
+  IOFailure,
+  RemoteDisconnect,
+  ShoppingCartNotFound,
+  Blocked,
+  Ignored,
+  NoMatch,
+  AccountDisabled,
+  ServiceReadOnly,
+  AccountNotFeatured,
+  AdministratorOK,
+  ContentVersion,
+  TryAnotherCM,
+  PasswordRequiredToKickSession,
+  AlreadyLoggedInElsewhere,
+  Suspended,
+  Cancelled,
+  DataCorruption,
+  DiskFull,
+  RemoteCallFailed,
+  PasswordUnset,
+  ExternalAccountUnlinked,
+  PSNTicketInvalid,
+  ExternalAccountAlreadyLinked,
+  RemoteFileConflict,
+  IllegalPassword,
+  SameAsPreviousValue,
+  AccountLogonDenied,
+  CannotUseOldPassword,
+  InvalidLoginAuthCode,
+  AccountLogonDeniedNoMail,
+  HardwareNotCapableOfIPT,
+  IPTInitError,
+  ParentalControlRestricted,
+  FacebookQueryError,
+  ExpiredLoginAuthCode,
+  IPLoginRestrictionFailed,
+  AccountLockedDown,
+  AccountLogonDeniedVerifiedEmailRequired,
+  NoMatchingURL,
+  BadResponse,
+  RequirePasswordReEntry,
+  ValueOutOfRange,
+  UnexpectedError,
+  Disabled,
+  InvalidCEGSubmission,
+  RestrictedDevice,
+  RegionLocked,
+  RateLimitExceeded,
+  AccountLoginDeniedNeedTwoFactor,
+  ItemDeleted,
+  AccountLoginDeniedThrottle,
+  TwoFactorCodeMismatch,
+  TwoFactorActivationCodeMismatch,
+  AccountAssociatedToMultiplePartners,
+  NotModified,
+  NoMobileDevice,
+  TimeNotSynced,
+  SmsCodeFailed,
+  AccountLimitExceeded,
+  AccountActivityLimitExceeded,
+  PhoneActivityLimitExceeded,
+  RefundToWallet,
+  EmailSendFailure,
+  NotSettled,
+  NeedCaptcha,
+  GSLTDenied,
+  GSOwnerDenied,
+  InvalidItemType,
+  IPBanned,
+  GSLTExpired,
+  InsufficientFunds,
+  TooManyPending,
+  NoSiteLicensesFound,
+  WGNetworkSendExceeded,
+  AccountNotFriends,
+  LimitedUserAccount,
+}
+
+export enum EBrowserType {
+  /**
+   * No window is created (like SharedJSContext).
+   */
+  OffScreen,
+  OpenVROverlay,
+  OpenVROverlay_Dashboard,
+  /**
+   * A normal window.
+   */
+  DirectHWND,
+  /**
+   * A borderless window.
+   */
+  DirectHWND_Borderless,
+  /**
+   * An initially hidden window.
+   * May be shown with {@link SteamClient.Window.ShowWindow}.
+   */
+  DirectHWND_Hidden,
+  ChildHWNDNative,
+  Offscreen_SteamUI = 12,
+  OpenVROverlay_Subview,
+}
+
+export enum ESteamRealm {
+  Unknown,
+  Global,
+  China,
+}
+
+/**
+ * Controls how Gamescope renders the GamepadUI window when a game is running.
+ */
+export enum EUIComposition {
+  /** Steam is not rendered on the screen. */
+  Hidden,
+
+  /**
+   * Transparent divs will allow pixels from the app behind Steam to penetrate.
+   * Input goes to **the app**.
+   */
+  Notification,
+
+  /**
+   * Transparent divs will allow pixels from the app behind Steam to penetrate.
+   * Input goes to **Steam**.
+   */
+  Overlay,
+
+  /** Take all of the pixels on the screen, nothing "behind" Steam is shown. */
+  Opaque,
+
+  /**
+   * Special composition mode that matches {@link Overlay}, but forwards synthetic keyboard
+   * events to the Gamescope foreground app (game) instead of Steam.
+   */
+  OverlayKeyboard,
+}
+
+export enum EUIMode {
+  Unknown = -1,
+  GamePad = 4,
+  Desktop = 7,
+}
+
+/** 0 - false, 1 - true */
+export type VDFBoolean_t = 0 | 1;
+
+export interface BrowserContext {
+  /**
+   * Window type.
+   */
+  m_eBrowserType?: EBrowserType;
+
+  /**
+   * The UI mode in use.
+   */
+  m_eUIMode?: EUIMode;
+
+  /**
+   * @todo Appears when {@link m_eBrowserType} == 0 ?
+   */
+  m_gameID?: string;
+
+  /**
+   * @todo Same as `SteamClient.Browser.GetBrowserID()` ?
+   */
+  m_nBrowserID: number;
+
+  /**
+   * Game's app ID.
+   */
+  m_unAppID?: number;
+
+  /**
+   * If overlay, game's PID.
+   */
+  m_unPID: number;
+}
+
+/**
+ * Represents the response of an operation. It appears to be not necessary to await for this operation response. It is only used to indicate the result of an operation.
+ */
+export interface OperationResponse {
+  /**
+   * The result code of the operation.
+   */
+  result: EResult;
+
+  /**
+   * An unlocalized message describing the result of the operation.
+   */
+  message: string;
+}
+
+export interface Unregisterable {
+  /**
+   * Unregister the callback.
+   */
+  unregister(): void;
+}
+
+/**
+ * ProtoBuf message class.
+ */
+export interface JsPbMessageClass {
+  /**
+   * @todo Returns {@link JsPbMessage}, but not sure how to do it for the messages.
+   */
+  deserializeBinary(data: ArrayBuffer): any;
+}
+
+/**
+ * Deserialized ProtoBuf message.
+ */
+export interface JsPbMessage {
+  getClassName(): string;
+
+  serializeBase64String(): string;
+
+  serializeBinary(): Uint8Array;
+
+  /**
+   * Converts the message to an object.
+   */
+  toObject(includeJsPbInstance: boolean): any;
+}

package/src/globals/steam-client/system/Audio.ts

@@ -0,0 +1,202 @@
+import { OperationResponse, Unregisterable } from "../shared";
+
+/**
+ * Represents various functions related to Steam system audio.
+ */
+export interface Audio {
+    /**
+     * Clears the default device override for a specified audio type.
+     * @param audioType The audio type (0 for input, 1 for output).
+     */
+    ClearDefaultDeviceOverride(audioType: number): Promise<OperationResponse>;
+
+    /**
+     * Retrieves information about audio applications.
+     * @returns information about audio applications.
+     */
+    GetApps(): Promise<ApplicationsAudio>;
+
+    /**
+     * Retrieves information about audio devices.
+     * @returns information about audio devices.
+     */
+    GetDevices(): Promise<AudioDeviceInfo>;
+
+    /**
+     * Registers a callback to be called when a new audio application is added.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForAppAdded(callback: (app: ApplicationAudio) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when an audio application is removed.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForAppRemoved(callback: (appAudioId: number) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when the volume of an audio application changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForAppVolumeChanged(callback: (appAudioId: number, volume: number) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when a new audio device is added.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForDeviceAdded(callback: (device: AudioDevice) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when an audio device is removed.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForDeviceRemoved(callback: (audioDeviceId: number) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when the volume of an audio device changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForDeviceVolumeChanged(callback: (audioDeviceId: number, audioType: number, volume: number) => void): Unregisterable;
+
+    RegisterForServiceConnectionStateChanges(callback: (param0: any) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when volume buttons are pressed.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForVolumeButtonPressed(callback: (volumeUpPressed: boolean) => void): Unregisterable;
+
+    /**
+     * Sets the volume of an audio application.
+     * @param appAudioId The ID of the audio application.
+     * @param volume The volume level (floating point value between 0 and 1).
+     */
+    SetAppVolume(appAudioId: number, volume: number): Promise<OperationResponse>;
+
+    /**
+     * Sets the default device override for a specified audio type.
+     * @param audioDeviceId The ID of the audio device.
+     * @param audioType The audio type (0 for input, 1 for output).
+     */
+    SetDefaultDeviceOverride(audioDeviceId: number, audioType: number): Promise<OperationResponse>;
+
+    /**
+     * Sets the volume of an audio device.
+     * @param audioDeviceId The ID of the audio device.
+     * @param audioType The audio type (0 for input, 1 for output).
+     * @param volume The volume level (floating point value between 0 and 1).
+     */
+    SetDeviceVolume(audioDeviceId: number, audioType: number, volume: number): Promise<OperationResponse>;
+}
+
+/**
+ * Represents details about an array of application audio sessions.
+ */
+export interface ApplicationsAudio {
+    /**
+     * An array of application audio sessions.
+     */
+    apps: ApplicationAudio[];
+}
+
+/**
+ * Represents details about an application audio session.
+ */
+export interface ApplicationAudio {
+    /**
+     * The ID of the application audio.
+     */
+    id: number;
+
+    /**
+     * The name of the application (e.g., Spotify, YouTube from a browser, etc.).
+     */
+    strName: string;
+
+    /**
+     * The volume level of the application (floating point value between 0 and 1).
+     */
+    flVolume: number;
+}
+
+/**
+ * Represents details about audio devices and information about the active audio device.
+ */
+export interface AudioDeviceInfo {
+    /**
+     * The ID of the active output audio device.
+     */
+    activeOutputDeviceId: number;
+
+    /**
+     * The ID of the active input audio device.
+     */
+    activeInputDeviceId: number;
+
+    /**
+     * The ID of the overridden output audio device (-1 if not overridden).
+     */
+    overrideOutputDeviceId: number;
+
+    /**
+     * The ID of the overridden input audio device (-1 if not overridden).
+     */
+    overrideInputDeviceId: number;
+
+    /**
+     * An array of audio devices.
+     */
+    vecDevices: AudioDevice[];
+}
+
+/**
+ * Represents details about an audio device.
+ */
+export interface AudioDevice {
+    /**
+     * The identifier of the audio device.
+     */
+    id: number;
+
+    /**
+     * The name of the audio device.
+     */
+    sName: string;
+
+    /**
+     * Indicates if the device has audio output.
+     */
+    bHasOutput: boolean;
+
+    /**
+     * Indicates if the device is the default output device.
+     */
+    bIsDefaultOutputDevice: boolean;
+
+    /**
+     * The volume level of the audio output device (floating point value between 0 and 1).
+     */
+    flOutputVolume: number;
+
+    /**
+     * Indicates if the device has audio input.
+     */
+    bHasInput: boolean;
+
+    /**
+     * Indicates if the device is the default input device.
+     */
+    bIsDefaultInputDevice: boolean;
+
+    /**
+     * The volume level of the audio input device (floating point value between 0 and 1).
+     */
+    flInputVolume: number;
+}

package/src/globals/steam-client/system/AudioDevice.ts

@@ -0,0 +1,116 @@
+import { JsPbMessage, Unregisterable } from "../shared";
+
+export interface AudioDevice {
+    /**
+     * If `data` is deserialized, returns {@link CMsgSystemAudioManagerState}.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
+
+    /**
+     * @param base64 Serialized base64 message from `CMsgSystemAudioManagerUpdateSomething`.
+     */
+    UpdateSomething(base64: string): void;
+}
+
+export interface CMsgSystemAudioManagerState extends JsPbMessage {
+    counter(): number | undefined;
+
+    hw(): MsgSystemAudioManagerStateHW | undefined;
+
+    rtime_filter(): number | undefined;
+}
+
+export interface MsgSystemAudioManagerStateHW {
+    devices: MsgSystemAudioManagerDevice[];
+    nodes: MsgSystemAudioManagerNode[];
+    ports: MsgSystemAudioManagerPort[];
+    links: MsgSystemAudioManagerLink[];
+}
+
+export interface MsgSystemAudioManagerDevice {
+    base: MsgSystemAudioManagerObject | undefined;
+    name: string | undefined;
+    nick: string | undefined;
+    description: string | undefined;
+    api: string | undefined;
+}
+
+export interface MsgSystemAudioManagerNode {
+    base: MsgSystemAudioManagerObject | undefined;
+    device_id: number | undefined;
+    name: string | undefined;
+    nick: string | undefined;
+    description: string | undefined;
+    edirection: ESystemAudioDirection | undefined;
+    volume: MsgSystemAudioVolume | undefined;
+}
+
+export interface MsgSystemAudioManagerPort {
+    base: MsgSystemAudioManagerObject | undefined;
+    node_id: number | undefined;
+    name: string | undefined;
+    alias: string | undefined;
+    etype: ESystemAudioPortType | undefined;
+    edirection: ESystemAudioPortDirection | undefined;
+    is_physical: boolean | undefined;
+    is_terminal: boolean | undefined;
+    is_control: boolean | undefined;
+    is_monitor: boolean | undefined;
+}
+
+export interface MsgSystemAudioVolume {
+    entries: MsgSystemAudioVolumeChannelEntry[] | undefined;
+    is_muted: boolean | undefined;
+}
+
+export interface MsgSystemAudioVolumeChannelEntry {
+    echannel: ESystemAudioChannel | undefined;
+    volume: number | undefined;
+}
+
+export interface MsgSystemAudioManagerLink {
+    base: MsgSystemAudioManagerObject | undefined;
+    output_node_id: number | undefined;
+    output_port_id: number | undefined;
+    input_node_id: number | undefined;
+    input_port_id: number | undefined;
+}
+
+export interface MsgSystemAudioManagerObject {
+    id: number | undefined;
+    rtime_last_update: number | undefined;
+}
+
+export enum ESystemAudioDirection {
+    Invalid,
+    Input,
+    Output,
+}
+
+export enum ESystemAudioPortDirection {
+    Invalid,
+    Input,
+    Output,
+}
+
+export enum ESystemAudioPortType {
+    Invalid,
+    Unknown,
+    Audio32f,
+    Midi8b,
+    Video32RGBA,
+}
+
+export enum ESystemAudioChannel {
+    Invalid,
+    Aggregated,
+    FrontLeft,
+    FrontRight,
+    LFE,
+    BackLeft,
+    BackRight,
+    FrontCenter,
+    Unknown,
+    Mono,
+}