spice

package module

Go to main page

Versions in this module

v0

v0.0.4

Oct 28, 2025

Changes in this version

+ const SPICE_DISPLAY_CAP_GL_SCANOUT2

+ const SPICE_WEBDAV_MSG_FILE_XFER_DATA

+ const SPICE_WEBDAV_MSG_FILE_XFER_START

+ const SPICE_WEBDAV_MSG_FILE_XFER_STATUS

+ const SPICE_WEBDAV_MSG_INVALID

+ type ActiveTransfer struct

+ BytesSent int64

+ Callback FileTransferCallback

+ File *os.File

+ FileName string

+ ID uint32

+ OriginalPath string

+ TotalSize int64

type Client

+ func (client *Client) GetFileTransfer() *SpiceWebdav

+ type FileTransferCallback func(progress FileTransferProgress)

+ type FileTransferProgress struct

+ BytesSent int64

+ Error error

+ FileName string

+ Percentage float64

+ Status uint32

+ TotalSize int64

type SpiceWebdav

+ func (d *SpiceWebdav) CancelTransfer(id uint32) error

+ func (d *SpiceWebdav) SendFile(filePath string, callback FileTransferCallback) (uint32, error)

+ func (d *SpiceWebdav) SendFiles(filePaths []string, callback FileTransferCallback) ([]uint32, error)

v0.0.3

Jul 29, 2021

Changes in this version

+ const SPICE_MSGC_RECORD_DATA

+ const SPICE_MSGC_RECORD_MODE

+ const SPICE_MSGC_RECORD_START_MARK

+ const SPICE_MSG_RECORD_MUTE

+ const SPICE_MSG_RECORD_START

+ const SPICE_MSG_RECORD_STOP

+ const SPICE_MSG_RECORD_VOLUME

+ const SPICE_RECORD_CAP_CELT_0_5_1

+ const SPICE_RECORD_CAP_OPUS

+ const SPICE_RECORD_CAP_VOLUME

+ type ChRecord struct

v0.0.2

Jul 23, 2021

v0.0.1

Jul 23, 2021

Changes in this version

+ const SPICE_AUDIO_DATA_MODE_CELT_0_5_1

+ const SPICE_AUDIO_DATA_MODE_OPUS

+ const SPICE_AUDIO_DATA_MODE_RAW

+ const SPICE_CAPS_LOCK_MODIFIER

+ const SPICE_COMMON_CAP_AUTH_SASL

+ const SPICE_COMMON_CAP_AUTH_SPICE

+ const SPICE_COMMON_CAP_MINI_HEADER

+ const SPICE_COMMON_CAP_PROTOCOL_AUTH_SELECTION

+ const SPICE_CURSOR_TYPE_ALPHA

+ const SPICE_CURSOR_TYPE_COLOR16

+ const SPICE_CURSOR_TYPE_COLOR24

+ const SPICE_CURSOR_TYPE_COLOR32

+ const SPICE_CURSOR_TYPE_COLOR4

+ const SPICE_CURSOR_TYPE_COLOR8

+ const SPICE_CURSOR_TYPE_MONO

+ const SPICE_DISPLAY_CAP_A8_SURFACE

+ const SPICE_DISPLAY_CAP_CODEC_H264

+ const SPICE_DISPLAY_CAP_CODEC_H265

+ const SPICE_DISPLAY_CAP_CODEC_MJPEG

+ const SPICE_DISPLAY_CAP_CODEC_VP8

+ const SPICE_DISPLAY_CAP_CODEC_VP9

+ const SPICE_DISPLAY_CAP_COMPOSITE

+ const SPICE_DISPLAY_CAP_GL_SCANOUT

+ const SPICE_DISPLAY_CAP_LZ4_COMPRESSION

+ const SPICE_DISPLAY_CAP_MONITORS_CONFIG

+ const SPICE_DISPLAY_CAP_MULTI_CODEC

+ const SPICE_DISPLAY_CAP_PREF_COMPRESSION

+ const SPICE_DISPLAY_CAP_PREF_VIDEO_CODEC_TYPE

