Andrey Trebler
efd1f8a4f2
adds qualityLevel property to RFB class for updating JPEG quality level encoding on the fly
2020-02-28 13:14:19 +01:00
Pierre Ossman
6aed0b4dd2
Deprecate showDotCursor option for RFB constructor
...
It is not relevant for the connection stage so it should not have
been a constructor argument to begin with. Ship with a warning for
a release before we remove it.
2019-08-23 14:00:20 +02:00
Samuel Mannehed
e14aa4d0fe
Add documentation for the option showDotCursor
...
This is not only a property, it's also a parameter to the constructor.
2019-07-23 16:07:17 +02:00
Samuel Mannehed
c912230309
Remove the default value of wsProtocols
...
Using the 'binary' protocol by default is very non-standard.
2019-07-23 16:03:49 +02:00
Shira Maximov
25b3d49d32
Add support in websocket sub-protocols
2019-07-23 13:44:18 +03:00
Mykola Mokhnach
d7791ebbcd
Make the screen background cutomizable
2019-01-18 19:36:23 +01:00
Alexander E. Patrakov
4c38179d15
Show dot when there is no visible cursor
...
Disabled by default.
2018-09-14 20:31:59 +05:00
Juanjo Diaz
2b5f94fa6a
Prefer const/let over var
2018-05-24 00:27:09 +03:00
Pierre Ossman
9b84f51685
Move resize handling in to RFB object
...
Makes the API simpler and makes it easier for other frontends to
get this functionality.
2017-12-06 11:29:57 +01:00
Samuel Mannehed
d472f3f19e
Abstract RFB errors to avoid sending strings
...
The API allowed strings to be passed from the RFB module to the
application using the disconnect reason. This caused problems since
the application didn't have control over translations for these
strings.
Most of the information being passed using this string was very
technical and not helpful to the end user. One exception to this was
the security result information regarding for example authentication
failures. The protocol allows the VNC server to pass a string
directly to the user in the security result.
So the disconnect reason is replaced by a boolean saying if the
disconnection was clean or not. And for the security result information
from the server, a new event has been added.
2017-11-14 15:36:12 +01:00
Samuel Mannehed
ee5cae9fee
Replace updatestate event with connect
...
Instead of exposing all the internal connection states, the RFB module
will now only send events on connect and on disconnect. This makes it
simpler for the application and gets rid of the double events that were
being sent on disconnect (previously updatestate and disconnect).
2017-11-14 14:10:36 +01:00
Samuel Mannehed
5b20d338ce
Remove RFB.notification()
...
This interface was a band aid for poor design. The two cases where it
was used was replaced by logging.
2017-11-11 02:10:12 +01:00
Pierre Ossman
a201bfc5eb
Merge branch 'api' of https://github.com/CendioOssman/noVNC
2017-11-10 14:19:05 +01:00
Pierre Ossman
e89eef94aa
Use standard EventTarget interface for events
2017-11-09 13:14:16 +01:00
Pierre Ossman
65fdfeae13
Remove unused options argument in onnotification event handler
2017-11-09 13:13:41 +01:00
Pierre Ossman
2f4516f293
Integrate connect() in to constructor
...
An RFB object represents a single connection so it doesn't make
sense to have one without it trying to connect right away. Matches
the behaviour of other APIs, e.g. WebSocket.
2017-11-09 13:13:41 +01:00
Pierre Ossman
68e09edcdc
Remove disconnectTimeout property
...
Callers should not need to modify this timeout.
2017-11-09 13:13:41 +01:00
Pierre Ossman
002907d2ce
Remove "downscale only" mode
...
The normal scaling mode should be sufficient for most use cases, so
let's keep the interface simple.
2017-11-09 13:13:41 +01:00
Pierre Ossman
8d1f0a3de8
Remove local cursor setting
...
We have no reason to disable this except for touch devices, which
we can handle without having a setting for it.
2017-11-09 13:13:41 +01:00
Pierre Ossman
0460e5fdbe
Improve naming for viewport properties
2017-11-09 13:13:41 +01:00
Pierre Ossman
a80aa41628
Change clippingDisplay() to a property
...
It fits much better as a property given that it only tells what the
current state of things are.
2017-11-09 13:13:41 +01:00
Pierre Ossman
4f90c1d387
Follow MDN style in API documentation
2017-11-09 13:13:39 +01:00
Pierre Ossman
747b462337
Use standard JavaScript properties
...
Use normal properties with JavaScript setters and getters instead of
our homegrown stuff.
This also changes the properties to follow normal naming conventions.
2017-11-09 13:03:32 +01:00
Pierre Ossman
3d7bb02036
Change some attributes to arguments
...
Some attributes are better suited as arguments, primarily because they
are associated with a specific method and cannot be changed later.
2017-11-09 12:52:05 +01:00
Pierre Ossman
f8318361b1
Remove wsProtocols setting
...
It isn't in use anymore since we deprecated support for Base64 mode.
2017-11-09 12:52:05 +01:00
Pierre Ossman
5b4e5d016e
Switch to URL for connect()
...
This is more in line with how other JavaScript APIs work.
2017-11-09 12:52:05 +01:00
Pierre Ossman
30691b668e
Remove onFBU* callbacks
...
They are internal mechanisms that callers should be isolated from.
2017-11-09 12:52:03 +01:00
Pierre Ossman
832be2625b
Add resize as a capability
...
Makes the API more transparent than piggybacking on completion
of the first framebuffer update.
2017-11-09 12:51:15 +01:00
Pierre Ossman
cd523e8f28
Make power API generic
...
Decouple it from XVP and make it a generic API.
2017-11-09 12:47:21 +01:00
Pierre Ossman
430f00d6fe
Allow other credentials than just password
...
Makes the XVP authentication mechanism more general.
2017-11-09 12:45:05 +01:00
Pierre Ossman
1d6ff4a3e9
Improved focus handling on touch input field
...
The previous method of retaining focus didn't work reliably when
the RFB object tried to move the focus to the canvas. Add a setting
to control "focus on click" behaviour instead of letting them try
to fight it out.
2017-11-02 15:30:36 +01:00
Pierre Ossman
f976b5500e
Hide mouse object from RFB callers
2017-10-27 13:58:12 +02:00
Pierre Ossman
b9854a5ca5
Hide display object from RFB callers
2017-10-27 13:58:11 +02:00
Pierre Ossman
6929a0a183
Split out internal API
...
We only commit to maintaining the API of the RFB object, not the
other modules.
2017-10-27 13:58:11 +02:00
Pierre Ossman
2292cfa6ff
Remove 'focusContainer' attribute from API documentation
...
It was removed from the code in the previous merge.
2017-10-18 15:51:43 +02:00
Pierre Ossman
94bf610cee
Remove 'focused' attributes from API documentation
...
They were removed from the code in the previous merge.
2017-10-18 15:13:19 +02:00
Samuel Mannehed
3c5dd884d2
Update API since sendKey() has a new parameter
...
Commit 94f5cf05f3
added a new parameter to
the public function in the RFB object.
2017-10-12 15:26:21 +02:00
Samuel Mannehed
2f77baabd4
Mouse and Keyboard are seperate files now
2017-10-12 15:17:54 +02:00
Samuel Mannehed
ced77799b2
Update link to Websock API page
2017-10-12 15:04:59 +02:00
Samuel Mannehed
90ab0d38e5
Add note clarifying the disconnected state
...
Makes it clear that the RFB module can not transition away from the
disconnected state.
2017-10-12 15:01:38 +02:00
Samuel Mannehed
f5d40c6a4b
Use markdown-style tables instead of <table>
...
Much easier to read in plaintext
2017-10-12 15:00:55 +02:00
Samuel Mannehed
df4653826d
Remove trailing whitespace
2017-10-12 14:59:49 +02:00
Samuel Mannehed
2b12429e06
Use underscores for bold text intead of asterixes
...
Makes an asterix-list easier to read in plaintext
2017-10-12 14:58:35 +02:00
Samuel Mannehed
f8d08e7b35
Add numbering for each header in the API doc
2017-10-12 14:57:11 +02:00
Samuel Mannehed
5ce9155098
Move API documentation from wiki to the repo
...
Since the API is tied to the source code it makes more sence to have it
in the repository where it can more easily be tied to different versions
of the software.
2017-10-12 14:48:38 +02:00