blob: 21352e29131c4ccc1ddac41c71a2e2122002a3fd [file] [log] [blame]
Constantin Kaplinsky1215b992008-04-18 09:51:44 +00001
Constantin Kaplinsky5d99c952002-05-25 09:49:23 +00002RFB Session Player 0.7.0
Constantin Kaplinsky903009e2002-05-20 10:55:47 +00003========================
Constantin Kaplinsky1215b992008-04-18 09:51:44 +00004
Constantin Kaplinsky972c2572002-05-30 14:19:02 +00005RFB Session Player is a Java application/applet for playing back RFB session
6files in FBS format saved by such programs as VNC Reflector or rfbproxy.
Constantin Kaplinsky903009e2002-05-20 10:55:47 +00007
Constantin Kaplinsky972c2572002-05-30 14:19:02 +00008Usage: java RfbPlayer URL file:test.fbs position 5000
Constantin Kaplinsky5d99c952002-05-25 09:49:23 +00009 java RfbPlayer URL http://remote.host/sessions/test.fbs
Constantin Kaplinskyeff82662002-05-20 14:09:49 +000010
Constantin Kaplinsky903009e2002-05-20 10:55:47 +000011
Constantin Kaplinsky972c2572002-05-30 14:19:02 +000012Applet Parameters
13=================
14
15--> "URL"
16
17 Value: URL of the session file to play.
18 Default: none (required parameter).
19
20 This parameter tells the player which session file to play. Please note
21 that if the player operates as an unsigned applet, it is able to play
22 only files from the host where the applet was loaded from. It's a usual
23 JVM security limitation.
24
25--> "Position"
26
27 Value: time in milliseconds.
28 Default: 0.
29
30 Set initial time position in the session file, in milliseconds.
31
Constantin Kaplinsky5a7133a2002-07-24 17:02:04 +000032--> "Autoplay"
33
34 Values: "Yes", "No".
35 Default: "No".
36
37 If set to "Yes", then start in the playback mode. By default, the
38 player starts in the paused state.
39
Constantin Kaplinsky972c2572002-05-30 14:19:02 +000040--> "Open new window" (applicable only in the applet mode)
41
42 Values: "Yes", "No".
43 Default: "No".
44
45 Operate in a separate window. This makes possible resizing the desktop,
46 and adds scroll bars when necessary. If the server supports variable
47 desktop size, the window will resize automatically when remote desktop
48 size changes.
49
50--> "Show controls"
51
52 Values: "Yes", "No".
53 Default: "Yes".
54
55 Set to "No" if you want to get rid of the control panel at the top.
56 Please note that hiding the panel in current version makes playback
57 impossible. :-)
58
59--> "Defer screen updates"
60
61 Value: time in milliseconds.
62 Default: "20".
63
64 When updating the desktop contents after reading each update, schedule
65 repaint within the specified number of milliseconds. Small delay helps to
66 coalesce several small updates into one drawing operation, improving CPU
67 usage. Set this parameter to 0 to disable deferred updates.
68
Constantin Kaplinsky7957ca12002-05-30 16:19:11 +000069--> "Speed"
70
71 Value: positive fixed-point or floating-point number.
72 Default: "1.0".
73
74 Sets playback speed where 1 is normal speed, 2 is double speed,
75 and 0.5 is half speed etc. Both number formats like 0.2 and 2e-1
76 are acceptable.
77
Constantin Kaplinsky972c2572002-05-30 14:19:02 +000078
Constantin Kaplinsky903009e2002-05-20 10:55:47 +000079Licensing Terms
80===============
81
82RFB Session Player is
83
84 Copyright (C) 2002 HorizonLive.com, Inc. All Rights Reserved.
85
86This software is based on the TightVNC Java viewer which is
87
88 Copyright (C) 2001,2002 HorizonLive.com, Inc. All Rights Reserved.
89 Copyright (C) 2001 Constantin Kaplinsky. All Rights Reserved.
90 Copyright (C) 1999 AT&T Laboratories Cambridge. All Rights Reserved.
Constantin Kaplinsky1215b992008-04-18 09:51:44 +000091
92This software is distributed under the GNU General Public Licence as
Constantin Kaplinsky903009e2002-05-20 10:55:47 +000093published by the Free Software Foundation. See the file LICENCE.TXT
94for the conditions under which this software is made available. VNC
95also contains code from other sources. See the Acknowledgements
96section below, and the individual files for details of the conditions
97under which they are made available.
Constantin Kaplinsky1215b992008-04-18 09:51:44 +000098