Spice

---

Description:

Content:

Classes:

• Audio - The Audio struct is opaque and should not be accessed directly.
• Channel - The Channel struct is opaque and should not be accessed directly.
• CursorChannel - The CursorChannel struct is opaque and should not be accessed directly.
• CursorShape - The CursorShape structure defines the remote cursor's shape.
• DisplayChannel - The DisplayChannel struct is opaque and should not be accessed directly.
• FileTransferTask
• GlScanout - Holds the information necessary for using the GL display scanout.
• InputsChannel - The InputsChannel struct is opaque and should not be accessed directly.
• MainChannel - The MainChannel struct is opaque and should not be accessed directly.
• MsgIn
• MsgOut
• PlaybackChannel - The PlaybackChannel struct is opaque and should not be accessed directly.
• PortChannel - The PortChannel struct is opaque and should not be accessed directly.
• QmpPort - Opaque data structure.
• QmpStatus - Information about VCPU run state.
• RecordChannel - The RecordChannel struct is opaque and should not be accessed directly.
• Session - The Session struct is opaque and should not be accessed directly.
• SmartcardChannel - The SmartcardChannel struct is opaque and should not be accessed directly.
• SmartcardManager - The SmartcardManager struct is opaque and should not be accessed directly.
• SmartcardReader - The SmartcardReader struct is opaque and cannot be accessed directly.
• URI - The URI struct is opaque and cannot be accessed directly.
• UsbDevice - The UsbDevice struct is opaque and cannot be accessed directly.
• UsbDeviceManager - The UsbDeviceManager struct is opaque and should not be accessed directly.
• UsbredirChannel - The UsbredirChannel struct is opaque and should not be accessed directly.
• VReader
• WebdavChannel - The WebdavChannel struct is opaque and should not be accessed directly.

Structs:

• DisplayMonitorConfig - Holds a monitor configuration.
• DisplayPrimary - Holds the information necessary to use the primary surface.

Enums:

• ChannelEvent - An event, emitted by channel_event signal.
• InputsLock - Constants used to synchronize modifiers between a client and a guest.
• QmpPortVmAction - An action to perform on the VM.
• SessionMigration - Session migration state.
• SessionVerify - Peer certificate verification parameters flags.

Error domains:

• ClientError - Error codes returned by spice-client API.

Constants:

• public const int GTK_MAJOR_VERSION
  Spice-Gtk major version component (e.
• public const int GTK_MICRO_VERSION
  Spice-Gtk micro version component (e.
• public const int GTK_MINOR_VERSION
  Spice-Gtk minor version component (e.

Delegates:

• public delegate void msg_handler (Channel channel, MsgIn @in)

Functions:

• public void display_change_preferred_compression (Channel channel, int compression)
  Tells the spice server to change the preferred image compression for the channel.
• public void display_change_preferred_video_codec_type (Channel channel, int codec_type)
  Tells the spice server to change the preferred video codec type for streaming in channel.
• public unowned GlScanout display_get_gl_scanout (DisplayChannel channel)
  Retrieves the GL scanout if available
• public bool display_get_primary (Channel channel, uint32 surface_id, DisplayPrimary primary)
  Retrieve primary display surface surface_id.
• public void display_gl_draw_done (DisplayChannel channel)
  After a SpiceDisplayChannel::gl-draw is emitted, the client should draw the current display with the current GL scanout, and must release the GL resource with a call to display_gl_draw_done (failing to do so for each gl-draw may result in a frozen display).
• public OptionGroup get_option_group ()
  Gets commandline options.
• public void inputs_button_press (InputsChannel channel, int button, int button_state)
  Press a mouse button.
• public void inputs_button_release (InputsChannel channel, int button, int button_state)
  Release a button.
• public void inputs_key_press (InputsChannel channel, uint scancode)
  Press a key.
• public void inputs_key_press_and_release (InputsChannel channel, uint scancode)
  Press and release a key event atomically (in the same message).
• public void inputs_key_release (InputsChannel channel, uint scancode)
  Release a key.
• public void inputs_motion (InputsChannel channel, int dx, int dy, int button_state)
  Change mouse position (used in SPICE_MOUSE_MODE_SERVER).
• public void inputs_position (InputsChannel channel, int x, int y, int display, int button_state)
  Change mouse position (used in SPICE_MOUSE_MODE_CLIENT).
• public void inputs_set_key_locks (InputsChannel channel, uint locks)
  Set the keyboard locks on the guest (Caps, Num, Scroll.
• public bool main_agent_test_capability (MainChannel channel, uint32 cap)
  Test capability of a remote agent.
• public void main_clipboard_grab (MainChannel channel, uint32 types, int ntypes)
  Grab the guest clipboard, with VD_AGENT_CLIPBOARD types .
• public void main_clipboard_notify (MainChannel channel, uint32 type, uint8 data, size_t size)
  Send the clipboard data to the guest.
• public void main_clipboard_release (MainChannel channel)
  Release the clipboard (for example, when the client loses the clipboard grab ): Inform the guest no clipboard data is available.
• public void main_clipboard_request (MainChannel channel, uint32 type)
  Request clipboard data of type from the guest.
• public void main_clipboard_selection_grab (MainChannel channel, uint selection, uint32 types, int ntypes)
  Grab the guest clipboard, with VD_AGENT_CLIPBOARD types .
• public void main_clipboard_selection_notify (MainChannel channel, uint selection, uint32 type, uint8 data, size_t size)
  Send the clipboard data to the guest.
• public void main_clipboard_selection_release (MainChannel channel, uint selection)
  Release the clipboard (for example, when the client loses the clipboard grab ): Inform the guest no clipboard data is available.
• public void main_clipboard_selection_request (MainChannel channel, uint selection, uint32 type)
  Request clipboard data of type from the guest.
• public async bool main_file_copy_async (MainChannel channel, File[] sources, FileCopyFlags flags, Cancellable? cancellable, FileProgressCallback? progress_callback) throws Error
  See: file_copy_async
• public void main_request_mouse_mode (MainChannel channel, int mode)
  Request a mouse mode to the server.
• public bool main_send_monitor_config (MainChannel channel)
  Send monitors configuration previously set with main_set_display and main_set_display_enabled
• public void main_set_display (MainChannel channel, int id, int x, int y, int width, int height)
  Notify the guest of screen resolution change.
• public void main_set_display_enabled (MainChannel channel, int id, bool enabled)
  When sending monitor configuration to agent guest, don't set display id, which the agent translates to disabling the display id.
• public void main_update_display (MainChannel channel, int id, int x, int y, int width, int height, bool update)
  Update the display id resolution.
• public void main_update_display_enabled (MainChannel channel, int id, bool enabled, bool update)
  When sending monitor configuration to agent guest, if enabled is false, don't set display id, which the agent translates to disabling the display id.
• public void port_event (PortChannel port, uint8 event)
  Send an event to the port.
• public async ssize_t port_write_async (PortChannel port, uint8[] buffer, Cancellable? cancellable) throws Error
  Request an asynchronous write of count bytes from buffer into the port.
• public void record_send_data (RecordChannel channel, void* data, size_t bytes, uint32 time)
  Send recorded PCM data to the guest.
• public void set_session_option (Session session)
  Set various properties on session, according to the commandline arguments given to get_option_group option group.
• public bool util_get_debug ()
• public unowned string util_get_version_string ()
  Gets the version string
• public void util_set_debug (bool enabled)
  Enable or disable Spice-GTK debugging messages.
• public string uuid_to_string (uint8 uuid)
  Creates a string representation of uuid, of the form "06e023d5-86d8-420e-8103-383e4566087a"