+ const SPICE_DISPLAY_CAP_SIZED_STREAM

+ const SPICE_DISPLAY_CAP_STREAM_REPORT

+ const SPICE_IMAGE_COMPRESSION_AUTO_GLZ

+ const SPICE_IMAGE_COMPRESSION_AUTO_LZ

+ const SPICE_IMAGE_COMPRESSION_GLZ

+ const SPICE_IMAGE_COMPRESSION_INVALID

+ const SPICE_IMAGE_COMPRESSION_LZ

+ const SPICE_IMAGE_COMPRESSION_LZ4

+ const SPICE_IMAGE_COMPRESSION_OFF

+ const SPICE_IMAGE_COMPRESSION_QUIC

+ const SPICE_INFO_GENERAL

+ const SPICE_INPUTS_CAP_KEY_SCANCODE

+ const SPICE_MAGIC

+ const SPICE_MAIN_CAP_AGENT_CONNECTED_TOKENS

+ const SPICE_MAIN_CAP_NAME_AND_UUID

+ const SPICE_MAIN_CAP_SEAMLESS_MIGRATE

+ const SPICE_MAIN_CAP_SEMI_SEAMLESS_MIGRATE

+ const SPICE_MOUSE_MODE_CLIENT

+ const SPICE_MOUSE_MODE_SERVER

+ const SPICE_MSGC_ACK

+ const SPICE_MSGC_ACK_SYNC

+ const SPICE_MSGC_DISCONNECTING

+ const SPICE_MSGC_DISPLAY_GL_DRAW_DONE

+ const SPICE_MSGC_DISPLAY_INIT

+ const SPICE_MSGC_DISPLAY_PREFERRED_COMPRESSION

+ const SPICE_MSGC_DISPLAY_PREFERRED_VIDEO_CODEC_TYPE

+ const SPICE_MSGC_DISPLAY_STREAM_REPORT

+ const SPICE_MSGC_FIRST_AVAIL

+ const SPICE_MSGC_INPUTS_KEY_DOWN

+ const SPICE_MSGC_INPUTS_KEY_MODIFIERS

+ const SPICE_MSGC_INPUTS_KEY_UP

+ const SPICE_MSGC_INPUTS_MOUSE_MOTION

+ const SPICE_MSGC_INPUTS_MOUSE_POSITION

+ const SPICE_MSGC_INPUTS_MOUSE_PRESS

+ const SPICE_MSGC_INPUTS_MOUSE_RELEASE

+ const SPICE_MSGC_MAIN_AGENT_DATA

+ const SPICE_MSGC_MAIN_AGENT_START

+ const SPICE_MSGC_MAIN_AGENT_TOKEN

+ const SPICE_MSGC_MAIN_ATTACH_CHANNELS

+ const SPICE_MSGC_MAIN_CLIENT_INFO

+ const SPICE_MSGC_MAIN_MIGRATE_CONNECTED

+ const SPICE_MSGC_MAIN_MIGRATE_CONNECT_ERROR

+ const SPICE_MSGC_MAIN_MOUSE_MODE_REQUEST

+ const SPICE_MSGC_MIGRATE_DATA

+ const SPICE_MSGC_MIGRATE_FLUSH_MARK

+ const SPICE_MSGC_PONG

+ const SPICE_MSG_CURSOR_HIDE

+ const SPICE_MSG_CURSOR_INIT

+ const SPICE_MSG_CURSOR_INVAL_ALL

+ const SPICE_MSG_CURSOR_INVAL_ONE

+ const SPICE_MSG_CURSOR_MOVE

+ const SPICE_MSG_CURSOR_RESET

+ const SPICE_MSG_CURSOR_SET

+ const SPICE_MSG_CURSOR_TRAIL

+ const SPICE_MSG_DISCONNECTING

+ const SPICE_MSG_DISPLAY_COPY_BITS

+ const SPICE_MSG_DISPLAY_DRAW_ALPHA_BLEND

+ const SPICE_MSG_DISPLAY_DRAW_BLACKNESS

+ const SPICE_MSG_DISPLAY_DRAW_BLEND

