MainChannel

---

Object Hierarchy:

Description:

Content:

Properties:

• public int agent_caps_0 { get; }
• public bool agent_connected { get; }
• public uint color_depth { get; set construct; }
• public bool disable_animation { get; set construct; }
• public bool disable_display_align { get; set construct; }
  Disable automatic horizontal display position alignment.
• public bool disable_display_position { get; set construct; }
• public bool disable_font_smooth { get; set construct; }
• public bool disable_wallpaper { get; set construct; }
• public int max_clipboard { get; set construct; }
  Maximum size of clipboard operations in bytes (default 100MB, -1 for unlimited size);
• public int mouse_mode { get; }
  Spice protocol specifies two mouse modes, client mode and server mode.

Creation methods:

• protected MainChannel ()

Methods:

• public bool agent_test_capability (uint32 cap)
  Test capability of a remote agent.
• public void clipboard_selection_grab (uint selection, uint32[] types)
  Grab the guest clipboard, with VD_AGENT_CLIPBOARD types.
• public void clipboard_selection_notify (uint selection, uint32 type, uint8[] data)
  Send the clipboard data to the guest.
• public void clipboard_selection_release (uint selection)
  Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available.
• public void clipboard_selection_request (uint selection, uint32 type)
  Request clipboard data of type from the guest.
• public async bool file_copy_async (File[] sources, FileCopyFlags flags, Cancellable? cancellable, FileProgressCallback? progress_callback) throws Error
  Copies the file sources to guest
• public void request_mouse_mode (int mode)
  Request a mouse mode to the server.
• public bool send_monitor_config ()
  Send monitors configuration previously set with main_set_display and main_set_display_enabled
• public void update_display (int id, int x, int y, int width, int height, bool update)
  Update the display id resolution.
• public void update_display_enabled (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 update_display_mm (int id, int width_mm, int height_mm, bool update)
  Update the display id physical size.

Signals:

• public signal void main_agent_update ()
  Notify when the spicemainchannel agent_connected or spicemainchannel agent_caps_0 property change.
• public signal void main_clipboard (uint type, uint8[] data)
  Provides guest clipboard data requested by main_clipboard_request.
• public signal bool main_clipboard_grab (uint32[] types)
  Inform when clipboard data is available from the guest, and for which types.
• public signal void main_clipboard_release ()
  Inform when the clipboard is released from the guest, when no clipboard data is available from the guest.
• public signal bool main_clipboard_request (uint types)
  Request clipboard data from the client.
• public signal void main_clipboard_selection (uint selection, uint type, uint8[] data)
  Informs that clipboard selection data are available.
• public signal bool main_clipboard_selection_grab (uint selection, uint32[] types)
  Inform when clipboard data is available from the guest, and for which types.
• public signal void main_clipboard_selection_release (uint selection)
  Inform when the clipboard is released from the guest, when no clipboard data is available from the guest.
• public signal bool main_clipboard_selection_request (uint selection, uint types)
  Request clipboard data from the client.
• public signal void main_mouse_update ()
  Notify when the mouse mode has changed.
• public signal void migration_started (Object session)
  Inform when migration is starting.
• public signal void new_file_transfer (Object task)
  This signal is emitted when a new file transfer task has been initiated on this channel.

Inherited Members: