summaryrefslogtreecommitdiff
path: root/README.md
blob: 04e855335b57a00a7efbe830123397f66ae3104b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
spice-gtk
=========

A Gtk client and libraries for SPICE remote desktop servers.

Please report bugs at: spice-devel@lists.freedesktop.org

Project content
---------------

* **libspice-client-glib-2.0**

    Provides glib objects for spice protocol decoding and surface rendering.
    * SpiceSession (see spice-session.h).
    * SpiceChannel (see spice-channel.h).
    * SpiceAudio (see spice-audio.h).
    * Various Spice<Type>Channel (see channel-<type>.h).

* **libspice-client-gtk-3.0**

    provides gtk widget to show spice display and accept user input.
    * SpiceDisplay (see spice-widget.h)

* **spicy**

   a gtk test client. The recommended client for end user is
   [virt-viewer]

* **spicy-screenshot**

   Command line tool, connects to spice server and writes out a
   screen shot.

* **spicy-stats**

   Command line tool, connects to spice server and writes out a
   summary of connection details, amount of bytes transferred...

* **SpiceClientGlib** and **SpiceClientGtk** GObject-introspection modules.

[virt-viewer]: https://pagure.io/virt-viewer

Build dependencies:
------------------

* On Fedora use:

>>>
    dnf builddep spice-gtk
>>>

* or install:

>>>
    meson ninja gtk3-devel spice-protocol openssl-devel pulseaudio-libs-devel pixman-devel
    gobject-introspection-devel libjpeg-turbo-devel zlib-devel cyrus-sasl-devel gtk-doc
    gettext-devel vala vala-tools python3 python3-pyparsing
>>>

The GStreamer backend needs:

>>>
    gstreamer1-devel gstreamer1-plugins-base-devel gstreamer1-plugins-good gstreamer1-plugins-bad-free
>>>