+ const SPICE_MSG_DISPLAY_DRAW_COMPOSITE

+ const SPICE_MSG_DISPLAY_DRAW_COPY

+ const SPICE_MSG_DISPLAY_DRAW_FILL

+ const SPICE_MSG_DISPLAY_DRAW_INVERS

+ const SPICE_MSG_DISPLAY_DRAW_OPAQUE

+ const SPICE_MSG_DISPLAY_DRAW_ROP3

+ const SPICE_MSG_DISPLAY_DRAW_STROKE

+ const SPICE_MSG_DISPLAY_DRAW_TEXT

+ const SPICE_MSG_DISPLAY_DRAW_TRANSPARENT

+ const SPICE_MSG_DISPLAY_DRAW_WHITENESS

+ const SPICE_MSG_DISPLAY_GL_DRAW

+ const SPICE_MSG_DISPLAY_GL_SCANOUT_UNIX

+ const SPICE_MSG_DISPLAY_INVAL_ALL_PALETTES

+ const SPICE_MSG_DISPLAY_INVAL_ALL_PIXMAPS

+ const SPICE_MSG_DISPLAY_INVAL_LIST

+ const SPICE_MSG_DISPLAY_INVAL_PALETTE

+ const SPICE_MSG_DISPLAY_MARK

+ const SPICE_MSG_DISPLAY_MODE

+ const SPICE_MSG_DISPLAY_MONITORS_CONFIG

+ const SPICE_MSG_DISPLAY_QUALITY_INDICATOR

+ const SPICE_MSG_DISPLAY_RESET

+ const SPICE_MSG_DISPLAY_STREAM_ACTIVATE_REPORT

+ const SPICE_MSG_DISPLAY_STREAM_CLIP

+ const SPICE_MSG_DISPLAY_STREAM_CREATE

+ const SPICE_MSG_DISPLAY_STREAM_DATA

+ const SPICE_MSG_DISPLAY_STREAM_DATA_SIZED

+ const SPICE_MSG_DISPLAY_STREAM_DESTROY

+ const SPICE_MSG_DISPLAY_STREAM_DESTROY_ALL

+ const SPICE_MSG_DISPLAY_SURFACE_CREATE

+ const SPICE_MSG_DISPLAY_SURFACE_DESTROY

+ const SPICE_MSG_FIRST_AVAIL

+ const SPICE_MSG_INPUTS_INIT

+ const SPICE_MSG_INPUTS_KEY_MODIFIERS

+ const SPICE_MSG_INPUTS_MOUSE_MOTION_ACK

+ const SPICE_MSG_MAIN_AGENT_CONNECTED

+ const SPICE_MSG_MAIN_AGENT_CONNECTED_TOKENS

+ const SPICE_MSG_MAIN_AGENT_DATA

+ const SPICE_MSG_MAIN_AGENT_DISCONNECTED

+ const SPICE_MSG_MAIN_AGENT_TOKEN

+ const SPICE_MSG_MAIN_CHANNELS_LIST

+ const SPICE_MSG_MAIN_INIT

+ const SPICE_MSG_MAIN_MIGRATE_BEGIN

+ const SPICE_MSG_MAIN_MIGRATE_BEGIN_SEAMLESS

+ const SPICE_MSG_MAIN_MIGRATE_CANCEL

+ const SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_ACK

+ const SPICE_MSG_MAIN_MIGRATE_DST_SEAMLESS_NACK

+ const SPICE_MSG_MAIN_MIGRATE_END

+ const SPICE_MSG_MAIN_MIGRATE_SWITCH_HOST

+ const SPICE_MSG_MAIN_MOUSE_MODE

+ const SPICE_MSG_MAIN_MULTI_MEDIA_TIME

+ const SPICE_MSG_MAIN_NAME

+ const SPICE_MSG_MAIN_UUID

+ const SPICE_MSG_MIGRATE

+ const SPICE_MSG_MIGRATE_DATA

+ const SPICE_MSG_NOTIFY

+ const SPICE_MSG_PING

+ const SPICE_MSG_PLAYBACK_DATA

+ const SPICE_MSG_PLAYBACK_LATENCY

