From 5a9e5fdf3b74f241d50fc5e6e7c2ab1714def7eb Mon Sep 17 00:00:00 2001 From: andersevenrud Date: Sun, 18 Aug 2024 22:33:27 +0000 Subject: [PATCH] deploy: fe165dea477be3194e9a655e1b4ca770e1e5eee8 --- ts/docs/classes/XpraAudio.html | 2 +- ts/docs/classes/XpraAudioAdapter.html | 2 +- ts/docs/classes/XpraAuroraAdapter.html | 2 +- ts/docs/classes/XpraClient.html | 2 +- ts/docs/classes/XpraClipboard.html | 2 +- ts/docs/classes/XpraDecodeNullWorker.html | 6 +-- ts/docs/classes/XpraDecodeWebWorker.html | 6 +-- ts/docs/classes/XpraDecodeWorker.html | 6 +-- ts/docs/classes/XpraKeyboard.html | 2 +- ts/docs/classes/XpraLogger.html | 2 +- ts/docs/classes/XpraMediaSourceAdapter.html | 2 +- ts/docs/classes/XpraMouse.html | 2 +- ts/docs/classes/XpraPacketNullWorker.html | 6 +-- ts/docs/classes/XpraPacketWebWorker.html | 6 +-- ts/docs/classes/XpraPacketWorker.html | 6 +-- ts/docs/classes/XpraQueue.html | 2 +- ts/docs/classes/XpraRecieveQueue.html | 2 +- ts/docs/classes/XpraSendQueue.html | 2 +- ts/docs/classes/XpraWebsocket.html | 2 +- ts/docs/classes/XpraWindowManager.html | 2 +- ts/docs/classes/XpraWorker.html | 6 +-- ts/docs/classes/XpraWorkerProxy.html | 2 +- ts/docs/enums/XpraEncodeBit.html | 2 +- ts/docs/enums/XpraInflateBit.html | 2 +- ts/docs/enums/XpraLogLevel.html | 2 +- ts/docs/interfaces/BrowserFile.html | 2 +- ts/docs/interfaces/XpraAudioOptions.html | 2 +- ts/docs/interfaces/XpraBaseCapability.html | 2 +- ts/docs/interfaces/XpraChallengePrompt.html | 2 +- ts/docs/interfaces/XpraCipher.html | 2 +- ts/docs/interfaces/XpraCipherCapability.html | 2 +- .../interfaces/XpraClientConfiguration.html | 2 +- ts/docs/interfaces/XpraCommonCapability.html | 2 +- ts/docs/interfaces/XpraConnectionOptions.html | 2 +- ts/docs/interfaces/XpraConnectionStats.html | 2 +- ts/docs/interfaces/XpraCursor.html | 2 +- ts/docs/interfaces/XpraDraw.html | 2 +- ts/docs/interfaces/XpraDrawOptions.html | 2 +- .../interfaces/XpraEncodingCapability.html | 2 +- ts/docs/interfaces/XpraNotification.html | 2 +- ts/docs/interfaces/XpraPointerPosition.html | 2 +- ts/docs/interfaces/XpraSendFile.html | 2 +- .../interfaces/XpraServerBaseCapability.html | 2 +- ts/docs/interfaces/XpraSoundCapability.html | 2 +- ts/docs/interfaces/XpraStartNewSession.html | 2 +- ts/docs/interfaces/XpraWindow.html | 2 +- ts/docs/interfaces/XpraWindowIcon.html | 2 +- .../XpraWindowInitiateMoveResize.html | 2 +- .../interfaces/XpraWindowManagerWindow.html | 2 +- ts/docs/interfaces/XpraWindowMetadata.html | 2 +- .../interfaces/XpraWindowMetadataUpdate.html | 2 +- ts/docs/interfaces/XpraWindowMoveResize.html | 2 +- ts/docs/interfaces/XpraWindowState.html | 2 +- ts/docs/interfaces/XpraXDGEntryData.html | 2 +- ts/docs/interfaces/XpraXDGMenuData.html | 2 +- .../interfaces/XpraXDGReducedMenuEntry.html | 2 +- ts/docs/modules.html | 52 +++++++++---------- 57 files changed, 96 insertions(+), 96 deletions(-) diff --git a/ts/docs/classes/XpraAudio.html b/ts/docs/classes/XpraAudio.html index 45e244cf..807e4c0f 100644 --- a/ts/docs/classes/XpraAudio.html +++ b/ts/docs/classes/XpraAudio.html @@ -1,3 +1,3 @@ XpraAudio | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraAudio

Provides audio playback for a client session

-

Hierarchy

Index

Properties

Methods

Properties

Private adapter

adapter: null | XpraAudioAdapter = null

Private Readonly audio

audio: HTMLAudioElement = ...

Private audioCodec

audioCodec: null | string = null

Methods

addQueue

Private detect

init

  • init(): Promise<void>

setup

start

  • start(): Promise<void>

stop

  • stop(): void

validate

  • validate(codec: string): boolean

Static Private detectCodec

Static Private getAudioAdapters

Static getAudioCodecs

  • getAudioCodecs(): string[]

Static Private getBestCodec

  • getBestCodec(supported: Record<string, string>): null | string

Static Private getDefaultAudioCodec

  • getDefaultAudioCodec(): null | string

Static Private getPreferedServerCodec

  • getPreferedServerCodec(encoders: string[]): undefined | string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Methods

Properties

Private adapter

adapter: null | XpraAudioAdapter = null

Private Readonly audio

audio: HTMLAudioElement = ...

Private audioCodec

audioCodec: null | string = null

Methods

addQueue

Private detect

init

  • init(): Promise<void>

setup

start

  • start(): Promise<void>

stop

  • stop(): void

validate

  • validate(codec: string): boolean

Static Private detectCodec

Static Private getAudioAdapters

Static getAudioCodecs

  • getAudioCodecs(): string[]

Static Private getBestCodec

  • getBestCodec(supported: Record<string, string>): null | string

Static Private getDefaultAudioCodec

  • getDefaultAudioCodec(): null | string

Static Private getPreferedServerCodec

  • getPreferedServerCodec(encoders: string[]): undefined | string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraAudioAdapter.html b/ts/docs/classes/XpraAudioAdapter.html index 016f96d5..565c6536 100644 --- a/ts/docs/classes/XpraAudioAdapter.html +++ b/ts/docs/classes/XpraAudioAdapter.html @@ -1,3 +1,3 @@ XpraAudioAdapter | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraAudioAdapter

Provides audio buffer queues to adapters

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Private audioBuffer

audioBuffer: Uint8Array[] = []

Private audioBufferCount

audioBufferCount: number = 0

Protected Readonly audioCodec

audioCodec: string

Methods

addQueue

Protected isReady

  • isReady(): boolean

Private processQueue

  • processQueue(minStartBuffers: number): void

