NAME

vueannotator — Allows users to create, edit or review audio or textual annotations associated with a UNIX file.

SYNOPSIS

vueannotator [-internal] [-external] [-defaultVolume value]

[-markerWidth value] -files list-of-files

DESCRIPTION

This client provides users with a tool for attaching audio or textual annotations to any standard UNIX file, in a non-intrusive manner.  As the file is moved or copied, using the vuefile File Manager, any associated annotations will remain with the file.  Existing annotations can be reviewed or edited. 

A fully functional audio editing facility is provided for the creation and editing of audio annotations.  This includes a waveform viewer, which support selective playback, along with cut and paste mechanisms. 

If the user does not have access to an audio enabled workstation, then that user will only be able to access any textual annotations attached to the file. 

OPTIONS

−internal
This option will force all audio playback to occur on the internal speaker, built into the user’s workstation.

−external
This option will force all audio playback to be sent to the external jack, located on the back of the user’s workstation.

−defaultVolume value
This option defines the default value for the volume slider in each of the audio dialogs.  The range of values is [0 - 100], inclusive, with 70 being the default value.

−markerWidth value
When the user selects a marker point in the audio waveform window, a vertical marker is drawn at the selected point.  This option controls the width of the marker, in pixels.  The default value is 3.

−files list-of-files
This parameter specifies a list of comma-separated filename.  For each of the specified files, a main annotator view will be displayed.  Relative pathnames are not supported.

RESOURCES

Vueannotator uses the following resources:

Vueannotator*defaultDevice
This resource can be used to contol which device, by default, is selected in each of the audio dialogs.  The choices are the internal speaker, which is built into the workstation (internalSpeaker), or the external jack, which is located on the back of the workstation (externalJack).

Vueannotator*markerWidth
When the user selects a marker point in the audio waveform window, a vertical marker is drawn at the selected point.  This option controls the width of the marker, in pixels.  The default value is 3.

Vueannotator*defaultVolume
This option defines the default value for the volume slider in each of the audio dialogs.  The range of values is [0 - 100], inclusive, with 70 being the default value.

USER INTERFACE

The vueannotator client provides five primary classes of windows, along with a collection of work dialogs used for collecting filenames, or for displaying error and warning messages.  This section will briefly describe each of the five primary classes of windows:

Main Annotator Window
When the user asks to annotate a file, a main annotator window will be displayed.  It displays the name of the file, along with its icon.  In addition, it displays a scrolled list of all of the current annotations attached to the file. Using the menubar and by selecting an item in the scrolled list, the user can edit, view or delete an existing annotation. The menubar also provides the mechanism for creating new annotations. By double-clicking on one of the annotations in the scrolled list, a ‘quick review‘ dialog will be displayed for the selected annotation.

Show/Edit/Create Audio Annotation Dialog
This dialog is used to either create a new annotation, edit an existing annotation, or view an existing annotation; its usage and set of available functionality is dependent upon which menu item the user used to display the dialog.  It includes a collection of standard tape recorder controls (play, pause, record and stop), along with a waveform window.  Using mouse button 1, the user can select a marker point or region, which can then be cut, copied or played.  <Shift> button 1 can be used to extend the marker region.

Show/Edit/Create Textual Annotation Dialog
This dialog is used to either create a new annotation, edit an existing annotation, or view an existing annotation; its usage and set of available functionality is dependent upon which menu item the user used to display the dialog.  It uses a standard Motif multi-lined text widget as the textual annotation region.

Review Audio Annotation Dialog
This dialog allows the user to quickly review an existing annotation.  It does not provide any of the waveform facilities, but instead, simply allows the user to control the volume and the output device.  If the user double-clicked on an audio annotation in one of the Main Annotator Windows, then this dialog will simply review the selected annotation.  If the user has posted this by selecting the ’Review Annotation’ menu item in the vuefile File Manager, then the user can sequence throught each of the audio annotations, one at a time; the ’Next’ button can be used to move to the next annotation, while the ’Stop’ button can be used to terminate the review process at any time.

Review Textual Annotation Dialog
This dialog allows the user to quickly review an existing annotation. If the user double-clicked on a text annotation in one of the Main Annotator Windows, then this dialog will simply review the selected annotation.  If the user has posted this by selecting the ’Review Annotation’ menu item in the vuefile File Manager, then the user can sequence throught each of the text annotations, one at a time; the ’Next’ button can be used to move to the next annotation, while the ’Stop’ button can be used to terminate the review process at any time.

ENVIRONMENT VARIABLES

This client makes no direct use of environment variables.  However, since it uses the audio facilities, it makes an indirect use of the environment variable used by the audio facilities for specifying the host upon which the audio should be played. 

AUDIO
This environment variable allows the user to specify the name of the host on which all audio operations should occur.  If not specified, then it defaults to the host upon which the vueannotator client is running.  If defined, the value associated with this environment variable is simply a host name, such as hpcvxff.

WARNINGS

If you attempt to run the annotator on a workstation which is not audio capable, then only the textual annotation facilities will be made available.  If you are running on an audio capable workstation, then it is required that both the location broker (llbd) and the audio server (Aserver) be running. 

You can annotate any file, as long as you have write permission for the directory in which the file resides. 

COPYRIGHT

Copyright 1992 Hewlett-Packard Company

ORIGIN

Hewlett-Packard Company

  —  February 15, 1994