+ const SPICE_MSG_PLAYBACK_MODE

+ const SPICE_MSG_PLAYBACK_MUTE

+ const SPICE_MSG_PLAYBACK_START

+ const SPICE_MSG_PLAYBACK_STOP

+ const SPICE_MSG_PLAYBACK_VOLUME

+ const SPICE_MSG_SET_ACK

+ const SPICE_MSG_WAIT_FOR_CHANNELS

+ const SPICE_NUM_LOCK_MODIFIER

+ const SPICE_PLAYBACK_CAP_CELT_0_5_1

+ const SPICE_PLAYBACK_CAP_LATENCY

+ const SPICE_PLAYBACK_CAP_OPUS

+ const SPICE_PLAYBACK_CAP_VOLUME

+ const SPICE_SCROLL_LOCK_MODIFIER

+ const SPICE_TICKET_PUBKEY_BYTES

+ const SPICE_VERSION_MAJOR

+ const SPICE_VERSION_MINOR

+ const SPICE_WARN_GENERAL

+ const VD_AGENT_ANNOUNCE_CAPABILITIES

+ const VD_AGENT_AUDIO_VOLUME_SYNC

+ const VD_AGENT_CAP_AUDIO_VOLUME_SYNC

+ const VD_AGENT_CAP_CLIPBOARD

+ const VD_AGENT_CAP_CLIPBOARD_BY_DEMAND

+ const VD_AGENT_CAP_CLIPBOARD_GRAB_SERIAL

+ const VD_AGENT_CAP_CLIPBOARD_NO_RELEASE_ON_REGRAB

+ const VD_AGENT_CAP_CLIPBOARD_SELECTION

+ const VD_AGENT_CAP_DISPLAY_CONFIG

+ const VD_AGENT_CAP_FILE_XFER_DETAILED_ERRORS

+ const VD_AGENT_CAP_FILE_XFER_DISABLED

+ const VD_AGENT_CAP_GRAPHICS_DEVICE_INFO

+ const VD_AGENT_CAP_GUEST_LINEEND_CRLF

+ const VD_AGENT_CAP_GUEST_LINEEND_LF

+ const VD_AGENT_CAP_MAX_CLIPBOARD

+ const VD_AGENT_CAP_MONITORS_CONFIG

+ const VD_AGENT_CAP_MONITORS_CONFIG_POSITION

+ const VD_AGENT_CAP_MOUSE_STATE

+ const VD_AGENT_CAP_REPLY

+ const VD_AGENT_CAP_SPARSE_MONITORS_CONFIG

+ const VD_AGENT_CLIENT_DISCONNECTED

+ const VD_AGENT_CLIPBOARD

+ const VD_AGENT_CLIPBOARD_GRAB

+ const VD_AGENT_CLIPBOARD_RELEASE

+ const VD_AGENT_CLIPBOARD_REQUEST

+ const VD_AGENT_DISPLAY_CONFIG

+ const VD_AGENT_FILE_XFER_DATA

+ const VD_AGENT_FILE_XFER_START

+ const VD_AGENT_FILE_XFER_STATUS

+ const VD_AGENT_FILE_XFER_STATUS_CANCELLED

+ const VD_AGENT_FILE_XFER_STATUS_CAN_SEND_DATA

+ const VD_AGENT_FILE_XFER_STATUS_DISABLED

+ const VD_AGENT_FILE_XFER_STATUS_ERROR

+ const VD_AGENT_FILE_XFER_STATUS_NOT_ENOUGH_SPACE

+ const VD_AGENT_FILE_XFER_STATUS_SESSION_LOCKED

+ const VD_AGENT_FILE_XFER_STATUS_SUCCESS

+ const VD_AGENT_FILE_XFER_STATUS_VDAGENT_NOT_CONNECTED

+ const VD_AGENT_GRAPHICS_DEVICE_INFO

+ const VD_AGENT_MAX_CLIPBOARD

+ const VD_AGENT_MAX_DATA_SIZE

+ const VD_AGENT_MONITORS_CONFIG

+ const VD_AGENT_MOUSE_STATE

