java/src/com/tightvnc/rfbplayer/README

RFB Session Player 1.0.1
========================

RFB Session Player is a Java application/applet for playing back RFB session
files in FBS format saved by such programs as VNC Reflector or rfbproxy.

Usage:  java RfbPlayer URL file:test.fbs position 5000
        java RfbPlayer URL http://remote.host/sessions/test.fbs


Applet Parameters
=================

--> "URL"

    Value: URL of the session file to play.
    Default: none (required parameter).

    This parameter tells the player which session file to play. The URL can
    be either a complete one (e.g. "file:/your/path/session.fbs") or relative
    (e.g. "session.fbs"). Please note that if the player operates as an
    unsigned applet, it is able to play only files from the host where the
    applet was loaded from. It's a usual JVM security limitation.

--> "Position"

    Value: time in milliseconds.
    Default: 0.

    Set initial time position in the session file, in milliseconds.

--> "Autoplay"

    Values: "Yes", "No".
    Default: "No".

    If set to "Yes", then start in the playback mode. By default, the
    player starts in the paused state.

--> "Open new window" (applicable only in the applet mode)

    Values: "Yes", "No".
    Default: "No".

    Operate in a separate window. This makes possible resizing the desktop,
    and adds scroll bars when necessary. If the server supports variable
    desktop size, the window will resize automatically when remote desktop
    size changes.

--> "Show controls"

    Values: "Yes", "No".
    Default: "Yes".

    Set to "No" if you want to get rid of the control panel at the top. 
    Please note that hiding the panel in current version makes playback
    impossible. :-)

--> "Defer screen updates"

    Value: time in milliseconds.
    Default: "20".

    When updating the desktop contents after reading each update, schedule
    repaint within the specified number of milliseconds. Small delay helps to
    coalesce several small updates into one drawing operation, improving CPU
    usage. Set this parameter to 0 to disable deferred updates.

--> "Speed"

    Value: positive fixed-point or floating-point number.
    Default: "1.0".

    Sets playback speed where 1 is normal speed, 2 is double speed,
    and 0.5 is half speed etc. Both number formats like 0.2 and 2e-1
    are acceptable.


Licensing Terms
===============

RFB Session Player is

  Copyright (C) 2002 HorizonLive.com, Inc.  All Rights Reserved.

This software is based on the TightVNC Java viewer which is

  Copyright (C) 2001,2002 HorizonLive.com, Inc.  All Rights Reserved.
  Copyright (C) 2001 Constantin Kaplinsky.  All Rights Reserved.
  Copyright (C) 1999 AT&T Laboratories Cambridge.  All Rights Reserved.

This software is distributed under the GNU General Public Licence as
published by the Free Software Foundation. See the file LICENCE.TXT
for the conditions under which this software is made available. VNC
also contains code from other sources. See the Acknowledgements
section below, and the individual files for details of the conditions
under which they are made available.