diff options
author | Samuel Mannehed <samuel@cendio.se> | 2020-05-01 16:14:15 +0200 |
---|---|---|
committer | Samuel Mannehed <samuel@cendio.se> | 2020-05-01 20:47:36 +0200 |
commit | 479d8cefd16c36b7766762c9c3980bb419e62bf4 (patch) | |
tree | 055fb747fa33044461f5a053dd3e065562a25083 /docs | |
parent | a672168d4dac5735b40cfe618a47f76b69c85882 (diff) | |
download | novnc-479d8cefd16c36b7766762c9c3980bb419e62bf4.tar.gz |
Add ability to set compression level
Fixes github issue #1382.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/API.md | 8 | ||||
-rw-r--r-- | docs/EMBEDDING.md | 2 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/API.md b/docs/API.md index db43ec6..59b7cf1 100644 --- a/docs/API.md +++ b/docs/API.md @@ -69,6 +69,14 @@ protocol stream. Value `0` implies low quality and `9` implies high quality. Default value is `6`. +`compressionLevel` + - Is an `int` in range `[0-9]` controlling the desired compression + level. Value `0` means no compression. Level 1 uses a minimum of CPU + resources and achieves weak compression ratios, while level 9 offers + best compression but is slow in terms of CPU consumption on the server + side. Use high levels with very slow network connections. + Default value is `2`. + `capabilities` *Read only* - Is an `Object` indicating which optional extensions are available on the server. Some methods may only be called if the corresponding diff --git a/docs/EMBEDDING.md b/docs/EMBEDDING.md index 3f85f4b..6a5dcd8 100644 --- a/docs/EMBEDDING.md +++ b/docs/EMBEDDING.md @@ -63,6 +63,8 @@ query string. Currently the following options are available: * `quality` - The session JPEG quality level. Can be `0` to `9`. +* `compression` - The session compression level. Can be `0` to `9`. + * `show_dot` - If a dot cursor should be shown when the remote server provides no local cursor, or provides a fully-transparent (invisible) cursor. |