+ const VD_AGENT_PROTOCOL

+ const VD_AGENT_REPLY

+ const VD_AGENT_SERVER_TOKEN_AMOUNT

+ func NewTimeBuffer(cl *Client, d *ChPlayback) *timeBuffer

+ type BitmapImageType uint8

+ const BITMAP_IMAGE_TYPE_16BIT

+ const BITMAP_IMAGE_TYPE_1BIT_BE

+ const BITMAP_IMAGE_TYPE_1BIT_LE

+ const BITMAP_IMAGE_TYPE_24BIT

+ const BITMAP_IMAGE_TYPE_32BIT

+ const BITMAP_IMAGE_TYPE_4BIT_BE

+ const BITMAP_IMAGE_TYPE_4BIT_LE

+ const BITMAP_IMAGE_TYPE_8BIT

+ const BITMAP_IMAGE_TYPE_8BIT_A

+ const BITMAP_IMAGE_TYPE_INVALID

+ const BITMAP_IMAGE_TYPE_RGBA

+ type ChCursor struct

+ type ChInputs struct

+ func (input *ChInputs) MouseDown(btn uint8, x, y uint32)

+ func (input *ChInputs) MousePosition(x, y uint32)

+ func (input *ChInputs) MouseUp(btn uint8, x, y uint32)

+ func (input *ChInputs) OnKeyDown(k []byte)

+ func (input *ChInputs) OnKeyUp(k []byte)

+ type ChMain struct

+ func (m *ChMain) AgentWrite(typ uint32, data ...interface{}) error

+ func (m *ChMain) DisplayConfig(flags, depth uint32) error

+ func (m *ChMain) MonitorConfig(flags uint32, mons []SpiceMonitor) error

+ func (m *ChMain) MouseModeRequest(mod uint32) error

+ func (m *ChMain) RequestClipboard(selection SpiceClipboardSelection, clipboardType SpiceClipboardFormat) ([]byte, error)

+ func (m *ChMain) SendGrabClipboard(selection SpiceClipboardSelection, formatTypes []SpiceClipboardFormat) error

+ type ChPlayback struct

+ type Channel uint8

+ const ChannelCursor

+ const ChannelDisplay

+ const ChannelInputs

+ const ChannelMain

+ const ChannelPlayback

+ const ChannelPort

+ const ChannelRecord

+ const ChannelSmartcard

+ const ChannelTunnel

+ const ChannelUsbRedir

+ const ChannelWebdav

+ func (c Channel) String() string

+ type Client struct

+ Debug *log.Logger

+ func New(c Connector, driver Driver, password string) (*Client, error)

+ func (client *Client) GetMute() bool

+ func (client *Client) MediaTill(t uint32) time.Duration

+ func (client *Client) MediaTime() uint32

+ func (client *Client) SetMute(muted bool)

+ func (client *Client) ToggleMute()

+ func (client *Client) UpdateView(w, h int)

+ type ClipboardData struct

+ type Connector interface

+ SpiceConnect func(compress bool) (net.Conn, error)

+ type DisplayBase struct

+ Box Rect

+ ClipType uint8

+ NumRects uint32

+ Rects []Rect

+ Surface uint32

+ func (res *DisplayBase) Decode(r *bytes.Reader) error

+ type Driver interface

+ ClipboardFetch func(selection SpiceClipboardSelection, clType SpiceClipboardFormat) ([]byte, error)

+ ClipboardGrabbed func(selection SpiceClipboardSelection, clipboardTypes []SpiceClipboardFormat)

+ ClipboardRelease func(selection SpiceClipboardSelection)

+ DisplayInit func(image.Image)

+ DisplayRefresh func()

+ SetCursor func(img image.Image, x, y uint16)

+ SetEventsTarget func(*ChInputs)

+ SetMainTarget func(*ChMain)

+ type Image struct

+ Flags uint8

+ Height uint32

+ ID uint64

+ Type uint8

+ Width uint32

+ func DecodeImage(buf []byte) (*Image, error)

+ type ImageScaleMode uint8

+ const ImageScaleModeInterpolate

