zkde_screencast_unstable_v1

• # zkde_screencast_unstable_v1

  Warning! The protocol described in this file is a desktop environment implementation detail. Regular clients must not use this protocol. Backward incompatible changes may be added without bumping the major version of the extension.

  Requests

  • #

    stream_output

    requests a feed from a given source
    struct zkde_screencast_stream_unstable_v1* zkde_screencast_unstable_v1_stream_output(

    struct zkde_screencast_unstable_v1* zkde_screencast_unstable_v1,

    struct wl_output* output,

    uint32_t pointer /* Requested pointer mode */

    )
  • #

    stream_window

    requests a feed from a given source
    struct zkde_screencast_stream_unstable_v1* zkde_screencast_unstable_v1_stream_window(

    struct zkde_screencast_unstable_v1* zkde_screencast_unstable_v1,

    const char* window_uuid, /* window Identifier */

    uint32_t pointer /* Requested pointer mode */

    )
  • #

    destroy

    Destroy the zkde_screencast_unstable_v1
    void zkde_screencast_unstable_v1_destroy(

    struct zkde_screencast_unstable_v1* zkde_screencast_unstable_v1

    )
    Destroy the zkde_screencast_unstable_v1 object.
  • #

    stream_virtual_output

    requests a feed from a new virtual output
    struct zkde_screencast_stream_unstable_v1* zkde_screencast_unstable_v1_stream_virtual_output(

    struct zkde_screencast_unstable_v1* zkde_screencast_unstable_v1,

    const char* name, /* name of the created output */

    int32_t width, /* Logical width resolution */

    int32_t height, /* Logical height resolution */

    wl_fixed_t scale, /* Scaling factor of the display where it's to be displayed */

    uint32_t pointer /* Requested pointer mode */

    )
  • #

    stream_region

    requests a feed from region in the workspace
    struct zkde_screencast_stream_unstable_v1* zkde_screencast_unstable_v1_stream_region(

    struct zkde_screencast_unstable_v1* zkde_screencast_unstable_v1,

    int32_t x, /* Logical left position */

    int32_t y, /* Logical top position */

    uint32_t width, /* Logical width resolution */

    uint32_t height, /* Logical height resolution */

    wl_fixed_t scale, /* Scaling factor of the output recording */

    uint32_t pointer /* Requested pointer mode */

    )

  Enums

  • #

    pointer

    Stream consumer attachment attributes
    ZKDE_SCREENCAST_UNSTABLE_V1_POINTER_HIDDEN /* No cursor */
    ZKDE_SCREENCAST_UNSTABLE_V1_POINTER_EMBEDDED /* Render the cursor on the stream */
    ZKDE_SCREENCAST_UNSTABLE_V1_POINTER_METADATA /* Send metadata about where the cursor is through PipeWire */

• # zkde_screencast_stream_unstable_v1

  Requests

  • #

    close

    Indicates we are done with the stream and the communication is over.
    void zkde_screencast_stream_unstable_v1_close(

    struct zkde_screencast_stream_unstable_v1* zkde_screencast_stream_unstable_v1

    )

  Events

  • #

    closed

    Notifies that the server has stopped the stream. Clients should now call close.
  • #

    created

    Notifies about a pipewire feed being created
    uint32_t node /* node of the pipewire buffer */
  • #

    failed

    Offers an error message so the client knows the created event will not arrive, and the client should close the resource.
    const char* error /* A human readable translated error message. */

Copyright Info