Protected pushBuffer

  • pushBuffer(_buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Private audioBuffer

audioBuffer: Uint8Array[] = []

Private audioBufferCount

audioBufferCount: number = 0

Protected Readonly audioCodec

audioCodec: string

Methods

addQueue

Protected isReady

  • isReady(): boolean

Private processQueue

  • processQueue(minStartBuffers: number): void

Protected pushBuffer

  • pushBuffer(_buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraAuroraAdapter.html b/ts/docs/classes/XpraAuroraAdapter.html index 0f06b135..e361adad 100644 --- a/ts/docs/classes/XpraAuroraAdapter.html +++ b/ts/docs/classes/XpraAuroraAdapter.html @@ -1,3 +1,3 @@ XpraAuroraAdapter | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraAuroraAdapter

Aurora Audio Adapter

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Protected Readonly audioCodec

audioCodec: string

Private auroraSource

auroraSource: null | XpraSource = null

Methods

addQueue

Protected isReady

  • isReady(): boolean

Protected pushBuffer

  • pushBuffer(buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Static getCodecs

Static getSupportedCodecs

  • getSupportedCodecs(): any

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Protected Readonly audioCodec

audioCodec: string

Private auroraSource

auroraSource: null | XpraSource = null

Methods

addQueue

Protected isReady

  • isReady(): boolean

Protected pushBuffer

  • pushBuffer(buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Static getCodecs

Static getSupportedCodecs

  • getSupportedCodecs(): any

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraClient.html b/ts/docs/classes/XpraClient.html index 3bd3594e..109ba49a 100644 --- a/ts/docs/classes/XpraClient.html +++ b/ts/docs/classes/XpraClient.html @@ -1,4 +1,4 @@ XpraClient | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraClient

The Xpra Client. Handles connections and I/O for Xpra sessions.

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly audio

audio: XpraAudio = ...

Private capabilities

capabilities: XpraCapabilities = ...

Readonly clipboard

clipboard: XpraClipboard = ...

Private connectionCheckTimeout

connectionCheckTimeout: number = 0

Private inited

inited: boolean = false

Readonly keyboard

keyboard: XpraKeyboard = ...

Readonly logger

logger: XpraLogger = ...

Readonly mouse

mouse: XpraMouse = ...

Private options

options: XpraConnectionOptions = ...

Private pingInterval

pingInterval: number = 0

Private processorBindings

processorBindings: Record<XpraRecievePacketType, (...args: XpraPacketArguments) => void> = ...

Private Readonly proxy

proxy: XpraWorkerProxy = ...

Private serverCapabilities

serverCapabilities: null | XpraServerCapabilities = null

Private started

started: boolean = false

Private stats

stats: XpraConnectionStats = ...

Private Readonly ws

ws: XpraWebsocket = ...

Methods

Private challenge

  • challenge(serverSalt: string, digest: string, saltDigest: string, password: string): void

Private clearTimers

  • clearTimers(): void

connect

Private createCapabilities

disconnect

  • disconnect(error?: Error): void

getCapabilities

  • getCapabilities(): { argv: string[]; auto_refresh_delay: number; bandwidth-limit: number; bell: boolean; bencode: boolean; brotli: boolean; build.branch: string; build.local_modifications: number; build.revision: string; challenge_client_salt?: string; challenge_response?: string; cipher?: string; cipher.iv?: string; cipher.key_hash?: string; cipher.key_salt?: string; cipher.key_size?: number; cipher.key_stretch?: string; cipher.key_stretch_iterations?: number; cipher.mode?: string; cipher.padding.options?: string[]; client_type: string; clipboard: boolean; clipboard.contents-slice-fix: boolean; clipboard.greedy: boolean; clipboard.preferred-targets: string[]; clipboard.selections: XpraClipboardSelection[]; clipboard.want_targets: boolean; compression_level: number; connection-data: Record<string, string | number>; cursors: boolean; desktop_mode_size: XpraVector; desktop_size: XpraVector; digest: string[]; display: string; dpi: number; encoding: XpraPacketEncoder; encoding.color-gamut: string; encoding.decoder-speed: { video: number }; encoding.eos: boolean; encoding.flush: boolean; encoding.full_csc_modes: Record<string, string[]>; encoding.h264+mp4.: number; encoding.h264+mp4.YUV420P.level: string; encoding.h264+mp4.YUV420P.profile: string; encoding.h264+mp4.score-delta: number; encoding.h264.YUV420P.level: string; encoding.h264.YUV420P.profile: string; encoding.h264.cabac: boolean; encoding.h264.deblocking-filter: boolean; encoding.h264.fast-decode: boolean; encoding.h264.score-delta: number; encoding.icons.max_size: XpraVector; encoding.mpeg4+mp4.score-delta: number; encoding.rgb_lz4: boolean; encoding.rgb_zlib: boolean; encoding.scrolling: boolean; encoding.transparency: boolean; encoding.video_max_size: XpraVector; encoding.video_scaling: boolean; encoding.vp8+webm.score-delta: number; encoding.x264.YUV420P.profile: string; encodings: XpraDrawEncoding[]; encodings.core: XpraDrawEncoding[]; encodings.cursor: string[]; encodings.packet: boolean; encodings.rgb_formats: XpraRGBFormats[]; encodings.window-icon: string[]; file-size-limit: number; file-transfer: boolean; flush: boolean; keyboard: boolean; lz4: boolean; metadata.supported: string[]; mouse.show: boolean; named_cursors: boolean; namespace: boolean; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-url: boolean; ping-echo-sourceid: boolean; platform: string; platform.name: string; platform.platform: string; platform.processor: string; printing: boolean; randr_notify: boolean; rencode: boolean; rencodeplus: boolean; salt-digest: string[]; screen-resize-bigger: boolean; screen_sizes: XpraScreen[]; server-window-resize: boolean; session-type: string; session-type.full: string; setting-change: boolean; share: boolean; sound.bundle-metadata: boolean; sound.decoders: string[]; sound.receive: boolean; sound.send: boolean; sound.server_driven: boolean; start-new-session?: Partial<XpraStartNewSession>; steal: boolean; system_tray: boolean; username: string; uuid: string; version: string; vrefresh: number; websocket.multi-packet: boolean; window.pre-map: boolean; windows: boolean; xdg-menu-update: boolean; xkbmap_keycodes: XpraXkbpMapKeycode[]; xkbmap_layout: string; xkbmap_print: string; xkbmap_query: string; yaml: boolean; zlib: boolean }

  • Returns { argv: string[]; auto_refresh_delay: number; bandwidth-limit: number; bell: boolean; bencode: boolean; brotli: boolean; build.branch: string; build.local_modifications: number; build.revision: string; challenge_client_salt?: string; challenge_response?: string; cipher?: string; cipher.iv?: string; cipher.key_hash?: string; cipher.key_salt?: string; cipher.key_size?: number; cipher.key_stretch?: string; cipher.key_stretch_iterations?: number; cipher.mode?: string; cipher.padding.options?: string[]; client_type: string; clipboard: boolean; clipboard.contents-slice-fix: boolean; clipboard.greedy: boolean; clipboard.preferred-targets: string[]; clipboard.selections: XpraClipboardSelection[]; clipboard.want_targets: boolean; compression_level: number; connection-data: Record<string, string | number>; cursors: boolean; desktop_mode_size: XpraVector; desktop_size: XpraVector; digest: string[]; display: string; dpi: number; encoding: XpraPacketEncoder; encoding.color-gamut: string; encoding.decoder-speed: { video: number }; encoding.eos: boolean; encoding.flush: boolean; encoding.full_csc_modes: Record<string, string[]>; encoding.h264+mp4.: number; encoding.h264+mp4.YUV420P.level: string; encoding.h264+mp4.YUV420P.profile: string; encoding.h264+mp4.score-delta: number; encoding.h264.YUV420P.level: string; encoding.h264.YUV420P.profile: string; encoding.h264.cabac: boolean; encoding.h264.deblocking-filter: boolean; encoding.h264.fast-decode: boolean; encoding.h264.score-delta: number; encoding.icons.max_size: XpraVector; encoding.mpeg4+mp4.score-delta: number; encoding.rgb_lz4: boolean; encoding.rgb_zlib: boolean; encoding.scrolling: boolean; encoding.transparency: boolean; encoding.video_max_size: XpraVector; encoding.video_scaling: boolean; encoding.vp8+webm.score-delta: number; encoding.x264.YUV420P.profile: string; encodings: XpraDrawEncoding[]; encodings.core: XpraDrawEncoding[]; encodings.cursor: string[]; encodings.packet: boolean; encodings.rgb_formats: XpraRGBFormats[]; encodings.window-icon: string[]; file-size-limit: number; file-transfer: boolean; flush: boolean; keyboard: boolean; lz4: boolean; metadata.supported: string[]; mouse.show: boolean; named_cursors: boolean; namespace: boolean; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-url: boolean; ping-echo-sourceid: boolean; platform: string; platform.name: string; platform.platform: string; platform.processor: string; printing: boolean; randr_notify: boolean; rencode: boolean; rencodeplus: boolean; salt-digest: string[]; screen-resize-bigger: boolean; screen_sizes: XpraScreen[]; server-window-resize: boolean; session-type: string; session-type.full: string; setting-change: boolean; share: boolean; sound.bundle-metadata: boolean; sound.decoders: string[]; sound.receive: boolean; sound.send: boolean; sound.server_driven: boolean; start-new-session?: Partial<XpraStartNewSession>; steal: boolean; system_tray: boolean; username: string; uuid: string; version: string; vrefresh: number; websocket.multi-packet: boolean; window.pre-map: boolean; windows: boolean; xdg-menu-update: boolean; xkbmap_keycodes: XpraXkbpMapKeycode[]; xkbmap_layout: string; xkbmap_print: string; xkbmap_query: string; yaml: boolean; zlib: boolean }

    • argv: string[]
    • auto_refresh_delay: number
    • bandwidth-limit: number
    • bell: boolean
    • bencode: boolean
    • brotli: boolean
    • build.branch: string
    • build.local_modifications: number
    • build.revision: string
    • Optional challenge_client_salt?: string
    • Optional challenge_response?: string
    • Optional cipher?: string
    • Optional cipher.iv?: string
    • Optional cipher.key_hash?: string
    • Optional cipher.key_salt?: string
    • Optional cipher.key_size?: number
    • Optional cipher.key_stretch?: string
    • Optional cipher.key_stretch_iterations?: number
    • Optional cipher.mode?: string
    • Optional cipher.padding.options?: string[]
    • client_type: string
    • clipboard: boolean
    • clipboard.contents-slice-fix: boolean
    • clipboard.greedy: boolean
    • clipboard.preferred-targets: string[]
    • clipboard.selections: XpraClipboardSelection[]
    • clipboard.want_targets: boolean
    • compression_level: number
    • connection-data: Record<string, string | number>
    • cursors: boolean
    • desktop_mode_size: XpraVector
    • desktop_size: XpraVector
    • digest: string[]
    • display: string
    • dpi: number
    • encoding: XpraPacketEncoder
    • encoding.color-gamut: string
    • encoding.decoder-speed: { video: number }
      • video: number
    • encoding.eos: boolean
    • encoding.flush: boolean
    • encoding.full_csc_modes: Record<string, string[]>
    • encoding.h264+mp4.: number
    • encoding.h264+mp4.YUV420P.level: string
    • encoding.h264+mp4.YUV420P.profile: string
    • encoding.h264+mp4.score-delta: number
    • encoding.h264.YUV420P.level: string
    • encoding.h264.YUV420P.profile: string
    • encoding.h264.cabac: boolean
    • encoding.h264.deblocking-filter: boolean
    • encoding.h264.fast-decode: boolean
    • encoding.h264.score-delta: number
    • encoding.icons.max_size: XpraVector
    • encoding.mpeg4+mp4.score-delta: number
    • encoding.rgb_lz4: boolean
    • encoding.rgb_zlib: boolean
    • encoding.scrolling: boolean
    • encoding.transparency: boolean
    • encoding.video_max_size: XpraVector
    • encoding.video_scaling: boolean
    • encoding.vp8+webm.score-delta: number
    • encoding.x264.YUV420P.profile: string
    • encodings: XpraDrawEncoding[]
    • encodings.core: XpraDrawEncoding[]
    • encodings.cursor: string[]
    • encodings.packet: boolean
    • encodings.rgb_formats: XpraRGBFormats[]
    • encodings.window-icon: string[]
    • file-size-limit: number
    • file-transfer: boolean
    • flush: boolean
    • keyboard: boolean
    • lz4: boolean
    • metadata.supported: string[]
    • mouse.show: boolean
    • named_cursors: boolean
    • namespace: boolean
    • notifications: boolean
    • notifications.actions: boolean
    • notifications.close: boolean
    • open-url: boolean
    • ping-echo-sourceid: boolean
    • platform: string
    • platform.name: string
    • platform.platform: string
    • platform.processor: string
    • printing: boolean
    • randr_notify: boolean
    • rencode: boolean
    • rencodeplus: boolean
    • salt-digest: string[]
    • screen-resize-bigger: boolean
    • screen_sizes: XpraScreen[]
    • server-window-resize: boolean
    • session-type: string
    • session-type.full: string
    • setting-change: boolean
    • share: boolean
    • sound.bundle-metadata: boolean
    • sound.decoders: string[]
    • sound.receive: boolean
    • sound.send: boolean
    • sound.server_driven: boolean
    • Optional start-new-session?: Partial<XpraStartNewSession>
    • steal: boolean
    • system_tray: boolean
    • username: string
    • uuid: string
    • version: string
    • vrefresh: number
    • websocket.multi-packet: boolean
    • window.pre-map: boolean
    • windows: boolean
    • xdg-menu-update: boolean
    • xkbmap_keycodes: XpraXkbpMapKeycode[]
    • xkbmap_layout: string
    • xkbmap_print: string
    • xkbmap_query: string
    • yaml: boolean
    • zlib: boolean

getOptions

  • getOptions(): { audio: boolean; bandWidthLimit: number; bell: boolean; clipboard: boolean; clipboardDirection: XpraClipboardDirection; clipboardImages: boolean; connectionTimeout: number; cursor: boolean; debugPackets: string[]; display: string; encoder: XpraPacketEncoder; encryption: null | string; encryptionKey: string; exitWithChildren: boolean; exitWithClient: boolean; fileTransfer: boolean; keyboard: boolean; keyboardLayout: string; mouse: boolean; nativeVideo: boolean; notifications: boolean; openUrl: boolean; password: string; pingInterval: number; printing: boolean; reconnect: boolean; reconnectAttempts: number; reconnectInterval: number; reverseScrollX: boolean; reverseScrollY: boolean; shareSession: boolean; showStartMenu: boolean; showStatistics: boolean; ssl: boolean; startCommand: string; startNewSession: null | XpraStartNewSessionMode; stealSession: boolean; swapKeys: boolean; tray: boolean; username: string; video: boolean }

  • Returns { audio: boolean; bandWidthLimit: number; bell: boolean; clipboard: boolean; clipboardDirection: XpraClipboardDirection; clipboardImages: boolean; connectionTimeout: number; cursor: boolean; debugPackets: string[]; display: string; encoder: XpraPacketEncoder; encryption: null | string; encryptionKey: string; exitWithChildren: boolean; exitWithClient: boolean; fileTransfer: boolean; keyboard: boolean; keyboardLayout: string; mouse: boolean; nativeVideo: boolean; notifications: boolean; openUrl: boolean; password: string; pingInterval: number; printing: boolean; reconnect: boolean; reconnectAttempts: number; reconnectInterval: number; reverseScrollX: boolean; reverseScrollY: boolean; shareSession: boolean; showStartMenu: boolean; showStatistics: boolean; ssl: boolean; startCommand: string; startNewSession: null | XpraStartNewSessionMode; stealSession: boolean; swapKeys: boolean; tray: boolean; username: string; video: boolean }

    • audio: boolean
    • bandWidthLimit: number
    • bell: boolean
    • clipboard: boolean
    • clipboardDirection: XpraClipboardDirection
    • clipboardImages: boolean
    • connectionTimeout: number
    • cursor: boolean
    • debugPackets: string[]
    • display: string
    • encoder: XpraPacketEncoder
    • encryption: null | string
    • encryptionKey: string
    • exitWithChildren: boolean
    • exitWithClient: boolean
    • fileTransfer: boolean
    • keyboard: boolean
    • keyboardLayout: string
    • mouse: boolean
    • nativeVideo: boolean
    • notifications: boolean
    • openUrl: boolean
    • password: string
    • pingInterval: number
    • printing: boolean
    • reconnect: boolean
    • reconnectAttempts: number
    • reconnectInterval: number
    • reverseScrollX: boolean
    • reverseScrollY: boolean
    • shareSession: boolean
    • showStartMenu: boolean
    • showStatistics: boolean
    • ssl: boolean
    • startCommand: string
    • startNewSession: null | XpraStartNewSessionMode
    • stealSession: boolean
    • swapKeys: boolean
    • tray: boolean
    • username: string
    • video: boolean

getServerCapabilities

  • getServerCapabilities(): null | { actual_desktop_size: XpraVector; aliases: boolean; auto-video-encoding: boolean; auto_refresh_delay: number; av-sync: boolean; av-sync.enabled: boolean; bell: boolean; bencode: boolean; bencode.version: string; build.bit: string; build.branch: string; build.commit: string; build.compiler: string; build.cpu: string; build.cython: string; build.date: string; build.lib.gobject_introspection: string; build.lib.gtk: string; build.lib.gtk_x11: string; build.lib.nvenc: string; build.lib.nvfbc: string; build.lib.py3cairo: string; build.lib.pygobject: string; build.lib.python3: string; build.lib.vpx: string; build.lib.x11: string; build.lib.x264: string; build.lib.x265: string; build.lib.xcomposite: string; build.lib.xdamage: string; build.lib.xext: string; build.lib.xfixes: string; build.lib.xkbfile: string; build.lib.xrandr: string; build.lib.xtst: string; build.linker: string; build.local_modifications: number; build.python: string; build.revision: string; build.time: string; build.version: string; byteorder: string; cairo.version: string; client-shutdown: boolean; clipboard: boolean; clipboard-direction: string; clipboard.contents-slice-fix: boolean; clipboard.enable-selections: boolean; clipboard.loop-uuids.CLIPBOARD: string; clipboard.loop-uuids.PRIMARY: string; clipboard.loop-uuids.SECONDARY: string; clipboard.preferred-targets: string[]; clipboards: string[]; compressors: string[]; configure.pointer: boolean; connection-data: Record<string, string | number>; current_time: number; cursor.default_size: XpraVector; cursor.max_size: XpraVector; cursors: boolean; dbus_proxy: boolean; desktop_size: XpraVector; digest: string[]; display: string; elapsed_time: number; encoders: XpraCompressor[]; encoding: XpraPacketEncoder; exit-with-children: boolean; file-ask-timeout: number; file-chunks: number; file-size-limit: number; file-transfer: boolean; file-transfer-ask: boolean; flush: boolean; force_ungrab: string; gdk.version: string; gi.version: string; gid: number; glib.version: string; gobject.version: string; gtk.version: string; hostname: string; input-devices: string[]; key_repeat: number[]; key_repeat_modifiers: boolean; keyboard: boolean; keyboard.fast-switching: boolean; lock: boolean; lock-toggle: boolean; lz4.python-lz4: boolean; lz4.python-lz4.version: boolean; lz4.version: string; machine_id: string; max-file-size: number; max_desktop_size: XpraVector; modifier_keycodes?: XpraModifierKeycodes; network.bandwidth-limit: number; network.bandwidth-limit-change: boolean; none: boolean; none.version: string; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-files: boolean; open-files-ask: boolean; open-url: boolean; open-url-ask: boolean; opengl: boolean; pango.version: string; pid: number; ping-echo-sourceid: boolean; pixbuf.version: string; platform: string; platform.architecture: string; platform.linux_distribution: string; platform.machine: string; platform.name: string; platform.platform: string; platform.processor: string; platform.release: string; platform.sysrelease: string; pointer: boolean; pointer.grabs: boolean; pointer.relative: boolean; printer.attributes: string[]; printing: boolean; printing-ask: boolean; python.bits: number; python.full_version: string; python.version: string; readonly: boolean; readonly-server: boolean; remote-logging: boolean; remote-logging.multi-line: boolean; remote-logging.receive: boolean; remote-logging.send: boolean; rencode: boolean; rencode.version: string; request-file: boolean; resize_exact: string; resize_screen: string; root_window_size: XpraVector; rpc-types: string[]; salt-digest: string[]; screen-sizes: XpraVector[]; server-commands-info: boolean; server-commands-signals: string[]; server-log: string; server.mode: string; server_type: string; session_name: string; sharing: boolean; sharing-toggle: boolean; shell: boolean; sound.bundle-metadata: boolean; sound.codec-full-names: boolean; sound.decoders: string[]; sound.demuxers: string[]; sound.device.Xpra-Microphone: string; sound.device.Xpra-Microphone.monitor: string; sound.device.Xpra-Speaker: string; sound.device.Xpra-Speaker.monitor: string; sound.devices: number; sound.encoders: string[]; sound.gst.version: string; sound.muxers: string[]; sound.ogg-latency-fix: boolean; sound.plugins: string[]; sound.pulseaudio.cookie-hash: string; sound.pulseaudio.found: boolean; sound.pulseaudio.id: string; sound.pulseaudio.server: string; sound.pulseaudio.wrapper: string; sound.pygst.version: string; sound.python.bits: number; sound.python.version: string; sound.receive: boolean; sound.send: boolean; sound.sink.default: string[]; sound.sinks: string[]; sound.source.default: string[]; sound.sources: string[]; start-new-commands: boolean; start_time: number; subcommands: string[]; toggle_keyboard_sync: boolean; touchpad-device: boolean; uid: number; uuid: string; version: string; virtual-video-devices: string[]; webcam: boolean; webcam.encodings: string[]; wheel.precise: boolean; window-filters: boolean; window.configure.delta: boolean; window.decorations: boolean; window.dragndrop: boolean; window.frame-extents: boolean; window.signals: string[]; window.states: string[]; window_refresh_config: boolean; windows: boolean; xdg-menu: boolean; xdg-menu-update: boolean; yaml: boolean; yaml.version: string; zlib: boolean; zlib.python-zlib: boolean; zlib.python-zlib.version: string }

  • Returns null | { actual_desktop_size: XpraVector; aliases: boolean; auto-video-encoding: boolean; auto_refresh_delay: number; av-sync: boolean; av-sync.enabled: boolean; bell: boolean; bencode: boolean; bencode.version: string; build.bit: string; build.branch: string; build.commit: string; build.compiler: string; build.cpu: string; build.cython: string; build.date: string; build.lib.gobject_introspection: string; build.lib.gtk: string; build.lib.gtk_x11: string; build.lib.nvenc: string; build.lib.nvfbc: string; build.lib.py3cairo: string; build.lib.pygobject: string; build.lib.python3: string; build.lib.vpx: string; build.lib.x11: string; build.lib.x264: string; build.lib.x265: string; build.lib.xcomposite: string; build.lib.xdamage: string; build.lib.xext: string; build.lib.xfixes: string; build.lib.xkbfile: string; build.lib.xrandr: string; build.lib.xtst: string; build.linker: string; build.local_modifications: number; build.python: string; build.revision: string; build.time: string; build.version: string; byteorder: string; cairo.version: string; client-shutdown: boolean; clipboard: boolean; clipboard-direction: string; clipboard.contents-slice-fix: boolean; clipboard.enable-selections: boolean; clipboard.loop-uuids.CLIPBOARD: string; clipboard.loop-uuids.PRIMARY: string; clipboard.loop-uuids.SECONDARY: string; clipboard.preferred-targets: string[]; clipboards: string[]; compressors: string[]; configure.pointer: boolean; connection-data: Record<string, string | number>; current_time: number; cursor.default_size: XpraVector; cursor.max_size: XpraVector; cursors: boolean; dbus_proxy: boolean; desktop_size: XpraVector; digest: string[]; display: string; elapsed_time: number; encoders: XpraCompressor[]; encoding: XpraPacketEncoder; exit-with-children: boolean; file-ask-timeout: number; file-chunks: number; file-size-limit: number; file-transfer: boolean; file-transfer-ask: boolean; flush: boolean; force_ungrab: string; gdk.version: string; gi.version: string; gid: number; glib.version: string; gobject.version: string; gtk.version: string; hostname: string; input-devices: string[]; key_repeat: number[]; key_repeat_modifiers: boolean; keyboard: boolean; keyboard.fast-switching: boolean; lock: boolean; lock-toggle: boolean; lz4.python-lz4: boolean; lz4.python-lz4.version: boolean; lz4.version: string; machine_id: string; max-file-size: number; max_desktop_size: XpraVector; modifier_keycodes?: XpraModifierKeycodes; network.bandwidth-limit: number; network.bandwidth-limit-change: boolean; none: boolean; none.version: string; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-files: boolean; open-files-ask: boolean; open-url: boolean; open-url-ask: boolean; opengl: boolean; pango.version: string; pid: number; ping-echo-sourceid: boolean; pixbuf.version: string; platform: string; platform.architecture: string; platform.linux_distribution: string; platform.machine: string; platform.name: string; platform.platform: string; platform.processor: string; platform.release: string; platform.sysrelease: string; pointer: boolean; pointer.grabs: boolean; pointer.relative: boolean; printer.attributes: string[]; printing: boolean; printing-ask: boolean; python.bits: number; python.full_version: string; python.version: string; readonly: boolean; readonly-server: boolean; remote-logging: boolean; remote-logging.multi-line: boolean; remote-logging.receive: boolean; remote-logging.send: boolean; rencode: boolean; rencode.version: string; request-file: boolean; resize_exact: string; resize_screen: string; root_window_size: XpraVector; rpc-types: string[]; salt-digest: string[]; screen-sizes: XpraVector[]; server-commands-info: boolean; server-commands-signals: string[]; server-log: string; server.mode: string; server_type: string; session_name: string; sharing: boolean; sharing-toggle: boolean; shell: boolean; sound.bundle-metadata: boolean; sound.codec-full-names: boolean; sound.decoders: string[]; sound.demuxers: string[]; sound.device.Xpra-Microphone: string; sound.device.Xpra-Microphone.monitor: string; sound.device.Xpra-Speaker: string; sound.device.Xpra-Speaker.monitor: string; sound.devices: number; sound.encoders: string[]; sound.gst.version: string; sound.muxers: string[]; sound.ogg-latency-fix: boolean; sound.plugins: string[]; sound.pulseaudio.cookie-hash: string; sound.pulseaudio.found: boolean; sound.pulseaudio.id: string; sound.pulseaudio.server: string; sound.pulseaudio.wrapper: string; sound.pygst.version: string; sound.python.bits: number; sound.python.version: string; sound.receive: boolean; sound.send: boolean; sound.sink.default: string[]; sound.sinks: string[]; sound.source.default: string[]; sound.sources: string[]; start-new-commands: boolean; start_time: number; subcommands: string[]; toggle_keyboard_sync: boolean; touchpad-device: boolean; uid: number; uuid: string; version: string; virtual-video-devices: string[]; webcam: boolean; webcam.encodings: string[]; wheel.precise: boolean; window-filters: boolean; window.configure.delta: boolean; window.decorations: boolean; window.dragndrop: boolean; window.frame-extents: boolean; window.signals: string[]; window.states: string[]; window_refresh_config: boolean; windows: boolean; xdg-menu: boolean; xdg-menu-update: boolean; yaml: boolean; yaml.version: string; zlib: boolean; zlib.python-zlib: boolean; zlib.python-zlib.version: string }

Private handshake

  • handshake(): void

init

  • init(): Promise<void>

isReadOnly

  • isReadOnly(): boolean

isReady

  • isReady(): boolean

Private processBell

  • processBell(): void

Private processChallenge

  • processChallenge(serverSalt: string, cipherOutCaps: XpraCipherCapability, digest: string, saltDigest: string, prompt: string): void

Private processClipboardRequest

Private processClipboardToken

Private processCloseNotification

  • processCloseNotification(id: number): void

Private processConfigureOverrideRedirect

  • processConfigureOverrideRedirect(wid: number, x: number, y: number, w: number, h: number): void

Private processCursor

  • processCursor(encoding: string, _unknown1: number, _unknown2: number, w: number, h: number, xhot: number, yhot: number, _unknown3: number, data: string): void

Private processDisconnect

  • processDisconnect(message: string): void

Private processDraw

Private processEncodings

  • processEncodings(caps: string[]): void

Private processEos

  • processEos(wid: number): void

Private processHello

Private processInfoResponse

Private processInitiateMoveResize

  • processInitiateMoveResize(wid: number, xRoot: number, yRoot: number, direction: number, button: number, sourceIndication: number): void

Private processNewOverrideRedirect

Private processNewTray

  • processNewTray(id: number, iw: string | number, ih: string | number, metadata: XpraWindowMetadata): void

Private processNewWindow

Private processOpenUrl

  • processOpenUrl(url: string): void

Private processPing

  • processPing(...packet: number[]): void

Private processPingEcho

  • processPingEcho(last: number, l1: number, l2: number, l3: number, latency: number): void

Private processPointerPosition

  • processPointerPosition(wid: number, ix: string | number, iy: string | number): void

Private processSendFile

  • processSendFile(filename: string, mime: string, print: number, size: number, data: Uint8Array): void

Private processSetClipboardEnabled

  • processSetClipboardEnabled(enabled: number | boolean): void

Private processSettingChange

Private processShowNotification

  • processShowNotification(_unknown1: string, id: number, _unknown2: string, replacesId: number, _unknown3: string, summary: string, body: string, expires: number, icon: null | [string, number, number, string | Uint8Array], actions: string[], hints: string[]): void

  • Parameters

    • _unknown1: string
    • id: number
    • _unknown2: string
    • replacesId: number
    • _unknown3: string
    • summary: string
    • body: string
    • expires: number
    • icon: null | [string, number, number, string | Uint8Array]
    • actions: string[]
    • hints: string[]

    Returns void

Private processSoundData

Private processStartupComplete

  • processStartupComplete(): void

Private processWindowIcon

  • processWindowIcon(wid: number, w: number, h: number, encoding: string, data: Uint8Array): void

Private processWindowLost

  • processWindowLost(wid: number): void

Private processWindowMetadata

Private processWindowMoveResize

  • processWindowMoveResize(wid: number, x: number, y: number, w: number, h: number): void

Private processWindowRaise

  • processWindowRaise(wid: number): void

Private processWindowResized

  • processWindowResized(wid: number, w: number, h: number): void

Private recieve

Private send

sendBufferRefresh

  • sendBufferRefresh(wid: number): void

Private sendClipboard

  • sendClipboard(requestId: number, selection: string, buffer: string, dataType?: string, dataFormat?: number, encoding?: string): void

Private sendClipboardToken

  • sendClipboardToken(data: string): void

sendCloseWindow

  • sendCloseWindow(wid: number): void

sendConfigureWindow

sendConnectionData

  • sendConnectionData(info: Record<string, string | number>): void

sendDamageSequence

  • sendDamageSequence(packetSequence: number, wid: number, dimension: XpraVector, decodeTime: number, message?: string): void

sendFile

  • sendFile(filename: string, mime: string, size: number, buffer: Uint8Array | ArrayBuffer): void

sendGeometryWindow

Private sendHello

  • sendHello(): void

sendKeyAction

  • sendKeyAction(wid: number, name: string, pressed: boolean, modifiers: string[], key: string, code: number, group: number): void

sendLayoutChanged

  • sendLayoutChanged(layout: string): void

Private sendLog

sendMapWindow

sendMouseButton

  • sendMouseButton(wid: number, position: XpraVector, button: number, pressed: boolean, modifiers: string[]): void

sendMouseMove

  • sendMouseMove(wid: number, position: XpraVector, modifiers: string[]): void

sendMouseWheel

  • sendMouseWheel(wid: number, button: number, distance: number, position: XpraVector, modifiers: string[]): void

sendNotificationClose

  • sendNotificationClose(nid: number): void

Private sendPing

  • sendPing(): void

sendResize

  • sendResize(iw: number, ih: number): void

sendResume

  • sendResume(wids: number[]): void

sendShutdown

  • sendShutdown(): void

sendSoundStart

  • sendSoundStart(): void

sendSoundStop

  • sendSoundStop(): void

sendStartCommand

  • sendStartCommand(name: string, command: string, ignore: boolean): void

sendSuspend

  • sendSuspend(wids: number[]): void

sendUnmapWindow

sendWindowClose

  • sendWindowClose(wid: number): void

sendWindowRaise

  • sendWindowRaise(wid: number, windows: XpraWindow[]): void

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly audio

audio: XpraAudio = ...

Private capabilities

capabilities: XpraCapabilities = ...

Readonly clipboard

clipboard: XpraClipboard = ...

Private connectionCheckTimeout

connectionCheckTimeout: number = 0

Private inited

inited: boolean = false

Readonly keyboard

keyboard: XpraKeyboard = ...

Readonly logger

logger: XpraLogger = ...

Readonly mouse

mouse: XpraMouse = ...

Private options

options: XpraConnectionOptions = ...

Private pingInterval

pingInterval: number = 0

Private processorBindings

processorBindings: Record<XpraRecievePacketType, (...args: XpraPacketArguments) => void> = ...

Private Readonly proxy

proxy: XpraWorkerProxy = ...

Private serverCapabilities

serverCapabilities: null | XpraServerCapabilities = null

Private started

started: boolean = false

Private stats

stats: XpraConnectionStats = ...

Private Readonly ws

ws: XpraWebsocket = ...

Methods

Private challenge

  • challenge(serverSalt: string, digest: string, saltDigest: string, password: string): void

Private clearTimers

  • clearTimers(): void

connect

Private createCapabilities

disconnect

  • disconnect(error?: Error): void

getCapabilities

  • getCapabilities(): { argv: string[]; auto_refresh_delay: number; bandwidth-limit: number; bell: boolean; bencode: boolean; brotli: boolean; build.branch: string; build.local_modifications: number; build.revision: string; challenge_client_salt?: string; challenge_response?: string; cipher?: string; cipher.iv?: string; cipher.key_hash?: string; cipher.key_salt?: string; cipher.key_size?: number; cipher.key_stretch?: string; cipher.key_stretch_iterations?: number; cipher.mode?: string; cipher.padding.options?: string[]; client_type: string; clipboard: boolean; clipboard.contents-slice-fix: boolean; clipboard.greedy: boolean; clipboard.preferred-targets: string[]; clipboard.selections: XpraClipboardSelection[]; clipboard.want_targets: boolean; compression_level: number; connection-data: Record<string, string | number>; cursors: boolean; desktop_mode_size: XpraVector; desktop_size: XpraVector; digest: string[]; display: string; dpi: number; encoding: XpraPacketEncoder; encoding.color-gamut: string; encoding.decoder-speed: { video: number }; encoding.eos: boolean; encoding.flush: boolean; encoding.full_csc_modes: Record<string, string[]>; encoding.h264+mp4.: number; encoding.h264+mp4.YUV420P.level: string; encoding.h264+mp4.YUV420P.profile: string; encoding.h264+mp4.score-delta: number; encoding.h264.YUV420P.level: string; encoding.h264.YUV420P.profile: string; encoding.h264.cabac: boolean; encoding.h264.deblocking-filter: boolean; encoding.h264.fast-decode: boolean; encoding.h264.score-delta: number; encoding.icons.max_size: XpraVector; encoding.mpeg4+mp4.score-delta: number; encoding.rgb_lz4: boolean; encoding.rgb_zlib: boolean; encoding.scrolling: boolean; encoding.transparency: boolean; encoding.video_max_size: XpraVector; encoding.video_scaling: boolean; encoding.vp8+webm.score-delta: number; encoding.x264.YUV420P.profile: string; encodings: XpraDrawEncoding[]; encodings.core: XpraDrawEncoding[]; encodings.cursor: string[]; encodings.packet: boolean; encodings.rgb_formats: XpraRGBFormats[]; encodings.window-icon: string[]; file-size-limit: number; file-transfer: boolean; flush: boolean; keyboard: boolean; lz4: boolean; metadata.supported: string[]; mouse.show: boolean; named_cursors: boolean; namespace: boolean; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-url: boolean; ping-echo-sourceid: boolean; platform: string; platform.name: string; platform.platform: string; platform.processor: string; printing: boolean; randr_notify: boolean; rencode: boolean; rencodeplus: boolean; salt-digest: string[]; screen-resize-bigger: boolean; screen_sizes: XpraScreen[]; server-window-resize: boolean; session-type: string; session-type.full: string; setting-change: boolean; share: boolean; sound.bundle-metadata: boolean; sound.decoders: string[]; sound.receive: boolean; sound.send: boolean; sound.server_driven: boolean; start-new-session?: Partial<XpraStartNewSession>; steal: boolean; system_tray: boolean; username: string; uuid: string; version: string; vrefresh: number; websocket.multi-packet: boolean; window.pre-map: boolean; windows: boolean; xdg-menu-update: boolean; xkbmap_keycodes: XpraXkbpMapKeycode[]; xkbmap_layout: string; xkbmap_print: string; xkbmap_query: string; yaml: boolean; zlib: boolean }

  • Returns { argv: string[]; auto_refresh_delay: number; bandwidth-limit: number; bell: boolean; bencode: boolean; brotli: boolean; build.branch: string; build.local_modifications: number; build.revision: string; challenge_client_salt?: string; challenge_response?: string; cipher?: string; cipher.iv?: string; cipher.key_hash?: string; cipher.key_salt?: string; cipher.key_size?: number; cipher.key_stretch?: string; cipher.key_stretch_iterations?: number; cipher.mode?: string; cipher.padding.options?: string[]; client_type: string; clipboard: boolean; clipboard.contents-slice-fix: boolean; clipboard.greedy: boolean; clipboard.preferred-targets: string[]; clipboard.selections: XpraClipboardSelection[]; clipboard.want_targets: boolean; compression_level: number; connection-data: Record<string, string | number>; cursors: boolean; desktop_mode_size: XpraVector; desktop_size: XpraVector; digest: string[]; display: string; dpi: number; encoding: XpraPacketEncoder; encoding.color-gamut: string; encoding.decoder-speed: { video: number }; encoding.eos: boolean; encoding.flush: boolean; encoding.full_csc_modes: Record<string, string[]>; encoding.h264+mp4.: number; encoding.h264+mp4.YUV420P.level: string; encoding.h264+mp4.YUV420P.profile: string; encoding.h264+mp4.score-delta: number; encoding.h264.YUV420P.level: string; encoding.h264.YUV420P.profile: string; encoding.h264.cabac: boolean; encoding.h264.deblocking-filter: boolean; encoding.h264.fast-decode: boolean; encoding.h264.score-delta: number; encoding.icons.max_size: XpraVector; encoding.mpeg4+mp4.score-delta: number; encoding.rgb_lz4: boolean; encoding.rgb_zlib: boolean; encoding.scrolling: boolean; encoding.transparency: boolean; encoding.video_max_size: XpraVector; encoding.video_scaling: boolean; encoding.vp8+webm.score-delta: number; encoding.x264.YUV420P.profile: string; encodings: XpraDrawEncoding[]; encodings.core: XpraDrawEncoding[]; encodings.cursor: string[]; encodings.packet: boolean; encodings.rgb_formats: XpraRGBFormats[]; encodings.window-icon: string[]; file-size-limit: number; file-transfer: boolean; flush: boolean; keyboard: boolean; lz4: boolean; metadata.supported: string[]; mouse.show: boolean; named_cursors: boolean; namespace: boolean; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-url: boolean; ping-echo-sourceid: boolean; platform: string; platform.name: string; platform.platform: string; platform.processor: string; printing: boolean; randr_notify: boolean; rencode: boolean; rencodeplus: boolean; salt-digest: string[]; screen-resize-bigger: boolean; screen_sizes: XpraScreen[]; server-window-resize: boolean; session-type: string; session-type.full: string; setting-change: boolean; share: boolean; sound.bundle-metadata: boolean; sound.decoders: string[]; sound.receive: boolean; sound.send: boolean; sound.server_driven: boolean; start-new-session?: Partial<XpraStartNewSession>; steal: boolean; system_tray: boolean; username: string; uuid: string; version: string; vrefresh: number; websocket.multi-packet: boolean; window.pre-map: boolean; windows: boolean; xdg-menu-update: boolean; xkbmap_keycodes: XpraXkbpMapKeycode[]; xkbmap_layout: string; xkbmap_print: string; xkbmap_query: string; yaml: boolean; zlib: boolean }

    • argv: string[]
    • auto_refresh_delay: number
    • bandwidth-limit: number
    • bell: boolean
    • bencode: boolean
    • brotli: boolean
    • build.branch: string
    • build.local_modifications: number
    • build.revision: string
    • Optional challenge_client_salt?: string
    • Optional challenge_response?: string
    • Optional cipher?: string
    • Optional cipher.iv?: string
    • Optional cipher.key_hash?: string
    • Optional cipher.key_salt?: string
    • Optional cipher.key_size?: number
    • Optional cipher.key_stretch?: string
    • Optional cipher.key_stretch_iterations?: number
    • Optional cipher.mode?: string
    • Optional cipher.padding.options?: string[]
    • client_type: string
    • clipboard: boolean
    • clipboard.contents-slice-fix: boolean
    • clipboard.greedy: boolean
    • clipboard.preferred-targets: string[]
    • clipboard.selections: XpraClipboardSelection[]
    • clipboard.want_targets: boolean
    • compression_level: number
    • connection-data: Record<string, string | number>
    • cursors: boolean
    • desktop_mode_size: XpraVector
    • desktop_size: XpraVector
    • digest: string[]
    • display: string
    • dpi: number
    • encoding: XpraPacketEncoder
    • encoding.color-gamut: string
    • encoding.decoder-speed: { video: number }
      • video: number
    • encoding.eos: boolean
    • encoding.flush: boolean
    • encoding.full_csc_modes: Record<string, string[]>
    • encoding.h264+mp4.: number
    • encoding.h264+mp4.YUV420P.level: string
    • encoding.h264+mp4.YUV420P.profile: string
    • encoding.h264+mp4.score-delta: number
    • encoding.h264.YUV420P.level: string
    • encoding.h264.YUV420P.profile: string
    • encoding.h264.cabac: boolean
    • encoding.h264.deblocking-filter: boolean
    • encoding.h264.fast-decode: boolean
    • encoding.h264.score-delta: number
    • encoding.icons.max_size: XpraVector
    • encoding.mpeg4+mp4.score-delta: number
    • encoding.rgb_lz4: boolean
    • encoding.rgb_zlib: boolean
    • encoding.scrolling: boolean
    • encoding.transparency: boolean
    • encoding.video_max_size: XpraVector
    • encoding.video_scaling: boolean
    • encoding.vp8+webm.score-delta: number
    • encoding.x264.YUV420P.profile: string
    • encodings: XpraDrawEncoding[]
    • encodings.core: XpraDrawEncoding[]
    • encodings.cursor: string[]
    • encodings.packet: boolean
    • encodings.rgb_formats: XpraRGBFormats[]
    • encodings.window-icon: string[]
    • file-size-limit: number
    • file-transfer: boolean
    • flush: boolean
    • keyboard: boolean
    • lz4: boolean
    • metadata.supported: string[]
    • mouse.show: boolean
    • named_cursors: boolean
    • namespace: boolean
    • notifications: boolean
    • notifications.actions: boolean
    • notifications.close: boolean
    • open-url: boolean
    • ping-echo-sourceid: boolean
    • platform: string
    • platform.name: string
    • platform.platform: string
    • platform.processor: string
    • printing: boolean
    • randr_notify: boolean
    • rencode: boolean
    • rencodeplus: boolean
    • salt-digest: string[]
    • screen-resize-bigger: boolean
    • screen_sizes: XpraScreen[]
    • server-window-resize: boolean
    • session-type: string
    • session-type.full: string
    • setting-change: boolean
    • share: boolean
    • sound.bundle-metadata: boolean
    • sound.decoders: string[]
    • sound.receive: boolean
    • sound.send: boolean
    • sound.server_driven: boolean
    • Optional start-new-session?: Partial<XpraStartNewSession>
    • steal: boolean
    • system_tray: boolean
    • username: string
    • uuid: string
    • version: string
    • vrefresh: number
    • websocket.multi-packet: boolean
    • window.pre-map: boolean
    • windows: boolean
    • xdg-menu-update: boolean
    • xkbmap_keycodes: XpraXkbpMapKeycode[]
    • xkbmap_layout: string
    • xkbmap_print: string
    • xkbmap_query: string
    • yaml: boolean
    • zlib: boolean

getOptions

  • getOptions(): { audio: boolean; bandWidthLimit: number; bell: boolean; clipboard: boolean; clipboardDirection: XpraClipboardDirection; clipboardImages: boolean; connectionTimeout: number; cursor: boolean; debugPackets: string[]; display: string; encoder: XpraPacketEncoder; encryption: null | string; encryptionKey: string; exitWithChildren: boolean; exitWithClient: boolean; fileTransfer: boolean; keyboard: boolean; keyboardLayout: string; mouse: boolean; nativeVideo: boolean; notifications: boolean; openUrl: boolean; password: string; pingInterval: number; printing: boolean; reconnect: boolean; reconnectAttempts: number; reconnectInterval: number; reverseScrollX: boolean; reverseScrollY: boolean; shareSession: boolean; showStartMenu: boolean; showStatistics: boolean; ssl: boolean; startCommand: string; startNewSession: null | XpraStartNewSessionMode; stealSession: boolean; swapKeys: boolean; tray: boolean; username: string; video: boolean }

  • Returns { audio: boolean; bandWidthLimit: number; bell: boolean; clipboard: boolean; clipboardDirection: XpraClipboardDirection; clipboardImages: boolean; connectionTimeout: number; cursor: boolean; debugPackets: string[]; display: string; encoder: XpraPacketEncoder; encryption: null | string; encryptionKey: string; exitWithChildren: boolean; exitWithClient: boolean; fileTransfer: boolean; keyboard: boolean; keyboardLayout: string; mouse: boolean; nativeVideo: boolean; notifications: boolean; openUrl: boolean; password: string; pingInterval: number; printing: boolean; reconnect: boolean; reconnectAttempts: number; reconnectInterval: number; reverseScrollX: boolean; reverseScrollY: boolean; shareSession: boolean; showStartMenu: boolean; showStatistics: boolean; ssl: boolean; startCommand: string; startNewSession: null | XpraStartNewSessionMode; stealSession: boolean; swapKeys: boolean; tray: boolean; username: string; video: boolean }

    • audio: boolean
    • bandWidthLimit: number
    • bell: boolean
    • clipboard: boolean
    • clipboardDirection: XpraClipboardDirection
    • clipboardImages: boolean
    • connectionTimeout: number
    • cursor: boolean
    • debugPackets: string[]
    • display: string
    • encoder: XpraPacketEncoder
    • encryption: null | string
    • encryptionKey: string
    • exitWithChildren: boolean
    • exitWithClient: boolean
    • fileTransfer: boolean
    • keyboard: boolean
    • keyboardLayout: string
    • mouse: boolean
    • nativeVideo: boolean
    • notifications: boolean
    • openUrl: boolean
    • password: string
    • pingInterval: number
    • printing: boolean
    • reconnect: boolean
    • reconnectAttempts: number
    • reconnectInterval: number
    • reverseScrollX: boolean
    • reverseScrollY: boolean
    • shareSession: boolean
    • showStartMenu: boolean
    • showStatistics: boolean
    • ssl: boolean
    • startCommand: string
    • startNewSession: null | XpraStartNewSessionMode
    • stealSession: boolean
    • swapKeys: boolean
    • tray: boolean
    • username: string
    • video: boolean

getServerCapabilities

  • getServerCapabilities(): null | { actual_desktop_size: XpraVector; aliases: boolean; auto-video-encoding: boolean; auto_refresh_delay: number; av-sync: boolean; av-sync.enabled: boolean; bell: boolean; bencode: boolean; bencode.version: string; build.bit: string; build.branch: string; build.commit: string; build.compiler: string; build.cpu: string; build.cython: string; build.date: string; build.lib.gobject_introspection: string; build.lib.gtk: string; build.lib.gtk_x11: string; build.lib.nvenc: string; build.lib.nvfbc: string; build.lib.py3cairo: string; build.lib.pygobject: string; build.lib.python3: string; build.lib.vpx: string; build.lib.x11: string; build.lib.x264: string; build.lib.x265: string; build.lib.xcomposite: string; build.lib.xdamage: string; build.lib.xext: string; build.lib.xfixes: string; build.lib.xkbfile: string; build.lib.xrandr: string; build.lib.xtst: string; build.linker: string; build.local_modifications: number; build.python: string; build.revision: string; build.time: string; build.version: string; byteorder: string; cairo.version: string; client-shutdown: boolean; clipboard: boolean; clipboard-direction: string; clipboard.contents-slice-fix: boolean; clipboard.enable-selections: boolean; clipboard.loop-uuids.CLIPBOARD: string; clipboard.loop-uuids.PRIMARY: string; clipboard.loop-uuids.SECONDARY: string; clipboard.preferred-targets: string[]; clipboards: string[]; compressors: string[]; configure.pointer: boolean; connection-data: Record<string, string | number>; current_time: number; cursor.default_size: XpraVector; cursor.max_size: XpraVector; cursors: boolean; dbus_proxy: boolean; desktop_size: XpraVector; digest: string[]; display: string; elapsed_time: number; encoders: XpraCompressor[]; encoding: XpraPacketEncoder; exit-with-children: boolean; file-ask-timeout: number; file-chunks: number; file-size-limit: number; file-transfer: boolean; file-transfer-ask: boolean; flush: boolean; force_ungrab: string; gdk.version: string; gi.version: string; gid: number; glib.version: string; gobject.version: string; gtk.version: string; hostname: string; input-devices: string[]; key_repeat: number[]; key_repeat_modifiers: boolean; keyboard: boolean; keyboard.fast-switching: boolean; lock: boolean; lock-toggle: boolean; lz4.python-lz4: boolean; lz4.python-lz4.version: boolean; lz4.version: string; machine_id: string; max-file-size: number; max_desktop_size: XpraVector; modifier_keycodes?: XpraModifierKeycodes; network.bandwidth-limit: number; network.bandwidth-limit-change: boolean; none: boolean; none.version: string; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-files: boolean; open-files-ask: boolean; open-url: boolean; open-url-ask: boolean; opengl: boolean; pango.version: string; pid: number; ping-echo-sourceid: boolean; pixbuf.version: string; platform: string; platform.architecture: string; platform.linux_distribution: string; platform.machine: string; platform.name: string; platform.platform: string; platform.processor: string; platform.release: string; platform.sysrelease: string; pointer: boolean; pointer.grabs: boolean; pointer.relative: boolean; printer.attributes: string[]; printing: boolean; printing-ask: boolean; python.bits: number; python.full_version: string; python.version: string; readonly: boolean; readonly-server: boolean; remote-logging: boolean; remote-logging.multi-line: boolean; remote-logging.receive: boolean; remote-logging.send: boolean; rencode: boolean; rencode.version: string; request-file: boolean; resize_exact: string; resize_screen: string; root_window_size: XpraVector; rpc-types: string[]; salt-digest: string[]; screen-sizes: XpraVector[]; server-commands-info: boolean; server-commands-signals: string[]; server-log: string; server.mode: string; server_type: string; session_name: string; sharing: boolean; sharing-toggle: boolean; shell: boolean; sound.bundle-metadata: boolean; sound.codec-full-names: boolean; sound.decoders: string[]; sound.demuxers: string[]; sound.device.Xpra-Microphone: string; sound.device.Xpra-Microphone.monitor: string; sound.device.Xpra-Speaker: string; sound.device.Xpra-Speaker.monitor: string; sound.devices: number; sound.encoders: string[]; sound.gst.version: string; sound.muxers: string[]; sound.ogg-latency-fix: boolean; sound.plugins: string[]; sound.pulseaudio.cookie-hash: string; sound.pulseaudio.found: boolean; sound.pulseaudio.id: string; sound.pulseaudio.server: string; sound.pulseaudio.wrapper: string; sound.pygst.version: string; sound.python.bits: number; sound.python.version: string; sound.receive: boolean; sound.send: boolean; sound.sink.default: string[]; sound.sinks: string[]; sound.source.default: string[]; sound.sources: string[]; start-new-commands: boolean; start_time: number; subcommands: string[]; toggle_keyboard_sync: boolean; touchpad-device: boolean; uid: number; uuid: string; version: string; virtual-video-devices: string[]; webcam: boolean; webcam.encodings: string[]; wheel.precise: boolean; window-filters: boolean; window.configure.delta: boolean; window.decorations: boolean; window.dragndrop: boolean; window.frame-extents: boolean; window.signals: string[]; window.states: string[]; window_refresh_config: boolean; windows: boolean; xdg-menu: boolean; xdg-menu-update: boolean; yaml: boolean; yaml.version: string; zlib: boolean; zlib.python-zlib: boolean; zlib.python-zlib.version: string }

  • Returns null | { actual_desktop_size: XpraVector; aliases: boolean; auto-video-encoding: boolean; auto_refresh_delay: number; av-sync: boolean; av-sync.enabled: boolean; bell: boolean; bencode: boolean; bencode.version: string; build.bit: string; build.branch: string; build.commit: string; build.compiler: string; build.cpu: string; build.cython: string; build.date: string; build.lib.gobject_introspection: string; build.lib.gtk: string; build.lib.gtk_x11: string; build.lib.nvenc: string; build.lib.nvfbc: string; build.lib.py3cairo: string; build.lib.pygobject: string; build.lib.python3: string; build.lib.vpx: string; build.lib.x11: string; build.lib.x264: string; build.lib.x265: string; build.lib.xcomposite: string; build.lib.xdamage: string; build.lib.xext: string; build.lib.xfixes: string; build.lib.xkbfile: string; build.lib.xrandr: string; build.lib.xtst: string; build.linker: string; build.local_modifications: number; build.python: string; build.revision: string; build.time: string; build.version: string; byteorder: string; cairo.version: string; client-shutdown: boolean; clipboard: boolean; clipboard-direction: string; clipboard.contents-slice-fix: boolean; clipboard.enable-selections: boolean; clipboard.loop-uuids.CLIPBOARD: string; clipboard.loop-uuids.PRIMARY: string; clipboard.loop-uuids.SECONDARY: string; clipboard.preferred-targets: string[]; clipboards: string[]; compressors: string[]; configure.pointer: boolean; connection-data: Record<string, string | number>; current_time: number; cursor.default_size: XpraVector; cursor.max_size: XpraVector; cursors: boolean; dbus_proxy: boolean; desktop_size: XpraVector; digest: string[]; display: string; elapsed_time: number; encoders: XpraCompressor[]; encoding: XpraPacketEncoder; exit-with-children: boolean; file-ask-timeout: number; file-chunks: number; file-size-limit: number; file-transfer: boolean; file-transfer-ask: boolean; flush: boolean; force_ungrab: string; gdk.version: string; gi.version: string; gid: number; glib.version: string; gobject.version: string; gtk.version: string; hostname: string; input-devices: string[]; key_repeat: number[]; key_repeat_modifiers: boolean; keyboard: boolean; keyboard.fast-switching: boolean; lock: boolean; lock-toggle: boolean; lz4.python-lz4: boolean; lz4.python-lz4.version: boolean; lz4.version: string; machine_id: string; max-file-size: number; max_desktop_size: XpraVector; modifier_keycodes?: XpraModifierKeycodes; network.bandwidth-limit: number; network.bandwidth-limit-change: boolean; none: boolean; none.version: string; notifications: boolean; notifications.actions: boolean; notifications.close: boolean; open-files: boolean; open-files-ask: boolean; open-url: boolean; open-url-ask: boolean; opengl: boolean; pango.version: string; pid: number; ping-echo-sourceid: boolean; pixbuf.version: string; platform: string; platform.architecture: string; platform.linux_distribution: string; platform.machine: string; platform.name: string; platform.platform: string; platform.processor: string; platform.release: string; platform.sysrelease: string; pointer: boolean; pointer.grabs: boolean; pointer.relative: boolean; printer.attributes: string[]; printing: boolean; printing-ask: boolean; python.bits: number; python.full_version: string; python.version: string; readonly: boolean; readonly-server: boolean; remote-logging: boolean; remote-logging.multi-line: boolean; remote-logging.receive: boolean; remote-logging.send: boolean; rencode: boolean; rencode.version: string; request-file: boolean; resize_exact: string; resize_screen: string; root_window_size: XpraVector; rpc-types: string[]; salt-digest: string[]; screen-sizes: XpraVector[]; server-commands-info: boolean; server-commands-signals: string[]; server-log: string; server.mode: string; server_type: string; session_name: string; sharing: boolean; sharing-toggle: boolean; shell: boolean; sound.bundle-metadata: boolean; sound.codec-full-names: boolean; sound.decoders: string[]; sound.demuxers: string[]; sound.device.Xpra-Microphone: string; sound.device.Xpra-Microphone.monitor: string; sound.device.Xpra-Speaker: string; sound.device.Xpra-Speaker.monitor: string; sound.devices: number; sound.encoders: string[]; sound.gst.version: string; sound.muxers: string[]; sound.ogg-latency-fix: boolean; sound.plugins: string[]; sound.pulseaudio.cookie-hash: string; sound.pulseaudio.found: boolean; sound.pulseaudio.id: string; sound.pulseaudio.server: string; sound.pulseaudio.wrapper: string; sound.pygst.version: string; sound.python.bits: number; sound.python.version: string; sound.receive: boolean; sound.send: boolean; sound.sink.default: string[]; sound.sinks: string[]; sound.source.default: string[]; sound.sources: string[]; start-new-commands: boolean; start_time: number; subcommands: string[]; toggle_keyboard_sync: boolean; touchpad-device: boolean; uid: number; uuid: string; version: string; virtual-video-devices: string[]; webcam: boolean; webcam.encodings: string[]; wheel.precise: boolean; window-filters: boolean; window.configure.delta: boolean; window.decorations: boolean; window.dragndrop: boolean; window.frame-extents: boolean; window.signals: string[]; window.states: string[]; window_refresh_config: boolean; windows: boolean; xdg-menu: boolean; xdg-menu-update: boolean; yaml: boolean; yaml.version: string; zlib: boolean; zlib.python-zlib: boolean; zlib.python-zlib.version: string }

Private handshake

  • handshake(): void

init

  • init(): Promise<void>

isReadOnly

  • isReadOnly(): boolean

isReady

  • isReady(): boolean

Private processBell

  • processBell(): void

Private processChallenge

  • processChallenge(serverSalt: string, cipherOutCaps: XpraCipherCapability, digest: string, saltDigest: string, prompt: string): void

Private processClipboardRequest

Private processClipboardToken

Private processCloseNotification

  • processCloseNotification(id: number): void

Private processConfigureOverrideRedirect

  • processConfigureOverrideRedirect(wid: number, x: number, y: number, w: number, h: number): void

Private processCursor

  • processCursor(encoding: string, _unknown1: number, _unknown2: number, w: number, h: number, xhot: number, yhot: number, _unknown3: number, data: string): void

Private processDisconnect

  • processDisconnect(message: string): void

Private processDraw

Private processEncodings

  • processEncodings(caps: string[]): void

Private processEos

  • processEos(wid: number): void

Private processHello

Private processInfoResponse

Private processInitiateMoveResize

  • processInitiateMoveResize(wid: number, xRoot: number, yRoot: number, direction: number, button: number, sourceIndication: number): void

Private processNewOverrideRedirect

Private processNewTray

  • processNewTray(id: number, iw: string | number, ih: string | number, metadata: XpraWindowMetadata): void

Private processNewWindow

Private processOpenUrl

  • processOpenUrl(url: string): void

Private processPing

  • processPing(...packet: number[]): void

Private processPingEcho

  • processPingEcho(last: number, l1: number, l2: number, l3: number, latency: number): void

Private processPointerPosition

  • processPointerPosition(wid: number, ix: string | number, iy: string | number): void

Private processSendFile

  • processSendFile(filename: string, mime: string, print: number, size: number, data: Uint8Array): void

Private processSetClipboardEnabled

  • processSetClipboardEnabled(enabled: number | boolean): void

Private processSettingChange

Private processShowNotification

  • processShowNotification(_unknown1: string, id: number, _unknown2: string, replacesId: number, _unknown3: string, summary: string, body: string, expires: number, icon: null | [string, number, number, string | Uint8Array], actions: string[], hints: string[]): void

  • Parameters

    • _unknown1: string
    • id: number
    • _unknown2: string
    • replacesId: number
    • _unknown3: string
    • summary: string
    • body: string
    • expires: number
    • icon: null | [string, number, number, string | Uint8Array]
    • actions: string[]
    • hints: string[]

    Returns void

Private processSoundData

Private processStartupComplete

  • processStartupComplete(): void

Private processWindowIcon

  • processWindowIcon(wid: number, w: number, h: number, encoding: string, data: Uint8Array): void

Private processWindowLost

  • processWindowLost(wid: number): void

Private processWindowMetadata

Private processWindowMoveResize

  • processWindowMoveResize(wid: number, x: number, y: number, w: number, h: number): void

Private processWindowRaise

  • processWindowRaise(wid: number): void

Private processWindowResized

  • processWindowResized(wid: number, w: number, h: number): void

Private recieve

Private send

sendBufferRefresh

  • sendBufferRefresh(wid: number): void

Private sendClipboard

  • sendClipboard(requestId: number, selection: string, buffer: string, dataType?: string, dataFormat?: number, encoding?: string): void

Private sendClipboardToken

  • sendClipboardToken(data: string): void

sendCloseWindow

  • sendCloseWindow(wid: number): void

sendConfigureWindow

sendConnectionData

  • sendConnectionData(info: Record<string, string | number>): void

sendDamageSequence

  • sendDamageSequence(packetSequence: number, wid: number, dimension: XpraVector, decodeTime: number, message?: string): void

sendFile

  • sendFile(filename: string, mime: string, size: number, buffer: Uint8Array | ArrayBuffer): void

sendGeometryWindow

Private sendHello

  • sendHello(): void

sendKeyAction

  • sendKeyAction(wid: number, name: string, pressed: boolean, modifiers: string[], key: string, code: number, group: number): void

sendLayoutChanged

  • sendLayoutChanged(layout: string): void

Private sendLog

sendMapWindow

sendMouseButton

  • sendMouseButton(wid: number, position: XpraVector, button: number, pressed: boolean, modifiers: string[]): void

sendMouseMove

  • sendMouseMove(wid: number, position: XpraVector, modifiers: string[]): void

sendMouseWheel

  • sendMouseWheel(wid: number, button: number, distance: number, position: XpraVector, modifiers: string[]): void

sendNotificationClose

  • sendNotificationClose(nid: number): void

Private sendPing

  • sendPing(): void

sendResize

  • sendResize(iw: number, ih: number): void

sendResume

  • sendResume(wids: number[]): void

sendShutdown

  • sendShutdown(): void

sendSoundStart

  • sendSoundStart(): void

sendSoundStop

  • sendSoundStop(): void

sendStartCommand

  • sendStartCommand(name: string, command: string, ignore: boolean): void

sendSuspend

  • sendSuspend(wids: number[]): void

sendUnmapWindow

sendWindowClose

  • sendWindowClose(wid: number): void

sendWindowRaise

  • sendWindowRaise(wid: number, windows: XpraWindow[]): void

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraClipboard.html b/ts/docs/classes/XpraClipboard.html index 945baed7..9df8e008 100644 --- a/ts/docs/classes/XpraClipboard.html +++ b/ts/docs/classes/XpraClipboard.html @@ -1,3 +1,3 @@ XpraClipboard | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraClipboard

Provides clipboard functionality to the Xpra client

-

Hierarchy

Index

Properties

Methods

Properties

Private clipboardBuffer

clipboardBuffer: Partial<Record<XpraClipboardSelection, XpraPacketArguments>> = {}

Private direction

direction: XpraClipboardDirection = 'both'

Private enabled

enabled: boolean = false

Methods

configure

isEnabled

  • isEnabled(): boolean

poll

  • poll(): Promise<void>

read

reset

  • reset(): void

setEnabled

  • setEnabled(enabled: boolean): void

write

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Methods

Properties

Private clipboardBuffer

clipboardBuffer: Partial<Record<XpraClipboardSelection, XpraPacketArguments>> = {}

Private direction

direction: XpraClipboardDirection = 'both'

Private enabled

enabled: boolean = false

Methods

configure

isEnabled

  • isEnabled(): boolean

poll

  • poll(): Promise<void>

read

reset

  • reset(): void

setEnabled

  • setEnabled(enabled: boolean): void

write

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraDecodeNullWorker.html b/ts/docs/classes/XpraDecodeNullWorker.html index 48590dbf..67ddfeb3 100644 --- a/ts/docs/classes/XpraDecodeNullWorker.html +++ b/ts/docs/classes/XpraDecodeNullWorker.html @@ -1,8 +1,8 @@ XpraDecodeNullWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraDecodeNullWorker

Local decode worker instance. Runs in main thread so this has performance impacts.

-

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addEventListener

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(cmd: string, data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraDecodeWebWorker.html b/ts/docs/classes/XpraDecodeWebWorker.html index 16065b9c..5c3bf4ce 100644 --- a/ts/docs/classes/XpraDecodeWebWorker.html +++ b/ts/docs/classes/XpraDecodeWebWorker.html @@ -1,7 +1,7 @@ XpraDecodeWebWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraDecodeWebWorker

Decoder Web worker instance.

-

Hierarchy

Index

Methods

Methods

addEventListener

Hierarchy

Index

Methods

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(cmd: string, data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraDecodeWorker.html b/ts/docs/classes/XpraDecodeWorker.html index fb3e41c9..3bdc5145 100644 --- a/ts/docs/classes/XpraDecodeWorker.html +++ b/ts/docs/classes/XpraDecodeWorker.html @@ -1,7 +1,7 @@ XpraDecodeWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraDecodeWorker

Base class for handling decoding queues

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private queue

queue: XpraDecodeQueue = ...

Methods

addEventListener

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private queue

queue: XpraDecodeQueue = ...

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(_cmd: string, _data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraKeyboard.html b/ts/docs/classes/XpraKeyboard.html index 73c602d6..c4c49c3a 100644 --- a/ts/docs/classes/XpraKeyboard.html +++ b/ts/docs/classes/XpraKeyboard.html @@ -1,4 +1,4 @@ XpraKeyboard | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraKeyboard

Keyboard wrapper to handle input across a range of platforms as well as translate into native input data.

-

Hierarchy

Index

Properties

Methods

Properties

Private altgrState

altgrState: boolean = false

Private keyboardLayout

keyboardLayout: string = 'us'

Private Readonly modifiers

modifiers: Record<string, null | string> = ...

Private Readonly platform

platform: { name: string; platform: string; processor: string; type: string } = ...

Type declaration

  • name: string
  • platform: string
  • processor: string
  • type: string

Methods

configure

Private getBaseModifiers

  • getBaseModifiers(event: KeyboardEvent | MouseEvent): string[]

getKey

  • getKey(event: KeyboardEvent): { code: number; group: number; key: string; name: string }

  • Parameters

    • event: KeyboardEvent

    Returns { code: number; group: number; key: string; name: string }

    • code: number
    • group: number
    • key: string
    • name: string

getModifiers

  • getModifiers(ev: KeyboardEvent | MouseEvent): string[]

onKeyPress

  • onKeyPress(str: string, pressed: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Methods

Properties

Private altgrState

altgrState: boolean = false

Private keyboardLayout

keyboardLayout: string = 'us'

Private Readonly modifiers

modifiers: Record<string, null | string> = ...

Private Readonly platform

platform: { name: string; platform: string; processor: string; type: string } = ...

Type declaration

  • name: string
  • platform: string
  • processor: string
  • type: string

Methods

configure

Private getBaseModifiers

  • getBaseModifiers(event: KeyboardEvent | MouseEvent): string[]

getKey

  • getKey(event: KeyboardEvent): { code: number; group: number; key: string; name: string }

  • Parameters

    • event: KeyboardEvent

    Returns { code: number; group: number; key: string; name: string }

    • code: number
    • group: number
    • key: string
    • name: string

getModifiers

  • getModifiers(ev: KeyboardEvent | MouseEvent): string[]

onKeyPress

  • onKeyPress(str: string, pressed: boolean): void

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraLogger.html b/ts/docs/classes/XpraLogger.html index 28b37f15..5e7ffed2 100644 --- a/ts/docs/classes/XpraLogger.html +++ b/ts/docs/classes/XpraLogger.html @@ -1,3 +1,3 @@ XpraLogger | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraLogger

Console logger wrapper that is used for remote logging

-

Hierarchy

Index

Methods

Methods

debug

error

info

log

Private perform

warn

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Methods

Methods

debug

error

info

log

Private perform

warn

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraMediaSourceAdapter.html b/ts/docs/classes/XpraMediaSourceAdapter.html index 3106993c..2f61e956 100644 --- a/ts/docs/classes/XpraMediaSourceAdapter.html +++ b/ts/docs/classes/XpraMediaSourceAdapter.html @@ -1,3 +1,3 @@ XpraMediaSourceAdapter | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraMediaSourceAdapter

MediaSource Audio Adapter

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Protected Readonly audioCodec

audioCodec: string

Private mediaSource

mediaSource: null | MediaSource = null

Private mediaSourceBuffer

mediaSourceBuffer: null | SourceBuffer = null

Private mediaSourceReady

mediaSourceReady: boolean = false

Methods

addQueue

Protected isReady

  • isReady(): boolean

Protected pushBuffer

  • pushBuffer(buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Static getBlacklistedCodecs

  • getBlacklistedCodecs(ignoreBlacklist: boolean): string[]

Static getCodecs

Static getSupportedCodecs

  • getSupportedCodecs(ignoreBlacklist?: boolean): any

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly audio

audio: HTMLAudioElement

Protected Readonly audioCodec

audioCodec: string

Private mediaSource

mediaSource: null | MediaSource = null

Private mediaSourceBuffer

mediaSourceBuffer: null | SourceBuffer = null

Private mediaSourceReady

mediaSourceReady: boolean = false

Methods

addQueue

Protected isReady

  • isReady(): boolean

Protected pushBuffer

  • pushBuffer(buffer: Uint8Array): void

setup

  • setup(): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): void

Static getBlacklistedCodecs

  • getBlacklistedCodecs(ignoreBlacklist: boolean): string[]

Static getCodecs

Static getSupportedCodecs

  • getSupportedCodecs(ignoreBlacklist?: boolean): any

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraMouse.html b/ts/docs/classes/XpraMouse.html index 13edeb05..3090d913 100644 --- a/ts/docs/classes/XpraMouse.html +++ b/ts/docs/classes/XpraMouse.html @@ -1,4 +1,4 @@ XpraMouse | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraMouse

Mouse wrapper to handle input across a range of platforms as well as translate into native input data.

-

Hierarchy

  • XpraMouse

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private reverseScrollX

reverseScrollX: boolean = false

Private reverseScrollY

reverseScrollY: boolean = false

Methods

configure

getButton

  • getButton(ev: MouseEvent): number

getPosition

  • getPosition(ev: MouseEvent): [number, number]

Private getRawScroll

  • getRawScroll(event: Event | WheelEvent | MouseEvent): XpraVector

getScroll

  • getScroll(event: Event | WheelEvent | MouseEvent): XpraVector

getScrollWheel

  • getScrollWheel(event: Event | WheelEvent | MouseEvent): number[]

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private reverseScrollX

reverseScrollX: boolean = false

Private reverseScrollY

reverseScrollY: boolean = false

Methods

configure

getButton

  • getButton(ev: MouseEvent): number

getPosition

  • getPosition(ev: MouseEvent): [number, number]

Private getRawScroll

  • getRawScroll(event: Event | WheelEvent | MouseEvent): XpraVector

getScroll

  • getScroll(event: Event | WheelEvent | MouseEvent): XpraVector

getScrollWheel

  • getScrollWheel(event: Event | WheelEvent | MouseEvent): number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraPacketNullWorker.html b/ts/docs/classes/XpraPacketNullWorker.html index 09d8b22a..a0a1eee7 100644 --- a/ts/docs/classes/XpraPacketNullWorker.html +++ b/ts/docs/classes/XpraPacketNullWorker.html @@ -1,8 +1,8 @@ XpraPacketNullWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraPacketNullWorker

Local packet worker instance. Runs in main thread so this has performance impacts.

-

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addEventListener

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(cmd: string, data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraPacketWebWorker.html b/ts/docs/classes/XpraPacketWebWorker.html index 332cfdb3..48a33d93 100644 --- a/ts/docs/classes/XpraPacketWebWorker.html +++ b/ts/docs/classes/XpraPacketWebWorker.html @@ -1,7 +1,7 @@ XpraPacketWebWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraPacketWebWorker

Web worker instance.

-

Hierarchy

Index

Methods

Methods

addEventListener

Hierarchy

Index

Methods

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(cmd: string, data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraPacketWorker.html b/ts/docs/classes/XpraPacketWorker.html index 0cb4fca6..2f86d3ee 100644 --- a/ts/docs/classes/XpraPacketWorker.html +++ b/ts/docs/classes/XpraPacketWorker.html @@ -1,7 +1,7 @@ XpraPacketWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraPacketWorker

Base class for handling websocket message queues

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private recieveQueue

recieveQueue: XpraRecieveQueue = ...

Private sendQueue

sendQueue: XpraSendQueue = ...

Methods

addEventListener

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private recieveQueue

recieveQueue: XpraRecieveQueue = ...

Private sendQueue

sendQueue: XpraSendQueue = ...

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(_cmd: string, _data: any): void

Protected setConnected

  • setConnected(connected: boolean): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Protected setConnected

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraQueue.html b/ts/docs/classes/XpraQueue.html index 2ba6684b..7d7767f8 100644 --- a/ts/docs/classes/XpraQueue.html +++ b/ts/docs/classes/XpraQueue.html @@ -1,3 +1,3 @@ XpraQueue | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraQueue<T, M>

A queue abstraction for processing packets

-

Type parameters

  • T

  • M

Hierarchy

Index

Properties

Methods

Properties

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Protected queue

queue: T[] = []

Methods

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

push

  • push(packet: T): void

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file +

Type parameters

Hierarchy

Index

Properties

Methods

Properties

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Protected queue

queue: T[] = []

Methods

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

push

  • push(packet: T): void

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraRecieveQueue.html b/ts/docs/classes/XpraRecieveQueue.html index e7749ef2..f63e6a26 100644 --- a/ts/docs/classes/XpraRecieveQueue.html +++ b/ts/docs/classes/XpraRecieveQueue.html @@ -1,3 +1,3 @@ XpraRecieveQueue | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraRecieveQueue

Processes packets that comes from an Xpra server

-

Hierarchy

Index

Properties

Methods

Properties

Private busy

busy: boolean = false

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Private header

header: XpraRecieveHeader = []

Protected queue

queue: Uint8Array[] = []

Private raw

raw: Uint8Array[] = []

Methods

Private checkPacketHeader

  • checkPacketHeader(): void

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

Private fixPacketData

Private parsePacketHeader

  • parsePacketHeader(): number[]

process

  • process(): void

Private processNext

  • processNext(): boolean

Private processPacketData

  • processPacketData(packetSize: number, protoCrypto: number, padding: number, level: number): Uint8Array

Private processPacketHeader

  • processPacketHeader(): boolean

push

  • push(packet: Uint8Array): void

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Methods

Properties

Private busy

busy: boolean = false

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Private header

header: XpraRecieveHeader = []

Protected queue

queue: Uint8Array[] = []

Private raw

raw: Uint8Array[] = []

Methods

Private checkPacketHeader

  • checkPacketHeader(): void

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

Private fixPacketData

Private parsePacketHeader

  • parsePacketHeader(): number[]

process

  • process(): void

Private processNext

  • processNext(): boolean

Private processPacketData

  • processPacketData(packetSize: number, protoCrypto: number, padding: number, level: number): Uint8Array

Private processPacketHeader

  • processPacketHeader(): boolean

push

  • push(packet: Uint8Array): void

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraSendQueue.html b/ts/docs/classes/XpraSendQueue.html index 8b258a61..73cef890 100644 --- a/ts/docs/classes/XpraSendQueue.html +++ b/ts/docs/classes/XpraSendQueue.html @@ -1,3 +1,3 @@ XpraSendQueue | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraSendQueue

Processes packets that is to be sent to a Xpra server

-

Hierarchy

Index

Properties

Methods

Properties

Private busy

busy: boolean = false

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Private packetEncoder

packetEncoder: XpraPacketEncoder = 'bencode'

Protected queue

queue: [XpraSendPacketType, ...any[]][] = []

Methods

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

Private createSendData

process

  • process(): void

Private processNext

  • processNext(): boolean

push

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Methods

Properties

Private busy

busy: boolean = false

Protected cipher

cipher: null | BlockCipher = null

Protected cipherBlockSize

cipherBlockSize: number = 0

Protected connected

connected: boolean = true

Protected debugPackets

debugPackets: string[] = []

Private packetEncoder

packetEncoder: XpraPacketEncoder = 'bencode'

Protected queue

queue: [XpraSendPacketType, ...any[]][] = []

Methods

clear

  • clear(): void

clearCipher

  • clearCipher(): void

configure

Private createSendData

process

  • process(): void

Private processNext

  • processNext(): boolean

push

setConnected

  • setConnected(conn: boolean): void

setupCipher

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraWebsocket.html b/ts/docs/classes/XpraWebsocket.html index 58a387e6..1ffe57e2 100644 --- a/ts/docs/classes/XpraWebsocket.html +++ b/ts/docs/classes/XpraWebsocket.html @@ -1,3 +1,3 @@ XpraWebsocket | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraWebsocket

Connection websocket abstraction to handle reconnects etc.

-

Hierarchy

Index

Properties

Accessors

Methods

Properties

Private connectionStatus

connectionStatus: XpraConnectionStatus = 'disconnected'

Private host

host: string = ''

Private maxReconnectAttempts

maxReconnectAttempts: number = 3

Private reconnectAttempt

reconnectAttempt: number = 0

Private reconnectIntervalTime

reconnectIntervalTime: number = ...

Private reconnectTimeout

reconnectTimeout: number = 0

Private ws

ws: null | WebSocket = null

Accessors

connected

  • get connected(): boolean

status

Methods

Private clearTimers

  • clearTimers(): void

connect

disconnect

  • disconnect(reconnect?: boolean): void

send

  • send(message: string | Uint8Array | ArrayBufferLike): void

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Accessors

Methods

Properties

Private connectionStatus

connectionStatus: XpraConnectionStatus = 'disconnected'

Private host

host: string = ''

Private maxReconnectAttempts

maxReconnectAttempts: number = 3

Private reconnectAttempt

reconnectAttempt: number = 0

Private reconnectIntervalTime

reconnectIntervalTime: number = ...

Private reconnectTimeout

reconnectTimeout: number = 0

Private ws

ws: null | WebSocket = null

Accessors

connected

  • get connected(): boolean

status

Methods

Private clearTimers

  • clearTimers(): void

connect

disconnect

  • disconnect(reconnect?: boolean): void

send

  • send(message: string | Uint8Array | ArrayBufferLike): void

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraWindowManager.html b/ts/docs/classes/XpraWindowManager.html index 3ae137b9..1f394194 100644 --- a/ts/docs/classes/XpraWindowManager.html +++ b/ts/docs/classes/XpraWindowManager.html @@ -1,4 +1,4 @@ XpraWindowManager | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraWindowManager

A basic abstraction to make integraion of custom user interfaces a bit simpler by providing some glue for general events and input.

-

Hierarchy

  • XpraWindowManager

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private $desktop

$desktop: null | HTMLElement = null

Private activeWindow

activeWindow: number = -1

Private windows

windows: XpraWindowManagerWindow[] = []

Private xpra

xpra: XpraClient

Methods

clearWindows

  • clearWindows(): void

close

createNotification

createWindow

getWindow

init

  • init(): void

keyPress

maximize

minimize

mouseButton

mouseMove

mouseWheel

moveResize

Private onKeyAction

  • onKeyAction(ev: KeyboardEvent): void

Private onResize

  • onResize(wid: number, dimension: XpraVector): void

Private onScrollAction

  • onScrollAction(ev: Event | WheelEvent | MouseEvent): void

Private openUrl

  • openUrl(url: string): void

Private playBell

  • playBell(): void

raise

removeWindow

  • removeWindow(id: number): void

Private renderWindow

restore

Private sendFile

setActiveWindow

  • setActiveWindow(wid: number): void

setDesktopElement

  • setDesktopElement(el: null | HTMLElement): void

updateWindow

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private $desktop

$desktop: null | HTMLElement = null

Private activeWindow

activeWindow: number = -1

Private windows

windows: XpraWindowManagerWindow[] = []

Private xpra

xpra: XpraClient

Methods

clearWindows

  • clearWindows(): void

close

createNotification

createWindow

getWindow

init

  • init(): void

keyPress

maximize

minimize

mouseButton

mouseMove

mouseWheel

moveResize

Private onKeyAction

  • onKeyAction(ev: KeyboardEvent): void

Private onResize

  • onResize(wid: number, dimension: XpraVector): void

Private onScrollAction

  • onScrollAction(ev: Event | WheelEvent | MouseEvent): void

Private openUrl

  • openUrl(url: string): void

Private playBell

  • playBell(): void

raise

removeWindow

  • removeWindow(id: number): void

Private renderWindow

restore

Private sendFile

setActiveWindow

  • setActiveWindow(wid: number): void

setDesktopElement

  • setDesktopElement(el: null | HTMLElement): void

updateWindow

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraWorker.html b/ts/docs/classes/XpraWorker.html index d72e6905..a809393c 100644 --- a/ts/docs/classes/XpraWorker.html +++ b/ts/docs/classes/XpraWorker.html @@ -1,7 +1,7 @@ XpraWorker | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraWorker

Base abstraction for Xpra Workers

-

Hierarchy

Index

Methods

Methods

addEventListener

Hierarchy

Index

Methods

Methods

addEventListener

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected init

  • init(): void

postMessage

  • postMessage(message: any): void

Protected processMessage

Protected send

  • send(_cmd: string, _data: any): void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Protected processMessage

Protected send

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/classes/XpraWorkerProxy.html b/ts/docs/classes/XpraWorkerProxy.html index 4386a129..ee4a1826 100644 --- a/ts/docs/classes/XpraWorkerProxy.html +++ b/ts/docs/classes/XpraWorkerProxy.html @@ -1,3 +1,3 @@ XpraWorkerProxy | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XpraWorkerProxy

A proxy to handle messaging between the client and a worker

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private decodeWorker

decodeWorker: null | Worker | XpraDecodeWorker = null

Private packetWorker

packetWorker: null | Worker | XpraPacketWorker = null

Methods

configure

Private onMessage

Private onWorkerError

  • onWorkerError(ev: ErrorEvent): void

Private onWorkerMessage

  • onWorkerMessage(ev: MessageEvent<any>): void

Private postDecoderMessage

  • postDecoderMessage(data: XpraDraw): void

Private postPacketMessage

pushDecode

pushRecieve

  • pushRecieve(data: Uint8Array): void

pushSend

setConnected

  • setConnected(connected: boolean): void

setDecodeWorker

setWorker

setupRecieveCipher

setupSendCipher

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private decodeWorker

decodeWorker: null | Worker | XpraDecodeWorker = null

Private packetWorker

packetWorker: null | Worker | XpraPacketWorker = null

Methods

configure

Private onMessage

Private onWorkerError

  • onWorkerError(ev: ErrorEvent): void

Private onWorkerMessage

  • onWorkerMessage(ev: MessageEvent<any>): void

Private postDecoderMessage

  • postDecoderMessage(data: XpraDraw): void

Private postPacketMessage

pushDecode

pushRecieve

  • pushRecieve(data: Uint8Array): void

pushSend

setConnected

  • setConnected(connected: boolean): void

setDecodeWorker

setWorker

setupRecieveCipher

setupSendCipher

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/enums/XpraEncodeBit.html b/ts/docs/enums/XpraEncodeBit.html index dacc275d..d5a4bde3 100644 --- a/ts/docs/enums/XpraEncodeBit.html +++ b/ts/docs/enums/XpraEncodeBit.html @@ -1 +1 @@ -XpraEncodeBit | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraEncodeBit

Index

Enumeration members

Enumeration members

BENCODE

BENCODE = 0

RENCODELEGACY

RENCODELEGACY = 1

RENCODEPLUS

RENCODEPLUS = 16

Generated using TypeDoc

\ No newline at end of file +XpraEncodeBit | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraEncodeBit

Index

Enumeration members

Enumeration members

BENCODE

BENCODE = 0

RENCODELEGACY

RENCODELEGACY = 1

RENCODEPLUS

RENCODEPLUS = 16

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/enums/XpraInflateBit.html b/ts/docs/enums/XpraInflateBit.html index 2174187c..e2561b9b 100644 --- a/ts/docs/enums/XpraInflateBit.html +++ b/ts/docs/enums/XpraInflateBit.html @@ -1 +1 @@ -XpraInflateBit | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraInflateBit

Index

Enumeration members

Enumeration members

BROTLI

BROTLI = 64

LZ4

LZ4 = 16

LZO

LZO = 32

ZLIB

ZLIB = 1

Generated using TypeDoc

\ No newline at end of file +XpraInflateBit | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraInflateBit

Index

Enumeration members

Enumeration members

BROTLI

BROTLI = 64

LZ4

LZ4 = 16

LZO

LZO = 32

ZLIB

ZLIB = 1

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/enums/XpraLogLevel.html b/ts/docs/enums/XpraLogLevel.html index accdfd06..53c4f22b 100644 --- a/ts/docs/enums/XpraLogLevel.html +++ b/ts/docs/enums/XpraLogLevel.html @@ -1 +1 @@ -XpraLogLevel | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraLogLevel

Index

Enumeration members

Enumeration members

DEBUG

DEBUG = 10

ERROR

ERROR = 40

INFO

INFO = 20

WARNING

WARNING = 30

Generated using TypeDoc

\ No newline at end of file +XpraLogLevel | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration XpraLogLevel

Index

Enumeration members

Enumeration members

DEBUG

DEBUG = 10

ERROR

ERROR = 40

INFO

INFO = 20

WARNING

WARNING = 30

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/BrowserFile.html b/ts/docs/interfaces/BrowserFile.html index a58827b3..2b0320ef 100644 --- a/ts/docs/interfaces/BrowserFile.html +++ b/ts/docs/interfaces/BrowserFile.html @@ -8,4 +8,4 @@
copyright

Copyright (C) 2016-2022 Antoine Martin antoine@devloop.org.uk

license

Licensed under MPL 2.0, see: http://www.mozilla.org/MPL/2.0/

link

https://github.com/Xpra-org/xpra-html5

-

Hierarchy

Index

Properties

Properties

buffer

buffer: Uint8Array

name

name: string

size

size: number

type

type: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

buffer

buffer: Uint8Array

name

name: string

size

size: number

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraAudioOptions.html b/ts/docs/interfaces/XpraAudioOptions.html index c05ccc1a..77c32802 100644 --- a/ts/docs/interfaces/XpraAudioOptions.html +++ b/ts/docs/interfaces/XpraAudioOptions.html @@ -1 +1 @@ -XpraAudioOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraAudioOptions

Hierarchy

  • XpraAudioOptions

Index

Properties

Properties

Optional end-of-stream

end-of-stream?: number

Optional start-of-stream

start-of-stream?: number

Generated using TypeDoc

\ No newline at end of file +XpraAudioOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraAudioOptions

Hierarchy

  • XpraAudioOptions

Index

Properties

Properties

Optional end-of-stream

end-of-stream?: number

Optional start-of-stream

start-of-stream?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraBaseCapability.html b/ts/docs/interfaces/XpraBaseCapability.html index a780bd1b..93dfd7fd 100644 --- a/ts/docs/interfaces/XpraBaseCapability.html +++ b/ts/docs/interfaces/XpraBaseCapability.html @@ -1 +1 @@ -XpraBaseCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraBaseCapability

Hierarchy

  • XpraBaseCapability

Index

Properties

Properties

argv

argv: string[]

bandwidth-limit

bandwidth-limit: number

brotli

brotli: boolean

Optional challenge_client_salt

challenge_client_salt?: string

Optional challenge_response

challenge_response?: string

client_type

client_type: string

clipboard.greedy

clipboard.greedy: boolean

clipboard.selections

clipboard.selections: XpraClipboardSelection[]

clipboard.want_targets

clipboard.want_targets: boolean

compression_level

compression_level: number

desktop_mode_size

desktop_mode_size: XpraVector

dpi

dpi: number

encoding.rgb_lz4

encoding.rgb_lz4: boolean

lz4

lz4: boolean

metadata.supported

metadata.supported: string[]

mouse.show

mouse.show: boolean

named_cursors

named_cursors: boolean

namespace

namespace: boolean

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

randr_notify

randr_notify: boolean

rencodeplus

rencodeplus: boolean

screen-resize-bigger

screen-resize-bigger: boolean

screen_sizes

screen_sizes: XpraScreen[]

server-window-resize

server-window-resize: boolean

session-type

session-type: string

session-type.full

session-type.full: string

setting-change

setting-change: boolean

share

share: boolean

sound.server_driven

sound.server_driven: boolean

Optional start-new-session

start-new-session?: Partial<XpraStartNewSession>

steal

steal: boolean

system_tray

system_tray: boolean

username

username: string

vrefresh

vrefresh: number

websocket.multi-packet

websocket.multi-packet: boolean

window.pre-map

window.pre-map: boolean

xkbmap_keycodes

xkbmap_keycodes: XpraXkbpMapKeycode[]

xkbmap_layout

xkbmap_layout: string

xkbmap_print

xkbmap_print: string

xkbmap_query

xkbmap_query: string

Generated using TypeDoc

\ No newline at end of file +XpraBaseCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraBaseCapability

Hierarchy

  • XpraBaseCapability

Index

Properties

Properties

argv

argv: string[]

bandwidth-limit

bandwidth-limit: number

brotli

brotli: boolean

Optional challenge_client_salt

challenge_client_salt?: string

Optional challenge_response

challenge_response?: string

client_type

client_type: string

clipboard.greedy

clipboard.greedy: boolean

clipboard.selections

clipboard.selections: XpraClipboardSelection[]

clipboard.want_targets

clipboard.want_targets: boolean

compression_level

compression_level: number

desktop_mode_size

desktop_mode_size: XpraVector

dpi

dpi: number

encoding.rgb_lz4

encoding.rgb_lz4: boolean

lz4

lz4: boolean

metadata.supported

metadata.supported: string[]

mouse.show

mouse.show: boolean

named_cursors

named_cursors: boolean

namespace

namespace: boolean

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

randr_notify

randr_notify: boolean

rencodeplus

rencodeplus: boolean

screen-resize-bigger

screen-resize-bigger: boolean

screen_sizes

screen_sizes: XpraScreen[]

server-window-resize

server-window-resize: boolean

session-type

session-type: string

session-type.full

session-type.full: string

setting-change

setting-change: boolean

share

share: boolean

sound.server_driven

sound.server_driven: boolean

Optional start-new-session

start-new-session?: Partial<XpraStartNewSession>

steal

steal: boolean

system_tray

system_tray: boolean

username

username: string

vrefresh

vrefresh: number

websocket.multi-packet

websocket.multi-packet: boolean

window.pre-map

window.pre-map: boolean

xkbmap_keycodes

xkbmap_keycodes: XpraXkbpMapKeycode[]

xkbmap_layout

xkbmap_layout: string

xkbmap_print

xkbmap_print: string

xkbmap_query

xkbmap_query: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraChallengePrompt.html b/ts/docs/interfaces/XpraChallengePrompt.html index 301b2418..711ffce0 100644 --- a/ts/docs/interfaces/XpraChallengePrompt.html +++ b/ts/docs/interfaces/XpraChallengePrompt.html @@ -1 +1 @@ -XpraChallengePrompt | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraChallengePrompt

Hierarchy

  • XpraChallengePrompt

Index

Properties

Properties

digest

digest: string

prompt

prompt: string

saltDigest

saltDigest: string

serverSalt

serverSalt: string

Generated using TypeDoc

\ No newline at end of file +XpraChallengePrompt | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraChallengePrompt

Hierarchy

  • XpraChallengePrompt

Index

Properties

Properties

digest

digest: string

prompt

prompt: string

saltDigest

saltDigest: string

serverSalt

serverSalt: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraCipher.html b/ts/docs/interfaces/XpraCipher.html index 2ac5eccb..fcd4d6d7 100644 --- a/ts/docs/interfaces/XpraCipher.html +++ b/ts/docs/interfaces/XpraCipher.html @@ -1 +1 @@ -XpraCipher | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCipher

Hierarchy

  • XpraCipher

Index

Properties

Properties

blockSize

blockSize: number

cipher

cipher: string

iv

iv: string

keyHash

keyHash: string

mode

mode: string

secret

secret: string

Generated using TypeDoc

\ No newline at end of file +XpraCipher | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCipher

Hierarchy

  • XpraCipher

Index

Properties

Properties

blockSize

blockSize: number

cipher

cipher: string

iv

iv: string

keyHash

keyHash: string

mode

mode: string

secret

secret: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraCipherCapability.html b/ts/docs/interfaces/XpraCipherCapability.html index 48329b30..10d59127 100644 --- a/ts/docs/interfaces/XpraCipherCapability.html +++ b/ts/docs/interfaces/XpraCipherCapability.html @@ -1 +1 @@ -XpraCipherCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCipherCapability

Hierarchy

  • XpraCipherCapability

Index

Properties

Properties

Optional cipher

cipher?: string

Optional cipher.iv

cipher.iv?: string

Optional cipher.key_hash

cipher.key_hash?: string

Optional cipher.key_salt

cipher.key_salt?: string

Optional cipher.key_size

cipher.key_size?: number

Optional cipher.key_stretch

cipher.key_stretch?: string

Optional cipher.key_stretch_iterations

cipher.key_stretch_iterations?: number

Optional cipher.mode

cipher.mode?: string

Optional cipher.padding.options

cipher.padding.options?: string[]

Generated using TypeDoc

\ No newline at end of file +XpraCipherCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCipherCapability

Hierarchy

  • XpraCipherCapability

Index

Properties

Properties

Optional cipher

cipher?: string

Optional cipher.iv

cipher.iv?: string

Optional cipher.key_hash

cipher.key_hash?: string

Optional cipher.key_salt

cipher.key_salt?: string

Optional cipher.key_size

cipher.key_size?: number

Optional cipher.key_stretch

cipher.key_stretch?: string

Optional cipher.key_stretch_iterations

cipher.key_stretch_iterations?: number

Optional cipher.mode

cipher.mode?: string

Optional cipher.padding.options

cipher.padding.options?: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraClientConfiguration.html b/ts/docs/interfaces/XpraClientConfiguration.html index cdcb8cf8..e385e2a4 100644 --- a/ts/docs/interfaces/XpraClientConfiguration.html +++ b/ts/docs/interfaces/XpraClientConfiguration.html @@ -1 +1 @@ -XpraClientConfiguration | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraClientConfiguration

Hierarchy

  • XpraClientConfiguration

Index

Properties

Properties

Optional decoder

decoder?: Worker | XpraDecodeWorker

Optional worker

worker?: Worker | XpraPacketWorker

Generated using TypeDoc

\ No newline at end of file +XpraClientConfiguration | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraClientConfiguration

Hierarchy

  • XpraClientConfiguration

Index

Properties

Properties

Optional decoder

decoder?: Worker | XpraDecodeWorker

Optional worker

worker?: Worker | XpraPacketWorker

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraCommonCapability.html b/ts/docs/interfaces/XpraCommonCapability.html index cd1975a4..8f6fa5a0 100644 --- a/ts/docs/interfaces/XpraCommonCapability.html +++ b/ts/docs/interfaces/XpraCommonCapability.html @@ -3,4 +3,4 @@
link

https://github.com/andersevenrud/xpra-html5-client

author

Anders Evenrud andersevenrud@gmail.com

license

Mozilla Public License Version 2.0

-

Hierarchy

Index

Properties

Properties

auto_refresh_delay

auto_refresh_delay: number

bell

bell: boolean

bencode

bencode: boolean

build.branch

build.branch: string

build.local_modifications

build.local_modifications: number

build.revision

build.revision: string

clipboard

clipboard: boolean

clipboard.contents-slice-fix

clipboard.contents-slice-fix: boolean

clipboard.preferred-targets

clipboard.preferred-targets: string[]

connection-data

connection-data: Record<string, string | number>

cursors

cursors: boolean

desktop_size

desktop_size: XpraVector

digest

digest: string[]

display

display: string

encoding

encoding: XpraPacketEncoder

file-size-limit

file-size-limit: number

file-transfer

file-transfer: boolean

flush

flush: boolean

keyboard

keyboard: boolean

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

open-url

open-url: boolean

ping-echo-sourceid

ping-echo-sourceid: boolean

platform

platform: string

platform.name

platform.name: string

platform.platform

platform.platform: string

platform.processor

platform.processor: string

printing

printing: boolean

rencode

rencode: boolean

salt-digest

salt-digest: string[]

uuid

uuid: string

version

version: string

windows

windows: boolean

xdg-menu-update

xdg-menu-update: boolean

yaml

yaml: boolean

zlib

zlib: boolean

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

auto_refresh_delay

auto_refresh_delay: number

bell

bell: boolean

bencode

bencode: boolean

build.branch

build.branch: string

build.local_modifications

build.local_modifications: number

build.revision

build.revision: string

clipboard

clipboard: boolean

clipboard.contents-slice-fix

clipboard.contents-slice-fix: boolean

clipboard.preferred-targets

clipboard.preferred-targets: string[]

connection-data

connection-data: Record<string, string | number>

cursors

cursors: boolean

desktop_size

desktop_size: XpraVector

digest

digest: string[]

display

display: string

encoding

encoding: XpraPacketEncoder

file-size-limit

file-size-limit: number

file-transfer

file-transfer: boolean

flush

flush: boolean

keyboard

keyboard: boolean

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

open-url

open-url: boolean

ping-echo-sourceid

ping-echo-sourceid: boolean

platform

platform: string

platform.name

platform.name: string

platform.platform

platform.platform: string

platform.processor

platform.processor: string

printing

printing: boolean

rencode

rencode: boolean

salt-digest

salt-digest: string[]

uuid

uuid: string

version

version: string

windows

windows: boolean

xdg-menu-update

xdg-menu-update: boolean

yaml

yaml: boolean

zlib

zlib: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraConnectionOptions.html b/ts/docs/interfaces/XpraConnectionOptions.html index 11166874..12d2aba7 100644 --- a/ts/docs/interfaces/XpraConnectionOptions.html +++ b/ts/docs/interfaces/XpraConnectionOptions.html @@ -1 +1 @@ -XpraConnectionOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraConnectionOptions

Hierarchy

  • XpraConnectionOptions

Index

Properties

Properties

audio

audio: boolean

bandWidthLimit

bandWidthLimit: number

bell

bell: boolean

clipboard

clipboard: boolean

clipboardDirection

clipboardDirection: XpraClipboardDirection

clipboardImages

clipboardImages: boolean

connectionTimeout

connectionTimeout: number

cursor

cursor: boolean

debugPackets

debugPackets: string[]

display

display: string

encoder

encoder: XpraPacketEncoder

encryption

encryption: null | string

encryptionKey

encryptionKey: string

exitWithChildren

exitWithChildren: boolean

exitWithClient

exitWithClient: boolean

fileTransfer

fileTransfer: boolean

keyboard

keyboard: boolean

keyboardLayout

keyboardLayout: string

mouse

mouse: boolean

nativeVideo

nativeVideo: boolean

notifications

notifications: boolean

openUrl

openUrl: boolean

password

password: string

pingInterval

pingInterval: number

printing

printing: boolean

reconnect

reconnect: boolean

reconnectAttempts

reconnectAttempts: number

reconnectInterval

reconnectInterval: number

reverseScrollX

reverseScrollX: boolean

reverseScrollY

reverseScrollY: boolean

shareSession

shareSession: boolean

showStartMenu

showStartMenu: boolean

showStatistics

showStatistics: boolean

ssl

ssl: boolean

startCommand

startCommand: string

startNewSession

startNewSession: null | XpraStartNewSessionMode

stealSession

stealSession: boolean

swapKeys

swapKeys: boolean

tray

tray: boolean

username

username: string

video

video: boolean

Generated using TypeDoc

\ No newline at end of file +XpraConnectionOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraConnectionOptions

Hierarchy

  • XpraConnectionOptions

Index

Properties

Properties

audio

audio: boolean

bandWidthLimit

bandWidthLimit: number

bell

bell: boolean

clipboard

clipboard: boolean

clipboardDirection

clipboardDirection: XpraClipboardDirection

clipboardImages

clipboardImages: boolean

connectionTimeout

connectionTimeout: number

cursor

cursor: boolean

debugPackets

debugPackets: string[]

display

display: string

encoder

encoder: XpraPacketEncoder

encryption

encryption: null | string

encryptionKey

encryptionKey: string

exitWithChildren

exitWithChildren: boolean

exitWithClient

exitWithClient: boolean

fileTransfer

fileTransfer: boolean

keyboard

keyboard: boolean

keyboardLayout

keyboardLayout: string

mouse

mouse: boolean

nativeVideo

nativeVideo: boolean

notifications

notifications: boolean

openUrl

openUrl: boolean

password

password: string

pingInterval

pingInterval: number

printing

printing: boolean

reconnect

reconnect: boolean

reconnectAttempts

reconnectAttempts: number

reconnectInterval

reconnectInterval: number

reverseScrollX

reverseScrollX: boolean

reverseScrollY

reverseScrollY: boolean

shareSession

shareSession: boolean

showStartMenu

showStartMenu: boolean

showStatistics

showStatistics: boolean

ssl

ssl: boolean

startCommand

startCommand: string

startNewSession

startNewSession: null | XpraStartNewSessionMode

stealSession

stealSession: boolean

swapKeys

swapKeys: boolean

tray

tray: boolean

username

username: string

video

video: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraConnectionStats.html b/ts/docs/interfaces/XpraConnectionStats.html index bcb552f2..ed418a4e 100644 --- a/ts/docs/interfaces/XpraConnectionStats.html +++ b/ts/docs/interfaces/XpraConnectionStats.html @@ -1 +1 @@ -XpraConnectionStats | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraConnectionStats

Hierarchy

  • XpraConnectionStats

Index

Properties

Properties

clientPingLatency

clientPingLatency: number

lastClientEcho

lastClientEcho: number

lastServerPing

lastServerPing: number

serverLoad

serverLoad: [number, number, number]

serverPingLatency

serverPingLatency: number

Generated using TypeDoc

\ No newline at end of file +XpraConnectionStats | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraConnectionStats

Hierarchy

  • XpraConnectionStats

Index

Properties

Properties

clientPingLatency

clientPingLatency: number

lastClientEcho

lastClientEcho: number

lastServerPing

lastServerPing: number

serverLoad

serverLoad: [number, number, number]

serverPingLatency

serverPingLatency: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraCursor.html b/ts/docs/interfaces/XpraCursor.html index c83cebea..d5bedd69 100644 --- a/ts/docs/interfaces/XpraCursor.html +++ b/ts/docs/interfaces/XpraCursor.html @@ -1 +1 @@ -XpraCursor | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCursor

Hierarchy

  • XpraCursor

Index

Properties

Properties

dimension

dimension: XpraVector

image

image: string

xhot

xhot: number

yhot

yhot: number

Generated using TypeDoc

\ No newline at end of file +XpraCursor | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraCursor

Hierarchy

  • XpraCursor

Index

Properties

Properties

dimension

dimension: XpraVector

image

image: string

xhot

xhot: number

yhot

yhot: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraDraw.html b/ts/docs/interfaces/XpraDraw.html index 2840e174..a264c323 100644 --- a/ts/docs/interfaces/XpraDraw.html +++ b/ts/docs/interfaces/XpraDraw.html @@ -1 +1 @@ -XpraDraw | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraDraw

Hierarchy

  • XpraDraw

Index

Properties

Properties

dimension

dimension: XpraVector

encoding

encoding: XpraDrawEncoding

image

image: Uint8Array | XpraDrawScrollData

options

options: XpraDrawOptions

packetSequence

packetSequence: number

position

position: XpraVector

rowStride

rowStride: number

startTime

startTime: number

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraDraw | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraDraw

Hierarchy

  • XpraDraw

Index

Properties

Properties

dimension

dimension: XpraVector

encoding

encoding: XpraDrawEncoding

image

image: Uint8Array | XpraDrawScrollData

options

options: XpraDrawOptions

packetSequence

packetSequence: number

position

position: XpraVector

rowStride

rowStride: number

startTime

startTime: number

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraDrawOptions.html b/ts/docs/interfaces/XpraDrawOptions.html index b62e1839..93048eb5 100644 --- a/ts/docs/interfaces/XpraDrawOptions.html +++ b/ts/docs/interfaces/XpraDrawOptions.html @@ -1 +1 @@ -XpraDrawOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraDrawOptions

Hierarchy

  • XpraDrawOptions

Index

Properties

Properties

Optional csc

csc?: string

Optional decode_time

decode_time?: number

Optional flush

flush?: number

Optional frame

frame?: number

Optional lz4

lz4?: number

Optional pts

pts?: number

Optional type

type?: string

Optional zlib

zlib?: number

Generated using TypeDoc

\ No newline at end of file +XpraDrawOptions | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraDrawOptions

Hierarchy

  • XpraDrawOptions

Index

Properties

Properties

Optional csc

csc?: string

Optional decode_time

decode_time?: number

Optional flush

flush?: number

Optional frame

frame?: number

Optional lz4

lz4?: number

Optional pts

pts?: number

Optional type

type?: string

Optional zlib

zlib?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraEncodingCapability.html b/ts/docs/interfaces/XpraEncodingCapability.html index e058c78e..f920a931 100644 --- a/ts/docs/interfaces/XpraEncodingCapability.html +++ b/ts/docs/interfaces/XpraEncodingCapability.html @@ -1 +1 @@ -XpraEncodingCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraEncodingCapability

Hierarchy

  • XpraEncodingCapability

Index

Properties

Properties

encoding.color-gamut

encoding.color-gamut: string

encoding.decoder-speed

encoding.decoder-speed: { video: number }

Type declaration

  • video: number

encoding.eos

encoding.eos: boolean

encoding.flush

encoding.flush: boolean

encoding.full_csc_modes

encoding.full_csc_modes: Record<string, string[]>

encoding.h264+mp4.

encoding.h264+mp4.: number

encoding.h264+mp4.YUV420P.level

encoding.h264+mp4.YUV420P.level: string

encoding.h264+mp4.YUV420P.profile

encoding.h264+mp4.YUV420P.profile: string

encoding.h264+mp4.score-delta

encoding.h264+mp4.score-delta: number

encoding.h264.YUV420P.level

encoding.h264.YUV420P.level: string

encoding.h264.YUV420P.profile

encoding.h264.YUV420P.profile: string

encoding.h264.cabac

encoding.h264.cabac: boolean

encoding.h264.deblocking-filter

encoding.h264.deblocking-filter: boolean

encoding.h264.fast-decode

encoding.h264.fast-decode: boolean

encoding.h264.score-delta

encoding.h264.score-delta: number

encoding.icons.max_size

encoding.icons.max_size: XpraVector

encoding.mpeg4+mp4.score-delta

encoding.mpeg4+mp4.score-delta: number

encoding.rgb_zlib

encoding.rgb_zlib: boolean

encoding.scrolling

encoding.scrolling: boolean

encoding.transparency

encoding.transparency: boolean

encoding.video_max_size

encoding.video_max_size: XpraVector

encoding.video_scaling

encoding.video_scaling: boolean

encoding.vp8+webm.score-delta

encoding.vp8+webm.score-delta: number

encoding.x264.YUV420P.profile

encoding.x264.YUV420P.profile: string

encodings

encodings: XpraDrawEncoding[]

encodings.core

encodings.core: XpraDrawEncoding[]

encodings.cursor

encodings.cursor: string[]

encodings.packet

encodings.packet: boolean

encodings.rgb_formats

encodings.rgb_formats: XpraRGBFormats[]

encodings.window-icon

encodings.window-icon: string[]

Generated using TypeDoc

\ No newline at end of file +XpraEncodingCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraEncodingCapability

Hierarchy

  • XpraEncodingCapability

Index

Properties

Properties

encoding.color-gamut

encoding.color-gamut: string

encoding.decoder-speed

encoding.decoder-speed: { video: number }

Type declaration

  • video: number

encoding.eos

encoding.eos: boolean

encoding.flush

encoding.flush: boolean

encoding.full_csc_modes

encoding.full_csc_modes: Record<string, string[]>

encoding.h264+mp4.

encoding.h264+mp4.: number

encoding.h264+mp4.YUV420P.level

encoding.h264+mp4.YUV420P.level: string

encoding.h264+mp4.YUV420P.profile

encoding.h264+mp4.YUV420P.profile: string

encoding.h264+mp4.score-delta

encoding.h264+mp4.score-delta: number

encoding.h264.YUV420P.level

encoding.h264.YUV420P.level: string

encoding.h264.YUV420P.profile

encoding.h264.YUV420P.profile: string

encoding.h264.cabac

encoding.h264.cabac: boolean

encoding.h264.deblocking-filter

encoding.h264.deblocking-filter: boolean

encoding.h264.fast-decode

encoding.h264.fast-decode: boolean

encoding.h264.score-delta

encoding.h264.score-delta: number

encoding.icons.max_size

encoding.icons.max_size: XpraVector

encoding.mpeg4+mp4.score-delta

encoding.mpeg4+mp4.score-delta: number

encoding.rgb_zlib

encoding.rgb_zlib: boolean

encoding.scrolling

encoding.scrolling: boolean

encoding.transparency

encoding.transparency: boolean

encoding.video_max_size

encoding.video_max_size: XpraVector

encoding.video_scaling

encoding.video_scaling: boolean

encoding.vp8+webm.score-delta

encoding.vp8+webm.score-delta: number

encoding.x264.YUV420P.profile

encoding.x264.YUV420P.profile: string

encodings

encodings: XpraDrawEncoding[]

encodings.core

encodings.core: XpraDrawEncoding[]

encodings.cursor

encodings.cursor: string[]

encodings.packet

encodings.packet: boolean

encodings.rgb_formats

encodings.rgb_formats: XpraRGBFormats[]

encodings.window-icon

encodings.window-icon: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraNotification.html b/ts/docs/interfaces/XpraNotification.html index b15ad4a7..f1f2c84b 100644 --- a/ts/docs/interfaces/XpraNotification.html +++ b/ts/docs/interfaces/XpraNotification.html @@ -1 +1 @@ -XpraNotification | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraNotification

Hierarchy

  • XpraNotification

Index

Properties

Properties

actions

actions: string[]

body

body: string

expires

expires: number

hints

hints: string[]

icon

icon: null | string

id

id: number

replacesId

replacesId: number

summary

summary: string

Generated using TypeDoc

\ No newline at end of file +XpraNotification | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraNotification

Hierarchy

  • XpraNotification

Index

Properties

Properties

actions

actions: string[]

body

body: string

expires

expires: number

hints

hints: string[]

icon

icon: null | string

id

id: number

replacesId

replacesId: number

summary

summary: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraPointerPosition.html b/ts/docs/interfaces/XpraPointerPosition.html index 544a06ad..c203b7da 100644 --- a/ts/docs/interfaces/XpraPointerPosition.html +++ b/ts/docs/interfaces/XpraPointerPosition.html @@ -1 +1 @@ -XpraPointerPosition | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraPointerPosition

Hierarchy

  • XpraPointerPosition

Index

Properties

Properties

position

position: XpraVector

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraPointerPosition | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraPointerPosition

Hierarchy

  • XpraPointerPosition

Index

Properties

Properties

position

position: XpraVector

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraSendFile.html b/ts/docs/interfaces/XpraSendFile.html index 3f0e05c6..5ed7d011 100644 --- a/ts/docs/interfaces/XpraSendFile.html +++ b/ts/docs/interfaces/XpraSendFile.html @@ -1 +1 @@ -XpraSendFile | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraSendFile

Hierarchy

  • XpraSendFile

Index

Properties

Properties

blob

blob: Blob

filename

filename: string

mime

mime: string

print

print: boolean

size

size: number

Generated using TypeDoc

\ No newline at end of file +XpraSendFile | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraSendFile

Hierarchy

  • XpraSendFile

Index

Properties

Properties

blob

blob: Blob

filename

filename: string

mime

mime: string

print

print: boolean

size

size: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraServerBaseCapability.html b/ts/docs/interfaces/XpraServerBaseCapability.html index 1edc2d9d..ffe95821 100644 --- a/ts/docs/interfaces/XpraServerBaseCapability.html +++ b/ts/docs/interfaces/XpraServerBaseCapability.html @@ -1 +1 @@ -XpraServerBaseCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraServerBaseCapability

Hierarchy

Index

Properties

Properties

actual_desktop_size

actual_desktop_size: XpraVector

aliases

aliases: boolean

auto-video-encoding

auto-video-encoding: boolean

auto_refresh_delay

auto_refresh_delay: number

av-sync

av-sync: boolean

av-sync.enabled

av-sync.enabled: boolean

bell

bell: boolean

bencode

bencode: boolean

bencode.version

bencode.version: string

build.bit

build.bit: string

build.branch

build.branch: string

build.commit

build.commit: string

build.compiler

build.compiler: string

build.cpu

build.cpu: string

build.cython

build.cython: string

build.date

build.date: string

build.lib.gobject_introspection

build.lib.gobject_introspection: string

build.lib.gtk

build.lib.gtk: string

build.lib.gtk_x11

build.lib.gtk_x11: string

build.lib.nvenc

build.lib.nvenc: string

build.lib.nvfbc

build.lib.nvfbc: string

build.lib.py3cairo

build.lib.py3cairo: string

build.lib.pygobject

build.lib.pygobject: string

build.lib.python3

build.lib.python3: string

build.lib.vpx

build.lib.vpx: string

build.lib.x11

build.lib.x11: string

build.lib.x264

build.lib.x264: string

build.lib.x265

build.lib.x265: string

build.lib.xcomposite

build.lib.xcomposite: string

build.lib.xdamage

build.lib.xdamage: string

build.lib.xext

build.lib.xext: string

build.lib.xfixes

build.lib.xfixes: string

build.lib.xkbfile

build.lib.xkbfile: string

build.lib.xrandr

build.lib.xrandr: string

build.lib.xtst

build.lib.xtst: string

build.linker

build.linker: string

build.local_modifications

build.local_modifications: number

build.python

build.python: string

build.revision

build.revision: string

build.time

build.time: string

build.version

build.version: string

byteorder

byteorder: string

cairo.version

cairo.version: string

client-shutdown

client-shutdown: boolean

clipboard

clipboard: boolean

clipboard-direction

clipboard-direction: string

clipboard.contents-slice-fix

clipboard.contents-slice-fix: boolean

clipboard.enable-selections

clipboard.enable-selections: boolean

clipboard.loop-uuids.CLIPBOARD

clipboard.loop-uuids.CLIPBOARD: string

clipboard.loop-uuids.PRIMARY

clipboard.loop-uuids.PRIMARY: string

clipboard.loop-uuids.SECONDARY

clipboard.loop-uuids.SECONDARY: string

clipboard.preferred-targets

clipboard.preferred-targets: string[]

clipboards

clipboards: string[]

compressors

compressors: string[]

configure.pointer

configure.pointer: boolean

connection-data

connection-data: Record<string, string | number>

current_time

current_time: number

cursor.default_size

cursor.default_size: XpraVector

cursor.max_size

cursor.max_size: XpraVector

cursors

cursors: boolean

dbus_proxy

dbus_proxy: boolean

desktop_size

desktop_size: XpraVector

digest

digest: string[]

display

display: string

elapsed_time

elapsed_time: number

encoders

encoders: XpraCompressor[]

encoding

encoding: XpraPacketEncoder

exit-with-children

exit-with-children: boolean

file-ask-timeout

file-ask-timeout: number

file-chunks

file-chunks: number

file-size-limit

file-size-limit: number

file-transfer

file-transfer: boolean

file-transfer-ask

file-transfer-ask: boolean

flush

flush: boolean

force_ungrab

force_ungrab: string

gdk.version

gdk.version: string

gi.version

gi.version: string

gid

gid: number

glib.version

glib.version: string

gobject.version

gobject.version: string

gtk.version

gtk.version: string

hostname

hostname: string

input-devices

input-devices: string[]

key_repeat

key_repeat: number[]

key_repeat_modifiers

key_repeat_modifiers: boolean

keyboard

keyboard: boolean

keyboard.fast-switching

keyboard.fast-switching: boolean

lock

lock: boolean

lock-toggle

lock-toggle: boolean

lz4.python-lz4

lz4.python-lz4: boolean

lz4.python-lz4.version

lz4.python-lz4.version: boolean

lz4.version

lz4.version: string

machine_id

machine_id: string

max-file-size

max-file-size: number

max_desktop_size

max_desktop_size: XpraVector

Optional modifier_keycodes

modifier_keycodes?: XpraModifierKeycodes

network.bandwidth-limit

network.bandwidth-limit: number

network.bandwidth-limit-change

network.bandwidth-limit-change: boolean

none

none: boolean

none.version

none.version: string

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

open-files

open-files: boolean

open-files-ask

open-files-ask: boolean

open-url

open-url: boolean

open-url-ask

open-url-ask: boolean

opengl

opengl: boolean

pango.version

pango.version: string

pid

pid: number

ping-echo-sourceid

ping-echo-sourceid: boolean

pixbuf.version

pixbuf.version: string

platform

platform: string

platform.architecture

platform.architecture: string

platform.linux_distribution

platform.linux_distribution: string

platform.machine

platform.machine: string

platform.name

platform.name: string

platform.platform

platform.platform: string

platform.processor

platform.processor: string

platform.release

platform.release: string

platform.sysrelease

platform.sysrelease: string

pointer

pointer: boolean

pointer.grabs

pointer.grabs: boolean

pointer.relative

pointer.relative: boolean

printer.attributes

printer.attributes: string[]

printing

printing: boolean

printing-ask

printing-ask: boolean

python.bits

python.bits: number

python.full_version

python.full_version: string

python.version

python.version: string

readonly

readonly: boolean

readonly-server

readonly-server: boolean

remote-logging

remote-logging: boolean

remote-logging.multi-line

remote-logging.multi-line: boolean

remote-logging.receive

remote-logging.receive: boolean

remote-logging.send

remote-logging.send: boolean

rencode

rencode: boolean

rencode.version

rencode.version: string

request-file

request-file: boolean

resize_exact

resize_exact: string

resize_screen

resize_screen: string

root_window_size

root_window_size: XpraVector

rpc-types

rpc-types: string[]

salt-digest

salt-digest: string[]

screen-sizes

screen-sizes: XpraVector[]

server-commands-info

server-commands-info: boolean

server-commands-signals

server-commands-signals: string[]

server-log

server-log: string

server.mode

server.mode: string

server_type

server_type: string

session_name

session_name: string

sharing

sharing: boolean

sharing-toggle

sharing-toggle: boolean

shell

shell: boolean

sound.codec-full-names

sound.codec-full-names: boolean

sound.demuxers

sound.demuxers: string[]

sound.device.Xpra-Microphone

sound.device.Xpra-Microphone: string

sound.device.Xpra-Microphone.monitor

sound.device.Xpra-Microphone.monitor: string

sound.device.Xpra-Speaker

sound.device.Xpra-Speaker: string

sound.device.Xpra-Speaker.monitor

sound.device.Xpra-Speaker.monitor: string

sound.devices

sound.devices: number

sound.encoders

sound.encoders: string[]

sound.gst.version

sound.gst.version: string

sound.muxers

sound.muxers: string[]

sound.ogg-latency-fix

sound.ogg-latency-fix: boolean

sound.plugins

sound.plugins: string[]

sound.pulseaudio.cookie-hash

sound.pulseaudio.cookie-hash: string

sound.pulseaudio.found

sound.pulseaudio.found: boolean

sound.pulseaudio.id

sound.pulseaudio.id: string

sound.pulseaudio.server

sound.pulseaudio.server: string

sound.pulseaudio.wrapper

sound.pulseaudio.wrapper: string

sound.pygst.version

sound.pygst.version: string

sound.python.bits

sound.python.bits: number

sound.python.version

sound.python.version: string

sound.sink.default

sound.sink.default: string[]

sound.sinks

sound.sinks: string[]

sound.source.default

sound.source.default: string[]

sound.sources

sound.sources: string[]

start-new-commands

start-new-commands: boolean

start_time

start_time: number

subcommands

subcommands: string[]

toggle_keyboard_sync

toggle_keyboard_sync: boolean

touchpad-device

touchpad-device: boolean

uid

uid: number

uuid

uuid: string

version

version: string

virtual-video-devices

virtual-video-devices: string[]

webcam

webcam: boolean

webcam.encodings

webcam.encodings: string[]

wheel.precise

wheel.precise: boolean

window-filters

window-filters: boolean

window.configure.delta

window.configure.delta: boolean

window.decorations

window.decorations: boolean

window.dragndrop

window.dragndrop: boolean

window.frame-extents

window.frame-extents: boolean

window.signals

window.signals: string[]

window.states

window.states: string[]

window_refresh_config

window_refresh_config: boolean

windows

windows: boolean

xdg-menu

xdg-menu: boolean

xdg-menu-update

xdg-menu-update: boolean

yaml

yaml: boolean

yaml.version

yaml.version: string

zlib

zlib: boolean

zlib.python-zlib

zlib.python-zlib: boolean

zlib.python-zlib.version

zlib.python-zlib.version: string

Generated using TypeDoc

\ No newline at end of file +XpraServerBaseCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraServerBaseCapability

Hierarchy

Index

Properties

Properties

actual_desktop_size

actual_desktop_size: XpraVector

aliases

aliases: boolean

auto-video-encoding

auto-video-encoding: boolean

auto_refresh_delay

auto_refresh_delay: number

av-sync

av-sync: boolean

av-sync.enabled

av-sync.enabled: boolean

bell

bell: boolean

bencode

bencode: boolean

bencode.version

bencode.version: string

build.bit

build.bit: string

build.branch

build.branch: string

build.commit

build.commit: string

build.compiler

build.compiler: string

build.cpu

build.cpu: string

build.cython

build.cython: string

build.date

build.date: string

build.lib.gobject_introspection

build.lib.gobject_introspection: string

build.lib.gtk

build.lib.gtk: string

build.lib.gtk_x11

build.lib.gtk_x11: string

build.lib.nvenc

build.lib.nvenc: string

build.lib.nvfbc

build.lib.nvfbc: string

build.lib.py3cairo

build.lib.py3cairo: string

build.lib.pygobject

build.lib.pygobject: string

build.lib.python3

build.lib.python3: string

build.lib.vpx

build.lib.vpx: string

build.lib.x11

build.lib.x11: string

build.lib.x264

build.lib.x264: string

build.lib.x265

build.lib.x265: string

build.lib.xcomposite

build.lib.xcomposite: string

build.lib.xdamage

build.lib.xdamage: string

build.lib.xext

build.lib.xext: string

build.lib.xfixes

build.lib.xfixes: string

build.lib.xkbfile

build.lib.xkbfile: string

build.lib.xrandr

build.lib.xrandr: string

build.lib.xtst

build.lib.xtst: string

build.linker

build.linker: string

build.local_modifications

build.local_modifications: number

build.python

build.python: string

build.revision

build.revision: string

build.time

build.time: string

build.version

build.version: string

byteorder

byteorder: string

cairo.version

cairo.version: string

client-shutdown

client-shutdown: boolean

clipboard

clipboard: boolean

clipboard-direction

clipboard-direction: string

clipboard.contents-slice-fix

clipboard.contents-slice-fix: boolean

clipboard.enable-selections

clipboard.enable-selections: boolean

clipboard.loop-uuids.CLIPBOARD

clipboard.loop-uuids.CLIPBOARD: string

clipboard.loop-uuids.PRIMARY

clipboard.loop-uuids.PRIMARY: string

clipboard.loop-uuids.SECONDARY

clipboard.loop-uuids.SECONDARY: string

clipboard.preferred-targets

clipboard.preferred-targets: string[]

clipboards

clipboards: string[]

compressors

compressors: string[]

configure.pointer

configure.pointer: boolean

connection-data

connection-data: Record<string, string | number>

current_time

current_time: number

cursor.default_size

cursor.default_size: XpraVector

cursor.max_size

cursor.max_size: XpraVector

cursors

cursors: boolean

dbus_proxy

dbus_proxy: boolean

desktop_size

desktop_size: XpraVector

digest

digest: string[]

display

display: string

elapsed_time

elapsed_time: number

encoders

encoders: XpraCompressor[]

encoding

encoding: XpraPacketEncoder

exit-with-children

exit-with-children: boolean

file-ask-timeout

file-ask-timeout: number

file-chunks

file-chunks: number

file-size-limit

file-size-limit: number

file-transfer

file-transfer: boolean

file-transfer-ask

file-transfer-ask: boolean

flush

flush: boolean

force_ungrab

force_ungrab: string

gdk.version

gdk.version: string

gi.version

gi.version: string

gid

gid: number

glib.version

glib.version: string

gobject.version

gobject.version: string

gtk.version

gtk.version: string

hostname

hostname: string

input-devices

input-devices: string[]

key_repeat

key_repeat: number[]

key_repeat_modifiers

key_repeat_modifiers: boolean

keyboard

keyboard: boolean

keyboard.fast-switching

keyboard.fast-switching: boolean

lock

lock: boolean

lock-toggle

lock-toggle: boolean

lz4.python-lz4

lz4.python-lz4: boolean

lz4.python-lz4.version

lz4.python-lz4.version: boolean

lz4.version

lz4.version: string

machine_id

machine_id: string

max-file-size

max-file-size: number

max_desktop_size

max_desktop_size: XpraVector

Optional modifier_keycodes

modifier_keycodes?: XpraModifierKeycodes

network.bandwidth-limit

network.bandwidth-limit: number

network.bandwidth-limit-change

network.bandwidth-limit-change: boolean

none

none: boolean

none.version

none.version: string

notifications

notifications: boolean

notifications.actions

notifications.actions: boolean

notifications.close

notifications.close: boolean

open-files

open-files: boolean

open-files-ask

open-files-ask: boolean

open-url

open-url: boolean

open-url-ask

open-url-ask: boolean

opengl

opengl: boolean

pango.version

pango.version: string

pid

pid: number

ping-echo-sourceid

ping-echo-sourceid: boolean

pixbuf.version

pixbuf.version: string

platform

platform: string

platform.architecture

platform.architecture: string

platform.linux_distribution

platform.linux_distribution: string

platform.machine

platform.machine: string

platform.name

platform.name: string

platform.platform

platform.platform: string

platform.processor

platform.processor: string

platform.release

platform.release: string

platform.sysrelease

platform.sysrelease: string

pointer

pointer: boolean

pointer.grabs

pointer.grabs: boolean

pointer.relative

pointer.relative: boolean

printer.attributes

printer.attributes: string[]

printing

printing: boolean

printing-ask

printing-ask: boolean

python.bits

python.bits: number

python.full_version

python.full_version: string

python.version

python.version: string

readonly

readonly: boolean

readonly-server

readonly-server: boolean

remote-logging

remote-logging: boolean

remote-logging.multi-line

remote-logging.multi-line: boolean

remote-logging.receive

remote-logging.receive: boolean

remote-logging.send

remote-logging.send: boolean

rencode

rencode: boolean

rencode.version

rencode.version: string

request-file

request-file: boolean

resize_exact

resize_exact: string

resize_screen

resize_screen: string

root_window_size

root_window_size: XpraVector

rpc-types

rpc-types: string[]

salt-digest

salt-digest: string[]

screen-sizes

screen-sizes: XpraVector[]

server-commands-info

server-commands-info: boolean

server-commands-signals

server-commands-signals: string[]

server-log

server-log: string

server.mode

server.mode: string

server_type

server_type: string

session_name

session_name: string

sharing

sharing: boolean

sharing-toggle

sharing-toggle: boolean

shell

shell: boolean

sound.codec-full-names

sound.codec-full-names: boolean

sound.demuxers

sound.demuxers: string[]

sound.device.Xpra-Microphone

sound.device.Xpra-Microphone: string

sound.device.Xpra-Microphone.monitor

sound.device.Xpra-Microphone.monitor: string

sound.device.Xpra-Speaker

sound.device.Xpra-Speaker: string

sound.device.Xpra-Speaker.monitor

sound.device.Xpra-Speaker.monitor: string

sound.devices

sound.devices: number

sound.encoders

sound.encoders: string[]

sound.gst.version

sound.gst.version: string

sound.muxers

sound.muxers: string[]

sound.ogg-latency-fix

sound.ogg-latency-fix: boolean

sound.plugins

sound.plugins: string[]

sound.pulseaudio.cookie-hash

sound.pulseaudio.cookie-hash: string

sound.pulseaudio.found

sound.pulseaudio.found: boolean

sound.pulseaudio.id

sound.pulseaudio.id: string

sound.pulseaudio.server

sound.pulseaudio.server: string

sound.pulseaudio.wrapper

sound.pulseaudio.wrapper: string

sound.pygst.version

sound.pygst.version: string

sound.python.bits

sound.python.bits: number

sound.python.version

sound.python.version: string

sound.sink.default

sound.sink.default: string[]

sound.sinks

sound.sinks: string[]

sound.source.default

sound.source.default: string[]

sound.sources

sound.sources: string[]

start-new-commands

start-new-commands: boolean

start_time

start_time: number

subcommands

subcommands: string[]

toggle_keyboard_sync

toggle_keyboard_sync: boolean

touchpad-device

touchpad-device: boolean

uid

uid: number

uuid

uuid: string

version

version: string

virtual-video-devices

virtual-video-devices: string[]

webcam

webcam: boolean

webcam.encodings

webcam.encodings: string[]

wheel.precise

wheel.precise: boolean

window-filters

window-filters: boolean

window.configure.delta

window.configure.delta: boolean

window.decorations

window.decorations: boolean

window.dragndrop

window.dragndrop: boolean

window.frame-extents

window.frame-extents: boolean

window.signals

window.signals: string[]

window.states

window.states: string[]

window_refresh_config

window_refresh_config: boolean

windows

windows: boolean

xdg-menu

xdg-menu: boolean

xdg-menu-update

xdg-menu-update: boolean

yaml

yaml: boolean

yaml.version

yaml.version: string

zlib

zlib: boolean

zlib.python-zlib

zlib.python-zlib: boolean

zlib.python-zlib.version

zlib.python-zlib.version: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraSoundCapability.html b/ts/docs/interfaces/XpraSoundCapability.html index c9dd9cf0..fd366516 100644 --- a/ts/docs/interfaces/XpraSoundCapability.html +++ b/ts/docs/interfaces/XpraSoundCapability.html @@ -1 +1 @@ -XpraSoundCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraSoundCapability

Hierarchy

  • XpraSoundCapability

Index

Properties

Properties

sound.bundle-metadata

sound.bundle-metadata: boolean

sound.decoders

sound.decoders: string[]

sound.receive

sound.receive: boolean

sound.send

sound.send: boolean

Generated using TypeDoc

\ No newline at end of file +XpraSoundCapability | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraSoundCapability

Hierarchy

  • XpraSoundCapability

Index

Properties

Properties

sound.bundle-metadata

sound.bundle-metadata: boolean

sound.decoders

sound.decoders: string[]

sound.receive

sound.receive: boolean

sound.send

sound.send: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraStartNewSession.html b/ts/docs/interfaces/XpraStartNewSession.html index 8ec2f6e1..2534b2a2 100644 --- a/ts/docs/interfaces/XpraStartNewSession.html +++ b/ts/docs/interfaces/XpraStartNewSession.html @@ -1 +1 @@ -XpraStartNewSession | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraStartNewSession

Hierarchy

  • XpraStartNewSession

Index

Properties

Properties

exit-with-children

exit-with-children: boolean

exit-with-client

exit-with-client: boolean

mode

mode: XpraStartNewSessionMode

Optional start

start?: string[]

Optional start-child

start-child?: string[]

Generated using TypeDoc

\ No newline at end of file +XpraStartNewSession | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraStartNewSession

Hierarchy

  • XpraStartNewSession

Index

Properties

Properties

exit-with-children

exit-with-children: boolean

exit-with-client

exit-with-client: boolean

mode

mode: XpraStartNewSessionMode

Optional start

start?: string[]

Optional start-child

start-child?: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindow.html b/ts/docs/interfaces/XpraWindow.html index 8f071696..3473c8f9 100644 --- a/ts/docs/interfaces/XpraWindow.html +++ b/ts/docs/interfaces/XpraWindow.html @@ -1 +1 @@ -XpraWindow | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindow

Hierarchy

  • XpraWindow

Index

Properties

Properties

clientProperties

clientProperties: XpraWindowClientProperties

dimension

dimension: XpraVector

id

id: number

metadata

metadata: XpraWindowMetadata

overrideRedirect

overrideRedirect: boolean

position

position: XpraVector

Generated using TypeDoc

\ No newline at end of file +XpraWindow | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindow

Hierarchy

  • XpraWindow

Index

Properties

Properties

clientProperties

clientProperties: XpraWindowClientProperties

dimension

dimension: XpraVector

id

id: number

metadata

metadata: XpraWindowMetadata

overrideRedirect

overrideRedirect: boolean

position

position: XpraVector

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowIcon.html b/ts/docs/interfaces/XpraWindowIcon.html index 423d6e7d..e5ed46a0 100644 --- a/ts/docs/interfaces/XpraWindowIcon.html +++ b/ts/docs/interfaces/XpraWindowIcon.html @@ -1 +1 @@ -XpraWindowIcon | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowIcon

Hierarchy

  • XpraWindowIcon

Index

Properties

Properties

dimension

dimension: XpraVector

image

image: string

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraWindowIcon | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowIcon

Hierarchy

  • XpraWindowIcon

Index

Properties

Properties

dimension

dimension: XpraVector

image

image: string

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowInitiateMoveResize.html b/ts/docs/interfaces/XpraWindowInitiateMoveResize.html index dcc8228f..e0747891 100644 --- a/ts/docs/interfaces/XpraWindowInitiateMoveResize.html +++ b/ts/docs/interfaces/XpraWindowInitiateMoveResize.html @@ -1 +1 @@ -XpraWindowInitiateMoveResize | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowInitiateMoveResize

Hierarchy

  • XpraWindowInitiateMoveResize

Index

Properties

Properties

button

button: number

direction

direction: number

position

position: XpraVector

sourceIndication

sourceIndication: number

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraWindowInitiateMoveResize | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowInitiateMoveResize

Hierarchy

  • XpraWindowInitiateMoveResize

Index

Properties

Properties

button

button: number

direction

direction: number

position

position: XpraVector

sourceIndication

sourceIndication: number

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowManagerWindow.html b/ts/docs/interfaces/XpraWindowManagerWindow.html index 51a7c167..3f15fe89 100644 --- a/ts/docs/interfaces/XpraWindowManagerWindow.html +++ b/ts/docs/interfaces/XpraWindowManagerWindow.html @@ -1 +1 @@ -XpraWindowManagerWindow | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowManagerWindow

Hierarchy

  • XpraWindowManagerWindow

Index

Properties

Properties

attributes

attributes: XpraWindow

canvas

canvas: HTMLCanvasElement

destroyed

destroyed: boolean

inited

inited: boolean

renderPending

renderPending: number

renderQueue

renderQueue: XpraDraw[]

Generated using TypeDoc

\ No newline at end of file +XpraWindowManagerWindow | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowManagerWindow

Hierarchy

  • XpraWindowManagerWindow

Index

Properties

Properties

attributes

attributes: XpraWindow

canvas

canvas: HTMLCanvasElement

destroyed

destroyed: boolean

inited

inited: boolean

renderPending

renderPending: number

renderQueue

renderQueue: XpraDraw[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowMetadata.html b/ts/docs/interfaces/XpraWindowMetadata.html index f9e1cb26..ec635ada 100644 --- a/ts/docs/interfaces/XpraWindowMetadata.html +++ b/ts/docs/interfaces/XpraWindowMetadata.html @@ -1 +1 @@ -XpraWindowMetadata | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMetadata

Hierarchy

  • XpraWindowMetadata

Index

Properties

Properties

Optional above

above?: boolean

Optional below

below?: boolean

class-instance

class-instance: string[]

Optional decorations

decorations?: number

Optional fullscreen

fullscreen?: boolean

Optional has-alpha

has-alpha?: boolean

Optional iconic

iconic?: boolean

Optional maximized

maximized?: boolean

Optional modal

modal?: boolean

Optional opacity

opacity?: number

Optional size-constraints

size-constraints?: { base-size?: XpraVector; gravity?: number; increment?: XpraVector; maximum-size?: XpraVector; minimum-size?: XpraVector; position?: XpraVector }

Type declaration

title

title: string

Optional transient-for

transient-for?: number

Optional tray

tray?: boolean

window-type

window-type: XpraWindowMetadataType[]

Generated using TypeDoc

\ No newline at end of file +XpraWindowMetadata | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMetadata

Hierarchy

  • XpraWindowMetadata

Index

Properties

Properties

Optional above

above?: boolean

Optional below

below?: boolean

class-instance

class-instance: string[]

Optional decorations

decorations?: number

Optional fullscreen

fullscreen?: boolean

Optional has-alpha

has-alpha?: boolean

Optional iconic

iconic?: boolean

Optional maximized

maximized?: boolean

Optional modal

modal?: boolean

Optional opacity

opacity?: number

Optional size-constraints

size-constraints?: { base-size?: XpraVector; gravity?: number; increment?: XpraVector; maximum-size?: XpraVector; minimum-size?: XpraVector; position?: XpraVector }

Type declaration

title

title: string

Optional transient-for

transient-for?: number

Optional tray

tray?: boolean

window-type

window-type: XpraWindowMetadataType[]

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowMetadataUpdate.html b/ts/docs/interfaces/XpraWindowMetadataUpdate.html index cfe27736..85ece401 100644 --- a/ts/docs/interfaces/XpraWindowMetadataUpdate.html +++ b/ts/docs/interfaces/XpraWindowMetadataUpdate.html @@ -1 +1 @@ -XpraWindowMetadataUpdate | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMetadataUpdate

Hierarchy

  • XpraWindowMetadataUpdate

Index

Properties

Properties

metadata

metadata: Partial<XpraWindowMetadata>

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraWindowMetadataUpdate | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMetadataUpdate

Hierarchy

  • XpraWindowMetadataUpdate

Index

Properties

Properties

metadata

metadata: Partial<XpraWindowMetadata>

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowMoveResize.html b/ts/docs/interfaces/XpraWindowMoveResize.html index 09d19297..3b963777 100644 --- a/ts/docs/interfaces/XpraWindowMoveResize.html +++ b/ts/docs/interfaces/XpraWindowMoveResize.html @@ -1 +1 @@ -XpraWindowMoveResize | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMoveResize

Hierarchy

  • XpraWindowMoveResize

Index

Properties

Properties

Optional dimension

dimension?: XpraVector

Optional position

position?: XpraVector

wid

wid: number

Generated using TypeDoc

\ No newline at end of file +XpraWindowMoveResize | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowMoveResize

Hierarchy

  • XpraWindowMoveResize

Index

Properties

Properties

Optional dimension

dimension?: XpraVector

Optional position

position?: XpraVector

wid

wid: number

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraWindowState.html b/ts/docs/interfaces/XpraWindowState.html index 4b07fcee..e41adf22 100644 --- a/ts/docs/interfaces/XpraWindowState.html +++ b/ts/docs/interfaces/XpraWindowState.html @@ -1 +1 @@ -XpraWindowState | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowState

Hierarchy

  • XpraWindowState

Index

Properties

Properties

Optional focused

focused?: boolean

Generated using TypeDoc

\ No newline at end of file +XpraWindowState | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraWindowState

Hierarchy

  • XpraWindowState

Index

Properties

Properties

Optional focused

focused?: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraXDGEntryData.html b/ts/docs/interfaces/XpraXDGEntryData.html index dae4b3fe..238f6727 100644 --- a/ts/docs/interfaces/XpraXDGEntryData.html +++ b/ts/docs/interfaces/XpraXDGEntryData.html @@ -1 +1 @@ -XpraXDGEntryData | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGEntryData

Hierarchy

  • XpraXDGEntryData

Index

Properties

Properties

Categories

Categories: string[]

Comment

Comment: string

Exec

Exec: string

Optional IconData

IconData?: string

Optional IconType

IconType?: string

Name

Name: string

Type

Type: string

Generated using TypeDoc

\ No newline at end of file +XpraXDGEntryData | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGEntryData

Hierarchy

  • XpraXDGEntryData

Index

Properties

Properties

Categories

Categories: string[]

Comment

Comment: string

Exec

Exec: string

Optional IconData

IconData?: string

Optional IconType

IconType?: string

Name

Name: string

Type

Type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraXDGMenuData.html b/ts/docs/interfaces/XpraXDGMenuData.html index e81240d4..c671be9a 100644 --- a/ts/docs/interfaces/XpraXDGMenuData.html +++ b/ts/docs/interfaces/XpraXDGMenuData.html @@ -1 +1 @@ -XpraXDGMenuData | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGMenuData

Hierarchy

  • XpraXDGMenuData

Index

Properties

Properties

Entries

Entries: Record<string, XpraXDGEntryData>

Optional IconData

IconData?: string

Optional IconType

IconType?: string

Name

Name: string

Generated using TypeDoc

\ No newline at end of file +XpraXDGMenuData | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGMenuData

Hierarchy

  • XpraXDGMenuData

Index

Properties

Properties

Entries

Entries: Record<string, XpraXDGEntryData>

Optional IconData

IconData?: string

Optional IconType

IconType?: string

Name

Name: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/interfaces/XpraXDGReducedMenuEntry.html b/ts/docs/interfaces/XpraXDGReducedMenuEntry.html index a959d977..11f8c245 100644 --- a/ts/docs/interfaces/XpraXDGReducedMenuEntry.html +++ b/ts/docs/interfaces/XpraXDGReducedMenuEntry.html @@ -1 +1 @@ -XpraXDGReducedMenuEntry | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGReducedMenuEntry

Hierarchy

  • XpraXDGReducedMenuEntry

Index

Properties

Properties

attributes

attributes: XpraXDGEntryData

exec

exec: string

Optional icon

icon?: string

name

name: string

Generated using TypeDoc

\ No newline at end of file +XpraXDGReducedMenuEntry | xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XpraXDGReducedMenuEntry

Hierarchy

  • XpraXDGReducedMenuEntry

Index

Properties

Properties

attributes

attributes: XpraXDGEntryData

exec

exec: string

Optional icon

icon?: string

name

name: string

Generated using TypeDoc

\ No newline at end of file diff --git a/ts/docs/modules.html b/ts/docs/modules.html index b433447b..5ac72fda 100644 --- a/ts/docs/modules.html +++ b/ts/docs/modules.html @@ -1,8 +1,8 @@ -xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

xpra-html5-client

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

XpraAudioCodec

XpraAudioCodec: string

XpraAudioCodecMap

XpraAudioCodecMap: Record<XpraAudioCodecType, XpraAudioCodec>

XpraAudioCodecType

XpraAudioCodecType: string

XpraAudioEventEmitters

XpraAudioEventEmitters: { start: any; stop: any }

Type declaration

XpraAudioFramework

XpraAudioFramework: "mediasource" | "aurora"

XpraAudioMetadata

XpraAudioMetadata: string[]

XpraCapabilities

XpraCapabilities: XpraCommonCapability & XpraBaseCapability & XpraCipherCapability & XpraEncodingCapability & XpraSoundCapability

XpraChallengeCallback

XpraChallengeCallback: (password: string) => void

Type declaration

    • (password: string): void

    • Parameters

      • password: string

      Returns void

XpraClientEventEmitters

XpraClientEventEmitters: { bell: any; challengePrompt: any; connect: any; cursor: any; disconnect: any; draw: any; drawBuffer: any; drawScroll: any; eos: any; error: any; hello: any; hideNotification: any; infoResponse: any; initiateMoveResize: any; moveResizeWindow: any; newTray: any; newWindow: any; openUrl: any; pointerPosition: any; pong: any; raiseWindow: any; removeWindow: any; sendFile: any; sessionStarted: any; showNotification: any; updateWindowMetadata: any; updateXDGMenu: any; windowIcon: any }

Type declaration

XpraClipboardDirection

XpraClipboardDirection: "to-server" | "both"

XpraClipboardEventEmitters

XpraClipboardEventEmitters: { send: any; token: any }

Type declaration

  • send:function
    • send(requestId: number, selection: string, buffer: string, dataType?: string, dataFormat?: number, encoding?: string): void

    • Parameters

      • requestId: number
      • selection: string
      • buffer: string
      • Optional dataType: string
      • Optional dataFormat: number
      • Optional encoding: string

      Returns void

  • token:function
    • token(data: string): void

XpraClipboardSelection

XpraClipboardSelection: "CLIPBOARD" | "PRIMARY"

XpraClipboardTarget

XpraClipboardTarget: "UTF8_STRING" | "TEXT" | "STRING" | "text/plain" | "image/png"

XpraCompressor

XpraCompressor: "zlib" | "lz4" | "none"

XpraConnectionStatus

XpraConnectionStatus: "disconnected" | "connecting" | "connected" | "reconnecting"

XpraDrawEncoding

XpraDrawEncoding: "webp" | "jpeg" | "png" | "png/P" | "png/L" | "rgb32" | "rgb24" | "avif" | "scroll" | "void" | "rgb" | "h264" | "mpeg1" | "vp8+webm" | "h264+mp4" | "mpeg4+mp4"

XpraDrawScrollData

XpraDrawScrollData: [number, number, number, number, number, number][]

XpraKeyboardEventEmitters

XpraKeyboardEventEmitters: { layoutChanged: any }

Type declaration

XpraLoggerArguments

XpraLoggerArguments: any[]

XpraLoggerEventEmitters

XpraLoggerEventEmitters: { log: any }

Type declaration

XpraLoggerType

XpraLoggerType: "log" | "info" | "warn" | "error" | "debug"

XpraModifierKeycodes

XpraModifierKeycodes: Record<string, [string, number][]>

XpraMonitor

XpraMonitor: [string, number, number, number, number, number, number]

XpraPacketArguments

XpraPacketArguments: any[]

XpraPacketEncoder

XpraPacketEncoder: "bencode" | "rencode" | "rencodeplus" | "auto"

XpraQueueEventEmitters

XpraQueueEventEmitters<_, M>: { failure: any; message: any }

Type parameters

  • _

  • M

Type declaration

XpraRGBFormats

XpraRGBFormats: "RGBX" | "RGBA" | "RGB"

XpraRecieveHeader

XpraRecieveHeader: number[]

XpraRecievePacket

XpraRecievePacket: [XpraRecievePacketType, ...XpraPacketArguments]

XpraRecievePacketType

XpraRecievePacketType: "hello" | "new-window" | "window-icon" | "startup-complete" | "encodings" | "cursor" | "ping" | "ping_echo" | "draw" | "setting-change" | "window-move-resize" | "window-resized" | "raise-window" | "lost-window" | "window-metadata" | "new-override-redirect" | "configure-override-redirect" | "notify_show" | "notify_close" | "bell" | "initiate-moveresize" | "send-file" | "sound-data" | "clipboard-token" | "set-clipboard-enabled" | "clipboard-request" | "challenge" | "info-response" | "new-tray" | "pointer-position" | "eos" | "disconnect" | "open-url"

XpraScreen

XpraScreen: [string, number, number, number, number, XpraMonitor[], number, number, number, number]

XpraSendPacket

XpraSendPacket: [XpraSendPacketType, ...XpraPacketArguments]

XpraSendPacketType

XpraSendPacketType: "hello" | "ping" | "ping_echo" | "desktop_size" | "close-window" | "map-window" | "unmap-window" | "configure-window" | "damage-sequence" | "pointer-position" | "wheel-motion" | "button-action" | "key-action" | "focus" | "notification-close" | "suspend" | "resume" | "buffer-refresh" | "connection-data" | "sound-control" | "start-command" | "clipboard-contents-none" | "clipboard-contents" | "clipboard-token" | "logging" | "send-file" | "shutdown-server" | "layout-changed"

XpraServerCapabilities

XpraServerCapabilities: XpraCommonCapability & XpraSoundCapability & XpraServerBaseCapability

XpraSettingChangeValue

XpraSettingChangeValue: XpraXDGMenu | Record<string, string>

XpraStartNewSessionMode

XpraStartNewSessionMode: "shadow" | "start-desktop" | "start"

XpraVector

XpraVector: [number, number]

XpraWebsocketEventEmitters

XpraWebsocketEventEmitters: { close: any; connect: any; disconnect: any; error: any; message: any; open: any }

Type declaration

XpraWindowMetadataType

XpraWindowMetadataType: "" | "NORMAL" | "DIALOG" | "UTILITY" | "DROPDOWN" | "TOOLTIP" | "POPUP_MENU" | "MENU" | "COMBO" | "DESKTOP"

XpraWorkerData

XpraWorkerData: any

XpraWorkerEventEmitters

XpraWorkerEventEmitters: { error: any; message: any; post: any }
+xpra-html5-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

xpra-html5-client

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

XpraAudioCodec

XpraAudioCodec: string

XpraAudioCodecMap

XpraAudioCodecMap: Record<XpraAudioCodecType, XpraAudioCodec>

XpraAudioCodecType

XpraAudioCodecType: string

XpraAudioEventEmitters

XpraAudioEventEmitters: { start: any; stop: any }

Type declaration

XpraAudioFramework

XpraAudioFramework: "mediasource" | "aurora"

XpraAudioMetadata

XpraAudioMetadata: string[]

XpraCapabilities

XpraCapabilities: XpraCommonCapability & XpraBaseCapability & XpraCipherCapability & XpraEncodingCapability & XpraSoundCapability

XpraChallengeCallback

XpraChallengeCallback: (password: string) => void

Type declaration

    • (password: string): void

    • Parameters

      • password: string

      Returns void

XpraClientEventEmitters

XpraClientEventEmitters: { bell: any; challengePrompt: any; connect: any; cursor: any; disconnect: any; draw: any; drawBuffer: any; drawScroll: any; eos: any; error: any; hello: any; hideNotification: any; infoResponse: any; initiateMoveResize: any; moveResizeWindow: any; newTray: any; newWindow: any; openUrl: any; pointerPosition: any; pong: any; raiseWindow: any; removeWindow: any; sendFile: any; sessionStarted: any; showNotification: any; updateWindowMetadata: any; updateXDGMenu: any; windowIcon: any }

Type declaration

XpraClipboardDirection

XpraClipboardDirection: "to-server" | "both"

XpraClipboardEventEmitters

XpraClipboardEventEmitters: { send: any; token: any }

Type declaration

  • send:function
    • send(requestId: number, selection: string, buffer: string, dataType?: string, dataFormat?: number, encoding?: string): void

    • Parameters

      • requestId: number
      • selection: string
      • buffer: string
      • Optional dataType: string
      • Optional dataFormat: number
      • Optional encoding: string

      Returns void

  • token:function
    • token(data: string): void

XpraClipboardSelection

XpraClipboardSelection: "CLIPBOARD" | "PRIMARY"

XpraClipboardTarget

XpraClipboardTarget: "UTF8_STRING" | "TEXT" | "STRING" | "text/plain" | "image/png"

XpraCompressor

XpraCompressor: "zlib" | "lz4" | "none"

XpraConnectionStatus

XpraConnectionStatus: "disconnected" | "connecting" | "connected" | "reconnecting"

XpraDrawEncoding

XpraDrawEncoding: "webp" | "jpeg" | "png" | "png/P" | "png/L" | "rgb32" | "rgb24" | "avif" | "scroll" | "void" | "rgb" | "h264" | "mpeg1" | "vp8+webm" | "h264+mp4" | "mpeg4+mp4"

XpraDrawScrollData

XpraDrawScrollData: [number, number, number, number, number, number][]

XpraKeyboardEventEmitters

XpraKeyboardEventEmitters: { layoutChanged: any }

Type declaration

XpraLoggerArguments

XpraLoggerArguments: any[]

XpraLoggerEventEmitters

XpraLoggerEventEmitters: { log: any }

Type declaration

XpraLoggerType

XpraLoggerType: "log" | "info" | "warn" | "error" | "debug"

XpraModifierKeycodes

XpraModifierKeycodes: Record<string, [string, number][]>

XpraMonitor

XpraMonitor: [string, number, number, number, number, number, number]

XpraPacketArguments

XpraPacketArguments: any[]

XpraPacketEncoder

XpraPacketEncoder: "bencode" | "rencode" | "rencodeplus" | "auto"

XpraQueueEventEmitters

XpraQueueEventEmitters<_, M>: { failure: any; message: any }

Type parameters

  • _

  • M

Type declaration

XpraRGBFormats

XpraRGBFormats: "RGBX" | "RGBA" | "RGB"

XpraRecieveHeader

XpraRecieveHeader: number[]

XpraRecievePacket

XpraRecievePacket: [XpraRecievePacketType, ...XpraPacketArguments]

XpraRecievePacketType

XpraRecievePacketType: "hello" | "new-window" | "window-icon" | "startup-complete" | "encodings" | "cursor" | "ping" | "ping_echo" | "draw" | "setting-change" | "window-move-resize" | "window-resized" | "raise-window" | "lost-window" | "window-metadata" | "new-override-redirect" | "configure-override-redirect" | "notify_show" | "notify_close" | "bell" | "initiate-moveresize" | "send-file" | "sound-data" | "clipboard-token" | "set-clipboard-enabled" | "clipboard-request" | "challenge" | "info-response" | "new-tray" | "pointer-position" | "eos" | "disconnect" | "open-url"

XpraScreen

XpraScreen: [string, number, number, number, number, XpraMonitor[], number, number, number, number]

XpraSendPacket

XpraSendPacket: [XpraSendPacketType, ...XpraPacketArguments]

XpraSendPacketType

XpraSendPacketType: "hello" | "ping" | "ping_echo" | "desktop_size" | "close-window" | "map-window" | "unmap-window" | "configure-window" | "damage-sequence" | "pointer-position" | "wheel-motion" | "button-action" | "key-action" | "focus" | "notification-close" | "suspend" | "resume" | "buffer-refresh" | "connection-data" | "sound-control" | "start-command" | "clipboard-contents-none" | "clipboard-contents" | "clipboard-token" | "logging" | "send-file" | "shutdown-server" | "layout-changed"

XpraServerCapabilities

XpraServerCapabilities: XpraCommonCapability & XpraSoundCapability & XpraServerBaseCapability

XpraSettingChangeValue

XpraSettingChangeValue: XpraXDGMenu | Record<string, string>

XpraStartNewSessionMode

XpraStartNewSessionMode: "shadow" | "start-desktop" | "start"

XpraVector

XpraVector: [number, number]

XpraWebsocketEventEmitters

XpraWebsocketEventEmitters: { close: any; connect: any; disconnect: any; error: any; message: any; open: any }

Type declaration

XpraWindowMetadataType

XpraWindowMetadataType: "" | "NORMAL" | "DIALOG" | "UTILITY" | "DROPDOWN" | "TOOLTIP" | "POPUP_MENU" | "MENU" | "COMBO" | "DESKTOP"

XpraWorkerData

XpraWorkerData: any

XpraWorkerEventEmitters

XpraWorkerEventEmitters: { error: any; message: any; post: any }

Events emitted from the null worker to simulate a web worker

-

Type declaration

XpraWorkerMessage

XpraWorkerMessage: "connected" | "send" | "recieve" | "failure" | "configure" | "cipher" | "imagedata" | "decode"

XpraWorkerMessagePacket

XpraWorkerMessagePacket: [XpraWorkerMessage, XpraWorkerData]

XpraWorkerProxyEventEmitters

XpraWorkerProxyEventEmitters: { draw: any; failure: any; recieve: any; send: any }

Type declaration

XpraXDGMenu

XpraXDGMenu: Record<string, XpraXDGMenuData>

XpraXDGReducedMenu

XpraXDGReducedMenu: { entries: XpraXDGReducedMenuEntry[]; icon?: string; name: string }[]

XpraXkbpMapKeycode

XpraXkbpMapKeycode: [number, string, number, number, number]

Variables

Const XPRA_AUDIO_AURORA_CODECS

XPRA_AUDIO_AURORA_CODECS: Record<string, string> = ...

Const XPRA_AUDIO_CODEC_DESCRIPTION

XPRA_AUDIO_CODEC_DESCRIPTION: Record<string, string> = ...

Const XPRA_AUDIO_CODEC_STRING

XPRA_AUDIO_CODEC_STRING: Record<string, string> = ...

Const XPRA_AUDIO_PREFERRED_CODEC_ORDER

XPRA_AUDIO_PREFERRED_CODEC_ORDER: string[] = ...

Const XPRA_CHUNK_SZ

XPRA_CHUNK_SZ: 32768 = 0x8000

Const XPRA_CLIPBOARD_TARGETS

XPRA_CLIPBOARD_TARGETS: XpraClipboardTarget[] = ...

Const XPRA_CLOSE_CODES

XPRA_CLOSE_CODES: Record<number, string> = ...

Const XPRA_COLOR_GAMUT

XPRA_COLOR_GAMUT: Record<string, string> = ...

Const XPRA_DEFAULT_KEYSIZE

XPRA_DEFAULT_KEYSIZE: 32 = 32

Const XPRA_DEFAULT_KEY_HASH

XPRA_DEFAULT_KEY_HASH: "SHA1" = 'SHA1'

Const XPRA_DEFAULT_MODE

XPRA_DEFAULT_MODE: "CBC" = 'CBC'

Const XPRA_HEADER_SIZE

XPRA_HEADER_SIZE: 8 = 8

Const XPRA_HTML5_BRANCH

XPRA_HTML5_BRANCH: "master" = 'master'

Const XPRA_HTML5_LOCAL_MODIFICATIONS

XPRA_HTML5_LOCAL_MODIFICATIONS: 0 = 0

Const XPRA_HTML5_REVISION

XPRA_HTML5_REVISION: "1237" = '1237'

Const XPRA_HTML5_VERSION

XPRA_HTML5_VERSION: "5.0" = '5.0'

Const XPRA_IMAGE_ENCODERS

XPRA_IMAGE_ENCODERS: XpraDrawEncoding[] = ...

Const XPRA_KEYBOARD_LAYOUTS

XPRA_KEYBOARD_LAYOUTS: Record<string, string> = ...

Const XPRA_MAX_AUDIO_BUFFERS

XPRA_MAX_AUDIO_BUFFERS: 250 = 250

Const XPRA_PLATFORM

XPRA_PLATFORM: Record<string, string[]> = ...

Const XPRA_READ_ONLY_PACKETS

XPRA_READ_ONLY_PACKETS: string[] = ...

Const XPRA_RGB_FORMATS

XPRA_RGB_FORMATS: XpraRGBFormats[] = ...

Const initialXpraConnectionStats

initialXpraConnectionStats: XpraConnectionStats = ...

Functions

arrayBufferToBase64

  • arrayBufferToBase64(uintArray: Uint8Array): string

browserLoadFile

browserPrintFile

  • browserPrintFile(name: string, blob: Blob): void

browserReadClipboard

  • browserReadClipboard(textType: string): Promise<[string, string]>

browserSaveFile

  • browserSaveFile(name: string, blob: string | Blob): void

browserWriteClipboard

  • browserWriteClipboard(data: string, binaryType?: string): Promise<boolean>

createDefaultXpraConnectionOptions

XpraWorkerMessage

XpraWorkerMessage: "connected" | "send" | "recieve" | "failure" | "configure" | "cipher" | "imagedata" | "decode"

XpraWorkerMessagePacket

XpraWorkerMessagePacket: [XpraWorkerMessage, XpraWorkerData]

XpraWorkerProxyEventEmitters

XpraWorkerProxyEventEmitters: { draw: any; failure: any; recieve: any; send: any }

Type declaration

XpraXDGMenu

XpraXDGMenu: Record<string, XpraXDGMenuData>

XpraXDGReducedMenu

XpraXDGReducedMenu: { entries: XpraXDGReducedMenuEntry[]; icon?: string; name: string }[]

XpraXkbpMapKeycode

XpraXkbpMapKeycode: [number, string, number, number, number]

Variables

Const XPRA_AUDIO_AURORA_CODECS

XPRA_AUDIO_AURORA_CODECS: Record<string, string> = ...

Const XPRA_AUDIO_CODEC_DESCRIPTION

XPRA_AUDIO_CODEC_DESCRIPTION: Record<string, string> = ...

Const XPRA_AUDIO_CODEC_STRING

XPRA_AUDIO_CODEC_STRING: Record<string, string> = ...

Const XPRA_AUDIO_PREFERRED_CODEC_ORDER

XPRA_AUDIO_PREFERRED_CODEC_ORDER: string[] = ...

Const XPRA_CHUNK_SZ

XPRA_CHUNK_SZ: 32768 = 0x8000

Const XPRA_CLIPBOARD_TARGETS

XPRA_CLIPBOARD_TARGETS: XpraClipboardTarget[] = ...

Const XPRA_CLOSE_CODES

XPRA_CLOSE_CODES: Record<number, string> = ...

Const XPRA_COLOR_GAMUT

XPRA_COLOR_GAMUT: Record<string, string> = ...

Const XPRA_DEFAULT_KEYSIZE

XPRA_DEFAULT_KEYSIZE: 32 = 32

Const XPRA_DEFAULT_KEY_HASH

XPRA_DEFAULT_KEY_HASH: "SHA1" = 'SHA1'

Const XPRA_DEFAULT_MODE

XPRA_DEFAULT_MODE: "CBC" = 'CBC'

Const XPRA_HEADER_SIZE

XPRA_HEADER_SIZE: 8 = 8

Const XPRA_HTML5_BRANCH

XPRA_HTML5_BRANCH: "master" = 'master'

Const XPRA_HTML5_LOCAL_MODIFICATIONS

XPRA_HTML5_LOCAL_MODIFICATIONS: 0 = 0

Const XPRA_HTML5_REVISION

XPRA_HTML5_REVISION: "1237" = '1237'

Const XPRA_HTML5_VERSION

XPRA_HTML5_VERSION: "5.0" = '5.0'

Const XPRA_IMAGE_ENCODERS

XPRA_IMAGE_ENCODERS: XpraDrawEncoding[] = ...

Const XPRA_KEYBOARD_LAYOUTS

XPRA_KEYBOARD_LAYOUTS: Record<string, string> = ...

Const XPRA_MAX_AUDIO_BUFFERS

XPRA_MAX_AUDIO_BUFFERS: 250 = 250

Const XPRA_PLATFORM

XPRA_PLATFORM: Record<string, string[]> = ...

Const XPRA_READ_ONLY_PACKETS

XPRA_READ_ONLY_PACKETS: string[] = ...

Const XPRA_RGB_FORMATS

XPRA_RGB_FORMATS: XpraRGBFormats[] = ...

Const initialXpraConnectionStats

initialXpraConnectionStats: XpraConnectionStats = ...

Functions

arrayBufferToBase64

  • arrayBufferToBase64(uintArray: Uint8Array): string

browserLoadFile

browserPrintFile

  • browserPrintFile(name: string, blob: Blob): void

browserReadClipboard

  • browserReadClipboard(textType: string): Promise<[string, string]>

browserSaveFile

  • browserSaveFile(name: string, blob: string | Blob): void

browserWriteClipboard

  • browserWriteClipboard(data: string, binaryType?: string): Promise<boolean>

createDefaultXpraConnectionOptions

createHexUUID

  • createHexUUID(): string

createNativeNotification

  • createNativeNotification(title: string, options: NotificationOptions): Promise<null | Notification>

createHexUUID

  • createHexUUID(): string

createNativeNotification

  • createNativeNotification(title: string, options: NotificationOptions): Promise<null | Notification>

createRandomSecureString

  • createRandomSecureString(len: number): string

createXDGMenu

createRandomSecureString

  • createRandomSecureString(len: number): string

createXDGMenu

createXpraCapabilities

createXpraCapabilities

createXpraCapabilitiesFromOptions

createXpraCapabilitiesFromOptions

createXpraChallengeDigest

  • createXpraChallengeDigest(digest: string, password: string, salt: string): null | string

createXpraChallengeDigest

  • createXpraChallengeDigest(digest: string, password: string, salt: string): null | string

createXpraChallengeResponse

  • createXpraChallengeResponse(serverSalt: string, digest: string, saltDigest: string, password: string, useSsl: boolean, useEncryption: null | string): string[]

createXpraChallengeResponse

  • createXpraChallengeResponse(serverSalt: string, digest: string, saltDigest: string, password: string, useSsl: boolean, useEncryption: null | string): string[]

  • Processes a connection challenge and creates data for an appropriate response

    -

    Parameters

    • serverSalt: string
    • digest: string
    • saltDigest: string
    • password: string
    • useSsl: boolean
    • useEncryption: null | string

    Returns string[]

createXpraCipher

createXpraCipher

createXpraCloseError

  • createXpraCloseError(ev: Event | CloseEvent): Error

createXpraConnectionOptionsFromUrl

createXpraCloseError

  • createXpraCloseError(ev: Event | CloseEvent): Error

createXpraConnectionOptionsFromUrl

createXpraScreen

  • createXpraScreen(w: number, h: number): XpraScreen[]

createXpraScreen

  • createXpraScreen(w: number, h: number): XpraScreen[]

createXpraWindowBaseZindex

  • createXpraWindowBaseZindex(win: XpraWindow, zIndex: number): number

createXpraWindowBaseZindex

  • createXpraWindowBaseZindex(win: XpraWindow, zIndex: number): number

  • Creates a new z-index for a window (or surface). This is calculated from a base index which is derived from the window type(s).

    -

    Parameters

    Returns number

decodeXpraPacketData

  • decodeXpraPacketData(packetData: string | Uint8Array, protoFlags: number): any

decodeXpraPacketData

  • decodeXpraPacketData(packetData: string | Uint8Array, protoFlags: number): any

decompressXpraDrawData

decompressXpraDrawData

decompressXpraPacketData

  • decompressXpraPacketData(packetData: Uint8Array, level: number): Uint8Array

decompressXpraPacketData

  • decompressXpraPacketData(packetData: Uint8Array, level: number): Uint8Array

decryptXpraPacketData

  • decryptXpraPacketData(packet: Uint8Array, size: number, padding: number, cipher: BlockCipher): Uint8Array

decryptXpraPacketData

  • decryptXpraPacketData(packet: Uint8Array, size: number, padding: number, cipher: BlockCipher): Uint8Array

encodeXpraPacket

encodeXpraPacket

encryptXpraPacketData

  • encryptXpraPacketData(data: string | Uint8Array, size: number, blockSize: number, cipher: BlockCipher): string

encryptXpraPacketData

  • encryptXpraPacketData(data: string | Uint8Array, size: number, blockSize: number, cipher: BlockCipher): string

getBrowser

  • getBrowser(): { agent: string; layout: string; name: string }

getBrowserColorGamut

  • getBrowserColorGamut(): string

getBrowserConnectionInfo

  • getBrowserConnectionInfo(): Record<string, string | number>

getBrowserDPI

  • getBrowserDPI(): number

getBrowserLanguages

  • getBrowserLanguages(): string[]

getBrowserPlatform

  • getBrowserPlatform(): { name: string; platform: string; processor: string; type: string }

getBrowserSupportsClipboard

  • getBrowserSupportsClipboard(): boolean

getBrowser

  • getBrowser(): { agent: string; layout: string; name: string }

getBrowserColorGamut

  • getBrowserColorGamut(): string

getBrowserConnectionInfo

  • getBrowserConnectionInfo(): Record<string, string | number>

getBrowserDPI

  • getBrowserDPI(): number

getBrowserLanguages

  • getBrowserLanguages(): string[]

getBrowserPlatform

  • getBrowserPlatform(): { name: string; platform: string; processor: string; type: string }

getBrowserSupportsClipboard

  • getBrowserSupportsClipboard(): boolean

handleXpraKeycloakChallenge

handleXpraKeycloakChallenge

imageSourceFromData

  • imageSourceFromData(encoding: string, data: string | Uint8Array): string

imageSourceFromData

  • imageSourceFromData(encoding: string, data: string | Uint8Array): string

loadImage

  • loadImage(src: string): Promise<null | HTMLImageElement>

loadImage

  • loadImage(src: string): Promise<null | HTMLImageElement>

parseUrlQuerySearch

  • parseUrlQuerySearch<T>(search: string, __namedParameters: { booleans?: string[]; lists?: string[]; numbers?: string[]; required?: string[] }): T

parseUrlQuerySearch

  • parseUrlQuerySearch<T>(search: string, __namedParameters: { booleans?: string[]; lists?: string[]; numbers?: string[]; required?: string[] }): T

rgb24ToRgb32

  • rgb24ToRgb32(data: Uint8Array, width: number, height: number, rowStride: number): Uint8Array
  • +

    Type parameters

    • T

    Parameters

    • search: string
    • __namedParameters: { booleans?: string[]; lists?: string[]; numbers?: string[]; required?: string[] }
      • Optional booleans?: string[]
      • Optional lists?: string[]
      • Optional numbers?: string[]
      • Optional required?: string[]

    Returns T

rgb24ToRgb32

  • rgb24ToRgb32(data: Uint8Array, width: number, height: number, rowStride: number): Uint8Array

rgb32Restride

  • rgb32Restride(data: Uint8Array, width: number, height: number, rowStride: number): Uint8Array

rgb32Restride

  • rgb32Restride(data: Uint8Array, width: number, height: number, rowStride: number): Uint8Array

  • re-striding might be quicker to copy 32bit at a time using Uint32Array and then casting the result?

    -

    Parameters

    • data: Uint8Array
    • width: number
    • height: number
    • rowStride: number

    Returns Uint8Array

uint8fromString

  • uint8fromString(input: string): Uint8Array

uint8fromStringOrString

  • uint8fromStringOrString(input: string | Uint8Array): string

uint8fromStringOrUint8

  • uint8fromStringOrUint8(input: string | Uint8Array): Uint8Array

uint8toString

  • uint8toString(u8a: Uint8Array): string

unescapeUri

  • unescapeUri(s: string): string

xorString

  • xorString(str1: string, str2: string): string

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited method
  • Protected property
  • Protected method
  • Private property
  • Private method
  • Property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • data: Uint8Array
  • width: number
  • height: number
  • rowStride: number

Returns Uint8Array

uint8fromString

  • uint8fromString(input: string): Uint8Array

uint8fromStringOrString

  • uint8fromStringOrString(input: string | Uint8Array): string

uint8fromStringOrUint8

  • uint8fromStringOrUint8(input: string | Uint8Array): Uint8Array

uint8toString

  • uint8toString(u8a: Uint8Array): string

unescapeUri

  • unescapeUri(s: string): string

xorString

  • xorString(str1: string, str2: string): string

Generated using TypeDoc

\ No newline at end of file