+ const ImageScaleModeNearest

+ type LzImageType uint32

+ const LZ_IMAGE_TYPE_A8

+ const LZ_IMAGE_TYPE_INVALID

+ const LZ_IMAGE_TYPE_PLT1_BE

+ const LZ_IMAGE_TYPE_PLT1_LE

+ const LZ_IMAGE_TYPE_PLT4_BE

+ const LZ_IMAGE_TYPE_PLT4_LE

+ const LZ_IMAGE_TYPE_PLT8

+ const LZ_IMAGE_TYPE_RGB16

+ const LZ_IMAGE_TYPE_RGB24

+ const LZ_IMAGE_TYPE_RGB32

+ const LZ_IMAGE_TYPE_RGBA

+ const LZ_IMAGE_TYPE_XXXA

+ func (t LzImageType) String() string

+ type Point struct

+ X uint32

+ Y uint32

+ func (point *Point) Decode(r *bytes.Reader) error

+ type QMask struct

+ ImagePtr uint32

+ MaskFlags uint8

+ Pos Point

+ func (qmask *QMask) Decode(r *bytes.Reader) error

+ type Rect struct

+ Bottom uint32

+ Left uint32

+ Right uint32

+ Top uint32

+ func (rect *Rect) Decode(r *bytes.Reader) error

+ func (rect *Rect) Rectangle() image.Rectangle

+ type Ropd uint16

+ const SpiceRopdInversBrush

+ const SpiceRopdInversDest

+ const SpiceRopdInversRes

+ const SpiceRopdInversSrc

+ const SpiceRopdOpAnd

+ const SpiceRopdOpBlackness

+ const SpiceRopdOpInvers

+ const SpiceRopdOpOr

+ const SpiceRopdOpPut

+ const SpiceRopdOpWhiteness

+ const SpiceRopdOpXor

+ type SpiceChannelInfo struct

+ type SpiceClipboardFormat uint32

+ const VD_AGENT_CLIPBOARD_IMAGE_BMP

+ const VD_AGENT_CLIPBOARD_IMAGE_JPG

+ const VD_AGENT_CLIPBOARD_IMAGE_PNG

+ const VD_AGENT_CLIPBOARD_IMAGE_TIFF

+ const VD_AGENT_CLIPBOARD_NONE

+ const VD_AGENT_CLIPBOARD_UTF8_TEXT

+ type SpiceClipboardSelection uint8

+ const VD_AGENT_CLIPBOARD_SELECTION_CLIPBOARD

+ const VD_AGENT_CLIPBOARD_SELECTION_PRIMARY

+ const VD_AGENT_CLIPBOARD_SELECTION_SECONDARY

+ type SpiceConn struct

+ func (c *SpiceConn) Close() error

+ func (c *SpiceConn) Read(buf []byte) (int, error)

+ func (c *SpiceConn) ReadData(cb func(typ uint16, data []byte) error) error

+ func (c *SpiceConn) ReadError() error

+ func (c *SpiceConn) ReadFull(buf []byte) error

+ func (c *SpiceConn) ReadLoop()

+ func (c *SpiceConn) String() string

+ func (c *SpiceConn) Write(buf []byte) (int, error)

+ func (c *SpiceConn) WriteMessage(typ uint16, data ...interface{}) error

+ type SpiceDisplay struct

+ type SpiceError uint32

+ const ErrSpiceLinkBadConnectionId

+ const ErrSpiceLinkChannelNotAvailable

+ const ErrSpiceLinkError

+ const ErrSpiceLinkInvalidData

+ const ErrSpiceLinkInvalidMagic

+ const ErrSpiceLinkNeedSecured

+ const ErrSpiceLinkNeedUnsecured

+ const ErrSpiceLinkOk

+ const ErrSpiceLinkPermissionDenied

+ const ErrSpiceLinkVersionMismatch

+ func (e SpiceError) Error() string

+ type SpiceMonitor struct

+ Depth uint32

+ Height uint32

+ Width uint32

+ X uint32

+ Y uint32

+ type SpiceRecord struct

+ type SpiceWebdav struct

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL