Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

ca?: Uint8Array

CA certificates in PEM format. The text data can contain several CA certificates identified by:

-----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE-----

caFile?: string

File holding the CA certificates for the host the client is connecting to

cacheSize?: number

Images cache size. If 0, don't set.

certSubject?: string
ciphers?: string
clientSockets?: boolean
colorDepth?: number

Display color depth to set on new display channels. If 0, don't set.

disableEffects?: string[]

A string array of effects to disable. The settings will be applied on new display channels. The following effets can be disabled "wallpaper", "font-smooth", "animation", and "all", which will disable all the effects. If NULL, don't apply changes.

enableAudio?: boolean

If set to TRUE, the audio channels will be enabled for playback and recording.

enableSmartcard?: boolean

If set to TRUE, the smartcard channel will be enabled and smartcard events will be forwarded to the guest

enableUsbredir?: boolean

If set to TRUE, the usbredir channel will be enabled and USB devices can be redirected to the guest

glScanout?: boolean

Whether to enable gl-scanout (Unix only). Set to TRUE by default on EGL-enabled host, unless SPICE_DISABLE_GL_SCANOUT environment variable is set.

glzWindowSize?: number

Glz window size. If 0, don't set.

host?: string

URL of the SPICE host to connect to

inhibitKeyboardGrab?: boolean
password?: string

TLS password to use

port?: string

Port to connect to for unencrypted sessions

protocol?: number

Version of the SPICE protocol to use

proxy?: string

URI to the proxy server to use when doing network connection. of the form [:port] ]]>

pubkey?: Uint8Array
readOnly?: boolean

Whether this connection is read-only mode.

secureChannels?: string[]

A string array of channel types to be secured.

shareDirRo?: boolean

Whether to share the directory read-only.

sharedDir?: string

Location of the shared directory

smartcardCertificates?: string[]

This property is used when one wants to simulate a smartcard with no hardware smartcard reader. If it's set to a NULL-terminated string array containing the names of 3 valid certificates, these will be used to simulate a smartcard in the guest See also spice_smartcard_manager_insert_card()

smartcardDb?: string

Path to the NSS certificate database containing the certificates to use to simulate a software smartcard

tlsPort?: string

Port to connect to for TLS sessions

unixPath?: string

Path of the Unix socket to connect to

uri?: string

URI of the SPICE host to connect to. The URI is of the form spice://hostname?port=XXX or spice://hostname?tls_port=XXX

username?: string

Username to use

verify?: SessionVerify

#SpiceSessionVerify bit field indicating which parts of the peer certificate should be checked

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