Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

GTK_MAJOR_VERSION: number

Spice-Gtk major version component (e.g. 1 if version is 1.2.3)

GTK_MICRO_VERSION: number

Spice-Gtk micro version component (e.g. 3 if version is 1.2.3)

GTK_MINOR_VERSION: number

Spice-Gtk minor version component (e.g. 2 if version is 1.2.3)

Functions

  • clientErrorQuark(): Quark
  • Tells the spice server to change the preferred video codec type for streaming in channel. Application can set only one preferred video codec per display channel.

    Parameters

    Returns void

  • 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 spice_display_gl_draw_done() (failing to do so for each gl-draw may result in a frozen display).

    Parameters

    Returns void

  • inputsButtonPress(channel: InputsChannel, button: number, buttonState: number): void
  • Press a mouse button.

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • button: number

      a SPICE_MOUSE_BUTTON

    • buttonState: number

      SPICE_MOUSE_BUTTON_MASK flags

    Returns void

  • inputsButtonRelease(channel: InputsChannel, button: number, buttonState: number): void
  • Release a button.

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • button: number

      a SPICE_MOUSE_BUTTON

    • buttonState: number

      SPICE_MOUSE_BUTTON_MASK flags

    Returns void

  • Press a key.

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • scancode: number

      a PC XT (set 1) key scancode. For scancodes with an %0xe0 prefix, drop the prefix and OR the scancode with %0x100.

    Returns void

  • inputsKeyPressAndRelease(channel: InputsChannel, scancode: number): void
  • Press and release a key event atomically (in the same message).

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • scancode: number

      a PC XT (set 1) key scancode. For scancodes with an %0xe0 prefix, drop the prefix and OR the scancode with %0x100.

    Returns void

  • Release a key.

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • scancode: number

      a PC XT (set 1) key scancode. For scancodes with an %0xe0 prefix, drop the prefix and OR the scancode with %0x100.

    Returns void

  • inputsMotion(channel: InputsChannel, dx: number, dy: number, buttonState: number): void
  • Change mouse position (used in SPICE_MOUSE_MODE_SERVER).

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • dx: number

      delta X mouse coordinates

    • dy: number

      delta Y mouse coordinates

    • buttonState: number

      SPICE_MOUSE_BUTTON_MASK flags

    Returns void

  • inputsPosition(channel: InputsChannel, x: number, y: number, display: number, buttonState: number): void
  • Change mouse position (used in SPICE_MOUSE_MODE_CLIENT).

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • x: number

      X mouse coordinates

    • y: number

      Y mouse coordinates

    • display: number

      display channel id

    • buttonState: number

      SPICE_MOUSE_BUTTON_MASK flags

    Returns void

  • Set the keyboard locks on the guest (Caps, Num, Scroll..)

    Parameters

    • channel: InputsChannel

      a #SpiceInputsChannel

    • locks: number

      #SpiceInputsLock modifiers flags

    Returns void

  • mainAgentTestCapability(channel: MainChannel, cap: number): boolean
  • mainClipboardGrab(channel: MainChannel, types: number, ntypes: number): void
  • Grab the guest clipboard, with #VD_AGENT_CLIPBOARD types.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • types: number

      an array of #VD_AGENT_CLIPBOARD types available in the clipboard

    • ntypes: number

      the number of types

    Returns void

  • mainClipboardNotify(channel: MainChannel, type: number, data: number, size: number): void
  • Send the clipboard data to the guest.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • type: number

      a #VD_AGENT_CLIPBOARD type

    • data: number

      clipboard data

    • size: number

      data length in bytes

    Returns void

  • Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available.

    Parameters

    Returns void

  • mainClipboardRequest(channel: MainChannel, type: number): void
  • Request clipboard data of type from the guest. The reply is sent through the #SpiceMainChannel::main-clipboard signal.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • type: number

      a #VD_AGENT_CLIPBOARD type

    Returns void

  • mainClipboardSelectionGrab(channel: MainChannel, selection: number, types: number, ntypes: number): void
  • Grab the guest clipboard, with #VD_AGENT_CLIPBOARD types.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • selection: number

      one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*

    • types: number

      an array of #VD_AGENT_CLIPBOARD types available in the clipboard

    • ntypes: number

      the number of types

    Returns void

  • mainClipboardSelectionNotify(channel: MainChannel, selection: number, type: number, data: number, size: number): void
  • Send the clipboard data to the guest.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • selection: number

      one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*

    • type: number

      a #VD_AGENT_CLIPBOARD type

    • data: number

      clipboard data

    • size: number

      data length in bytes

    Returns void

  • mainClipboardSelectionRelease(channel: MainChannel, selection: number): void
  • Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • selection: number

      one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*

    Returns void

  • mainClipboardSelectionRequest(channel: MainChannel, selection: number, type: number): void
  • Request clipboard data of type from the guest. The reply is sent through the #SpiceMainChannel::main-clipboard-selection signal.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • selection: number

      one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*

    • type: number

      a #VD_AGENT_CLIPBOARD type

    Returns void

  • See: spice_main_channel_file_copy_async()

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • sources: Gio.File[]

      a %NULL-terminated array of #GFile objects to be transferred

    • flags: FileCopyFlags

      set of #GFileCopyFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore

    • progressCallback: FileProgressCallback

      function to callback with progress information, or %NULL if progress information is not needed

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • mainRequestMouseMode(channel: MainChannel, mode: number): void
  • Request a mouse mode to the server. The server may not be able to change the mouse mode, but spice-gtk will try to request it when possible.

    Parameters

    • channel: MainChannel

      a %SpiceMainChannel

    • mode: number

      a SPICE_MOUSE_MODE

    Returns void

  • Send monitors configuration previously set with spice_main_set_display() and spice_main_set_display_enabled()

    Parameters

    Returns boolean

  • mainSetDisplay(channel: MainChannel, id: number, x: number, y: number, width: number, height: number): void
  • Notify the guest of screen resolution change. The notification is sent 1 second later, if no further changes happen.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • id: number

      display ID

    • x: number

      x position

    • y: number

      y position

    • width: number

      display width

    • height: number

      display height

    Returns void

  • mainSetDisplayEnabled(channel: MainChannel, id: number, enabled: boolean): void
  • When sending monitor configuration to agent guest, don't set display id, which the agent translates to disabling the display id. Note: this will take effect next time the monitor configuration is sent.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • id: number

      display ID (if -1: set all displays)

    • enabled: boolean

      wether display id is enabled

    Returns void

  • mainUpdateDisplay(channel: MainChannel, id: number, x: number, y: number, width: number, height: number, update: boolean): void
  • Update the display id resolution.

    If update is %TRUE, the remote configuration will be updated too after 1 second without further changes. You can send when you want without delay the new configuration to the remote with spice_main_send_monitor_config()

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • id: number

      display ID

    • x: number

      x position

    • y: number

      y position

    • width: number

      display width

    • height: number

      display height

    • update: boolean

      if %TRUE, update guest resolution after 1sec.

    Returns void

  • mainUpdateDisplayEnabled(channel: MainChannel, id: number, enabled: boolean, update: boolean): void
  • 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. If enabled is %TRUE, the monitor will be included in the next monitor update. Note: this will take effect next time the monitor configuration is sent.

    If update is %FALSE, no server update will be triggered by this call, but the value will be saved and used in the next configuration update.

    Parameters

    • channel: MainChannel

      a #SpiceMainChannel

    • id: number

      display ID (if -1: set all displays)

    • enabled: boolean

      wether display id is enabled

    • update: boolean

      if %TRUE, update guest display state after 1sec.

    Returns void

  • Send an event to the port.

    Note: The values SPICE_PORT_EVENT_CLOSED and SPICE_PORT_EVENT_OPENED are managed by the channel connection state.

    Parameters

    • port: PortChannel

      a #SpicePortChannel

    • event: number

      a SPICE_PORT_EVENT value

    Returns void

  • Request an asynchronous write of count bytes from buffer into the port. When the operation is finished callback will be called. You can then call spice_port_write_finish() to get the result of the operation.

    Parameters

    • port: PortChannel

      A #SpicePortChannel

    • buffer: Uint8Array

      the buffer containing the data to write

    • cancellable: Gio.Cancellable

      optional GCancellable object, NULL to ignore

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • recordSendData(channel: RecordChannel, data: object, bytes: number, time: number): void
  • Send recorded PCM data to the guest.

    Parameters

    • channel: RecordChannel

      a #SpiceRecordChannel

    • data: object

      PCM data

    • bytes: number

      size of data

    • time: number

      stream timestamp

    Returns void

  • Set various properties on session, according to the commandline arguments given to spice_get_option_group() option group.

    Parameters

    Returns void

  • utilGetDebug(): boolean
  • utilGetVersionString(): string
  • utilSetDebug(enabled: boolean): void
  • Enable or disable Spice-GTK debugging messages.

    Parameters

    • enabled: boolean

      %TRUE or %FALSE

    Returns void

  • uuidToString(uuid: number): string
  • Creates a string representation of uuid, of the form "06e023d5-86d8-420e-8103-383e4566087a"

    Parameters

    • uuid: number

      UUID byte array

    Returns string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method