SpiceClientGLib – 2.0
Description: Reference for SpiceClientGLib-2.0

### Namespace

# SpiceClientGLib – 2.0

A GLib-based library for interacting with SPICE servers

Version | 0.43.0
Authors | The Spice Project
License | LGPL-2.1-or-later
Website |
Source | https://gitlab.freedesktop.org/spice/spice-gtk/

#### Build

C headers | `spice-client.h`
pkg-config files | `spice-client-glib-2.0`

#### Dependencies

GObject—2.0 | The base type system library
| Browse documentation
Gio—2.0 | GObject interfaces and objects
| Browse documentation
GstBase—1.0 | GStreamer Base Library
| Browse documentation

#### Additional documentation

- Overview
- Session and Channels
- Application Support
- Classes Hierarchy

#### Classes

Audio | The `SpiceAudio` struct is opaque and should not be accessed directly.
Channel | The `SpiceChannel` struct is opaque and should not be accessed directly.
CursorChannel | The `SpiceCursorChannel` struct is opaque and should not be accessed directly.
DisplayChannel | The `SpiceDisplayChannel` struct is opaque and should not be accessed directly.
FileTransferTask |
InputsChannel | The `SpiceInputsChannel` struct is opaque and should not be accessed directly.
MainChannel | The `SpiceMainChannel` struct is opaque and should not be accessed directly.
PlaybackChannel | The `SpicePlaybackChannel` struct is opaque and should not be accessed directly.
PortChannel | The `SpicePortChannel` struct is opaque and should not be accessed directly.
QmpPort | Opaque data structure. since: 0.36
RecordChannel | The `SpiceRecordChannel` struct is opaque and should not be accessed directly.
Session | The `SpiceSession` struct is opaque and should not be accessed directly.
SmartcardChannel | The `SpiceSmartcardChannel` struct is opaque and should not be accessed directly.
SmartcardManager | The `SpiceSmartcardManager` struct is opaque and should not be accessed directly.
URI | The `SpiceURI` struct is opaque and cannot be accessed directly.
UsbDeviceManager | The `SpiceUsbDeviceManager` struct is opaque and should not be accessed directly.
UsbredirChannel | The `SpiceUsbredirChannel` struct is opaque and should not be accessed directly.
WebdavChannel | The `SpiceWebdavChannel` struct is opaque and should not be accessed directly.

#### Structs

CursorShape | The `SpiceCursorShape` structure defines the remote cursor’s shape.
DisplayMonitorConfig | Holds a monitor configuration.
DisplayPrimary | Holds the information necessary to use the primary surface.
GlScanout | Holds the information necessary for using the GL display scanout.
GlScanout2 | Holds the information necessary for using the GL display scanout.
QmpStatus | Information about VCPU run state. since: 0.36
SmartcardReader | The `SpiceSmartcardReader` struct is opaque and cannot be accessed directly.
UsbDevice | The `SpiceUsbDevice` struct is opaque and cannot be accessed directly.

#### Enumerations

ChannelEvent | An event, emitted by `SpiceChannel::channel-event` signal.
QmpPortVmAction | An action to perform on the VM. since: 0.36
SessionMigration | Session migration state.

#### Bitfields

InputsLock | Constants used to synchronize modifiers between a client and a guest.
SessionVerify | Peer certificate verification parameters flags.

#### Error Domains

ClientError | Error codes returned by spice-client API.

#### Functions

client_error_quark | Gets a `GQuark` representing the string “spice-client-error-quark”.
get_option_group | Gets commandline options.
glib_get_version_string | Gets the version string. since: 0.43
glib_set_debug | Enable or disable Spice-GTK debugging messages. since: 0.43
glib_uuid_to_string | Creates a string representation of `uuid`, of the form “06e023d5-86d8-420e-8103-383e4566087a”. since: 0.43
set_session_option | Set various properties on `session`, according to the commandline arguments given to `spice_get_option_group()` option group.

#### Function Macros

GTK_CHECK_VERSION | Compile-time version checking. Evaluates to `TRUE` if the version of Spice-Gtk is greater than the required one. since: 0.24

#### Constants

GTK_MAJOR_VERSION | Spice-Gtk major version component (e.g. 1 if version is 1.2.3).
GTK_MICRO_VERSION | Spice-Gtk micro version component (e.g. 3 if version is 1.2.3).
GTK_MINOR_VERSION | Spice-Gtk minor version component (e.g. 2 if version is 1.2.3).
WEBDAV_CLIPBOARD_FOLDER_PATH |