InputCaptureSession

Object Hierarchy:

Description:

[ CCode ( type_id = "xdp_input_capture_session_get_type ()" ) ]
public class InputCaptureSession : Object

A representation of a long-lived input capture portal interaction.

The [class@InputCaptureSession] object is used to represent portal interactions with the input capture desktop portal that extend over multiple portal calls. Usually a caller creates an input capture session, requests the available zones and sets up pointer barriers on those zones before enabling the session.

To find available zones, call [method@InputCaptureSession.get_zones]. These [class@InputCaptureZone] object represent the accessible desktop area for input capturing. [class@InputCapturePointerBarrier] objects can be set up on these zones to trigger input capture.

The [class@InputCaptureSession] wraps a [class@Session] object.

Namespace: Xdp

Package: libportal

Content:

Creation methods:

protected InputCaptureSession ()

Methods:

public int connect_to_eis () throws Error
Connect this session to an EIS implementation and return the fd.
public void disable ()
Disables this input capture session.
public void enable ()
Enables this input capture session.
public unowned string get_restore_token ()
Returns the restore token for this session or NULL if none exists.
public unowned Session get_session ()
Return the [class@XdpSession] for this InputCapture session.
public unowned List<InputCaptureZone> get_zones ()
Obtains the current set of [class@InputCaptureZone] objects.
public void release (uint activation_id)
Releases this input capture session without a suggested cursor position.
public void release_at (uint activation_id, double cursor_x_position, double cursor_y_position)
Releases this input capture session with a suggested cursor position.
public async List<InputCapturePointerBarrier> set_pointer_barriers (owned List<unowned InputCapturePointerBarrier> barriers, Cancellable? cancellable) throws Error
Sets the pointer barriers for this session.
public void set_restore_token (string restore_token)
Sets the restore token for the session about to be started.
public void set_session_persistence (InputCaptureSessionPersistence persistence)
Requests session persistence from the portal.
public async bool start (Parent? parent, InputCapability capabilities, Cancellable? cancellable) throws Error
Start the input capture session.

Signals:

public signal void activated (uint activation_id, Variant options)
Emitted when an InputCapture session activates and sends events.
public signal void deactivated (uint activation_id, Variant options)
Emitted when an InputCapture session deactivates and no longer sends events.
public signal void disabled (Variant options)
Emitted when an InputCapture session is disabled.
public signal void zones_changed (Variant options)
Emitted when an InputCapture session's zones have changed.

Inherited Members:

All known members inherited from class GLib.Object