SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias PovFrame

    PovFrame: Message<"soulfire.v1.PovFrame"> & {
        clipboard?: string;
        clipboardSequence: bigint;
        codec: string;
        cursorShape: PovFrame_CursorShape;
        data: Uint8Array;
        height: number;
        inputToken: string;
        keyFrame: boolean;
        openUrl?: string;
        screenOpen: boolean;
        sequence: bigint;
        targetBitrate: number;
        targetFps: number;
        timestampUs: bigint;
        width: number;
    }

    Type Declaration

    • Optionalclipboard?: string

      from field: optional string clipboard = 15;

    • clipboardSequence: bigint

      from field: uint64 clipboard_sequence = 16;

    • codec: string

      RFC 6381 codec string derived from the stream's SPS.

      from field: string codec = 10;

    • cursorShape: PovFrame_CursorShape

      Minecraft's cursor for the GUI in this frame; hidden when screen_open is false.

      from field: soulfire.v1.PovFrame.CursorShape cursor_shape = 11;

    • data: Uint8Array

      One complete video access unit: Annex B for H.264, low-overhead OBUs for AV1. H.264 keyframes include SPS and PPS.

      from field: bytes data = 7;

    • height: number

      from field: int32 height = 5;

    • inputToken: string

      Session-scoped capability for /pov/input. Never place it in a URL.

      from field: string input_token = 13;

    • keyFrame: boolean

      from field: bool key_frame = 9;

    • OptionalopenUrl?: string

      from field: optional string open_url = 17;

    • screenOpen: boolean

      from field: bool screen_open = 6;

    • sequence: bigint

      from field: uint64 sequence = 3;

    • targetBitrate: number

      from field: uint32 target_bitrate = 12;

    • targetFps: number

      from field: uint32 target_fps = 14;

    • timestampUs: bigint

      from field: uint64 timestamp_us = 8;

    • width: number

      from field: int32 width = 4;

    from message soulfire.v1.PovFrame

    Settings
    Member Visibility