SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias PovInputRequest

    PovInputRequest: Message<"soulfire.v1.PovInputRequest"> & {
        captured: boolean;
        clipboard?: string;
        escape: boolean;
        events: PovInputEvent[];
        feedback?: PovStreamFeedback;
        height: number;
        inputToken: string;
        maxFps: number;
        readClipboard: boolean;
        requestKeyFrame: boolean;
        sequence: bigint;
        sessionId: string;
        width: number;
    }

    Type Declaration

    • captured: boolean

      from field: bool captured = 3;

    • Optionalclipboard?: string

      Clipboard is set before processing the accompanying paste key event.

      from field: optional string clipboard = 11;

    • escape: boolean

      Forward Escape to the game, including opening the pause menu.

      from field: bool escape = 7;

    • events: PovInputEvent[]

      from field: repeated soulfire.v1.PovInputEvent events = 6;

    • Optionalfeedback?: PovStreamFeedback

      from field: soulfire.v1.PovStreamFeedback feedback = 9;

    • height: number

      from field: int32 height = 5;

    • inputToken: string

      from field: string input_token = 10;

    • maxFps: number

      from field: uint32 max_fps = 13;

    • readClipboard: boolean

      from field: bool read_clipboard = 12;

    • requestKeyFrame: boolean

      Recover after dropping dependent frames or resetting the decoder.

      from field: bool request_key_frame = 8;

    • sequence: bigint

      from field: uint64 sequence = 2;

    • sessionId: string

      from field: string session_id = 1;

    • width: number

      from field: int32 width = 4;

    from message soulfire.v1.PovInputRequest

    Settings
    Member Visibility