vsp.conf.5

Administration Guide : Command-line manual pages

VSP.CONF(4) manual page

Name

vsp.conf - XML global configuration file used by various components of the Xinet Video Module for WebNative Suite.

Synopsis

/usr/etc/venture/var/vsp.conf
C:\Program Files\Xinet\Venture\var\vsp.conf

Description

The vsp.conf file is an XML global settings file used by various components of the Video Module, including movsync (1M) , htmlsync (1M) , browcapt (1M) , cad2jpg (1M) , dgn2jpg (1M) and the Video Reel Generator. You can find the file in /usr/etc/venture/var on Unix systems and C:\Program Files\Xinet\Venture\var on Windows systems. The following subsections provide details about how Video Module components make use of the file and may be useful for fine tune performance or testing systems. Generally speaking, however, administrators should rely on nativeadmin GUI setting and not alter the contents of this file by hand.

Settings for movsync (1)

MovsyncTempFolder: Specifies an alternative temporary folder where extracted JPEG frames will be generated, if you do not want to use the default location, /tmp on Unix systems and %TEMP% on Windows systems. The specified path must be valid and already exist. Wherever you write these files, movsync (1M) will remove them upon exit.
MovsyncDisplayNumber: When processing SWF files on a Unix platform, the browcapt (1M) process called from movsync (1M) uses an X virtual frame buffer (Xvfb ) to facilitate screen captures. In order to avoid conflicts with other virtual frame buffers, vsp.conf allows you to explicitly specify a unique display number. By default, the display number used by movsync (1M) is 742 . This should not conflict with other X servers running on the same machine (i.e., a system with -display :0 or htmlsync (1M) with -display :745 ).
ExcludeExtensions: A comma-delimited list of extensions to be ignored by movsync (1M) .
LowResMovieLimitSecs: Specifies the limit in seconds of the length of all generated, low-resolution movies.
FlashHTMLTemplate: Provides the full path to location of a substitute HTML file that will be used to wrap Adobe Flash SWF files for processing. This file must contain HTML that will display the Flash file in a browser at its original size with an origin of top-left . The following macros will be expanded within the HTML file: %XINETFULLPATHURL% = Full Path to Flash file being processed in URL format (file:///folder/file.swf); %XINETFULLPATH% = Full Path to SWF file being processed (/folder/file.swf); %XINETFULLPATHNOEXT% = Full Path to SWF file being processed, minus the file extension (/folder/file); %XINETBASEPATH% = Path only of the SWF file being processed (/folder); %XINETBASENAME% = File name only, minus extension, of the SWF file being processed (file); %XINETFILENAME% = File name only, including extension, of the SWF file being processed (file.swf); %XINETWIDTH% = Width of SWF file in pixels; %XINETHEIGHT% = Height of SWF file in pixels.
SWFNoPreviewJPEG: When a preview can not be extracted successfully for a SWF file, this paramter specifies an alternative JPEG image that will be inserted into the database in its place. Inserting a static image will disable the "live-preview" functionality for the SWF file; however, it will allow Annotations to be made.
DetectBlankFrames, BlankPixelPercent, BlankRangePercent: These parameters control how blank-frame detection works for SWF-, video- and HTML-captured frames. By default, a frame is considered blank (and rejected) if 90% of the pixel values lie withing a 10% color range. This allows the majority of frames with very little story content (such as credits) to be treated as blank. Typically, you should not change these parameters, as specifying invalid parameters may cause preview generation to stop working. Default values: DetectBlankFrames =true , BlankPixelPercent =90 , BlankRangePercent =10 .

Here is an example of the form these options take in the vsp.conf file:

<VSPGlobal> 
    <MovsyncTempFolder>/tmp/movsync</MovsyncTempFolder> 
    <MovsyncDisplayNumber>742</MovsyncDisplayNumber> 
    <ExcludeExtensions>url,webloc</ExcludeExtensions> 
    <LowResMovieLimitSecs>600</LowResMovieLimitSecs> 
    <FlashHTMLTemplate>/xinet/CustomFlashWrapper.html</FlashHTMLTemplate> 
    <SWFNoPreviewJPEG>/xinet/NoSWFPreview.jpg</SWFNoPreviewJPEG> 
    <LowResVideoThreads>4</LowResVideoThreads> 
</VSPGlobal>  

 Settings for htmlsync (1M) HTMLsyncTempFolder  Allows you to specify 
an alternate temporary folder where htmlsyc (1M) will generate files if 
you do not want to use the default location, /tmp  on Unix systems and 
%TEMP%  on Windows systems. The specified path must be valid and already 
exist. HTMLsyncDisplayNumber  When processing HTML files on a Unix platform, 
the browcapt (1M) process called from htmlsync (1M) uses an X  virtual 
frame buffer (Xvfb ) to facilitate screen captures. In order to avoid conflicts 
with other virtual frame buffers, vsp.conf  allows you to explicitly specify 
a unique display number. By default, the display number used by htmlsync 
(1M) is 745 . This should not conflict with other X  servers running on 
the same machine (i.e., systems with -display :0  or movsync (1M) with -display 
:742 ). HTMLNoPreviewJPEG  When previews can not be extracted successfully 
for an  HTML, URL, MHT, WEBLOC or WEBARCHIVE file, this parameter  specifies 
an alternative JPEG image that will be inserted into the  database in 
place of the preview. Inserting this static image allows  users to add 
Annotations to this file and will also prevent the file  from being submitted 
periodically for reprocessing during volume  synchronisation. Here is an 
example of the form these options take in the vsp.conf  file: 
  
 <VSPGlobal> 
    <HTMLsyncTempFolder>c:temp folder</HTMLsyncTempFolder> 
    <HTMLsyncDisplayNumber>745</HTMLsyncDisplayNumber> 
    <HTMLNoPreviewJPEG>/xinet/NoHTMLPreview.jpg</HTMLNoPreviewJPEG> 
</VSPGlobal>  
  
 
 Video Reel Generator back-end settings  GVPluginTempFolder  Default 
is /tmp  on Unix systems, %Temp%  on Windows systems. If specified, this 
field overrides the default temporary folder the genvideo  executable 
back-end uses. The path specified must also be valid and already exist. GVLogFile 
 Allows you to specify a log file where genvideo  will write messages 
about back-end processing. This file will grow over time,  so should only 
be used during debugging. MaxXVEInstances  Default value 2 . This field 
specifies the maximum number of instances of the Xinet Video Engine allowed 
to run concurrently by users using the Video Reel Generation plug-in. Note: 
This does not include Xinet Video Engine processes spawned via movsync 
(1M). It may be necessary to adjust this value to maximize system performance. 
GVXVECommand  Allows an alternate Xinet Video Engine command to be used 
for the  Video Reel Generator. You must specify the full path to the command. 
Here is an example of the form these options take in the vsp.conf  file: 

  
 <VSPGlobal> 
    <GVPluginTempFolder>/tmp/gvplug-in</GVPluginTempFolder> 
    <GVLogFile>/tmp/gv.txt</GVLogFile> 
    <MaxXVEInstances>2</MaxXVEInstances> 
</VSPGlobal>

Video Reel Generator front-end settings

VRGPluginLogFile: Allows you to specify a log file where messages from the Video Reel Generator plug-in front end will be written. This file will grow over time.

Here is an example of the form this option takes in the vsp.conf file:

<VSPGlobal> 
    <VGPPluginLogFile>/tmp/VGPLog.txt</ VGPPluginLogFile>. 
</VSPGlobal> 
  
 
 Settings for browcapt (1M) [Solaris, Linux, Altix ] XvfbCommand  Allows 
you to specify the location of the Xvfb (1) command or customize script 
to launch Xvfb (1). XvfbCustomOptions  Allows you to specify additional 
parameters for Xvfb (1). For example, when launching Xvfb (1) you may want 
to set the background to black or white, thus allowing the motion detection 
engine to reject frames that may be snapped before Firefox starts or after 
Firefox exits. Note: parameters may be different on different platforms 
and OS versions. Please check the Xvfb (1) manual page for appropriate 
options. BrowserWaitSecs  On Unix versions of the Xinet Video Module 4.1 
or later, the number of seconds to wait after launching Firefox before 
commencing capture. This allows embedded content to load. firefoxCommand 
 Allows you to specify the location of the Firefox command or customized 
script to launch Firefox. xwdCommand  Allows you to specify the location 
of the xwd (1) command or customized script to launch xwd (1). XvfbWaitSecs 
 Default 10 . Number of seconds to wait after launching Xvfb (1) before 
starting Firefox. Since Xvfb (1) launches asynchronously, on slower systems, 
you may need to delay Firefox's launching. Here's an example of these options 
in a vsp.conf  file: 
  
 <VSPGlobal> 
    <xvfbCommand>/usr/bin/X11/Xvfb</xvfbCommand> 
    <XvfbCustomOptions>-br</XvfbCustomOptions> 
    <firefoxCommand>/usr/bin/firefox</firefoxCommand> 
    <xwdCommand>/usr/openwin/bin/xwd</xwdCommand> 
    <xvfbWaitSecs>10</xvfbWaitSecs> 
    <BrowserWaitSecs>10</BrowserWaitSecs> 
</VSPGlobal>  
  
 
 Settings for cad2jpg (1M) CADBGColor  Allows you to specify the background 
color for AutoCAD and Bentley rendered files. Value should represent 8 
bit BGR (Blue, Green, Red)  integer values specified in hexadecimal, e.g., 
00FF00 represents 100% green background. Note, the hex prefix of 0x is 
not required. CADSearchPaths  A ;-delimited list of search paths that cad2jpg 
(1M) and dgn2jpg (1M)  can use to locate additional resources such as 
fonts. Limited to 4096 characters. Note: when entering paths, the &  character 
must be entered as &amp; . For example, /space/Video & Interactive  should 
be entered as /space/Video &amp; Interactive . Failure to do so will prevent 
the vsp.conf  file from being loaded by all Video Module applications. CADSystemCodePage 
 For use with cad2jpg (1M) only. Specifies the  default system Code Page 
  (character encoding) to be used when loading an AutoCAD file. It is important 
 that the Code page  is set correctly; otherwise, text may not be imported, 
 rendered or extracted correctly. The software will try to automatically 
 detect the correct system character encoding, but when it is not successful, 
 it will use the default value of 30  (ansi1252 ). To  specify a different 
value,  use values from the following table,  e.g., if you operating system 
were Japanese, you  would use the Code Page ID    value of 38 :  
  Code Page IDCode PageDescription1ascii US-ASCII (7-bit)2iso8859-1 Latin 
1; Western European (ISO)3iso8859-2 Central European; Central European 
(ISO)4iso8859-3 Latin 35iso8859-4 Baltic6iso8859-5 Cyrillic7iso8859-6 Arabic8iso8859-7 
Greek9iso8859-8 Hebrew; Hebrew (ISO-Visual)10iso8859-9 Turkish11dos437 OEM 
United States12dos850 OEM Multilinqual Latin 1; Western European (DOS)13dos852 
OEM Latin 2; Central European (DOS)14dos855 OEM Cyrillic (primarily Russian)15dos857 
OEM Turkish; Turkish (DOS)16dos860 OEM Portuguese; Portuguese (DOS)17dos861 
OEM Icelandic; Icelandic (DOS)18dos863 OEM French Canadian; French Canadian 
(DOS)19dos864 OEM Arabic; Arabic (864)20dos865 OEM Nordic; Nordic (DOS)21dos869 
OEM Modern Greek; Greek, Modern (DOS)22dos932 ANSI/OEM Japanese; Japanese 
(Shift-JIS)23mac-roman MAC Roman; Western European (Mac)24big5 ANSI/OEM 
Traditional Chinese (Taiwan;    Hong Kong SAR, PRC); Chinese Traditional 
(Big 5)25ksc5601 ANSI/OEM Korean (Unified Hangul Code)26johab Korean (Johab)27dos866 
OEM Russian; Cyrillic (DOS)28ansi 1250 ANSI Central European; Central 
European (Windows)29ansi 1251 ANSI Cyrillic; Cyrillic (Windows)30ansi 
1252 ANSI Latin 1; Western European (Windows)31gb2312 ANSI/OEM Simplified 
Chinese (PRC, Singapore);    Chinese Simplified (GB2312)32ansi 1253 ANSI 
Greek; Greek (Windows)33ansi 1254 ANSI Turkish; Turkish (Windows)34ansi 
1255 ANSI Hebrew; Hebrew (Windows)35ansi 1256 Arabic; Arabic (Windows)36ansi 
1257 ANSI Baltic; Baltic (Windows)37ansi 847 ANSI/OEM Thai (same as 28605, 
ISO 8859-15); Thai (Windows)38ansi 932 ANSI/OEM Japanese; Japanese (Shift-JIS)39ansi 
936 ANSI/OEM Simplified Chinese (PRC, Singapore);       Chinse Simplified 
(GB2312)40ansi 949 ANSI/OEM Korean (Unified Hangul Code)41ansi 950 ANSI/OEM 
Traditional Chinese (Taiwan; Hong Kong       SAR, PRC); Chinese Traditional 
(Big 5)42ansi 1361 Korean (Johab)43ansi 1200 Unicode UTF-16, little endian 
byte order (BMP        of ISO 10646); available only to managed44ansi 1258 
ANSI/OEM Vietnamese; Vietnamese (Windows)
 
CADMaxTextEntries  Limits the 
number of text entries that will be extracted by cad2jpg (1M)  and dgn2jpg 
(1M) from any one file. Here is an example: 
  
 <VSPGlobal> 
    <CADBGColor>00FF00</CADBGColor> 
    <CADSearchPaths>/mypath1;/mypath2;/my/path/3</CADSearchPaths> 
    <CADMaxTextEntries>500</CADMaxTextEntries> 
    <CADSystemCodePage>30</CADSystemCodePage> 
</VSPGlobal> 
  

 Files /usr/etc/venture/var/vsp.conf  /usr/etc/venture/bin/movsync  /usr/etc/venture/bin/browcapt 

/usr/etc/venture/bin/htmsync 
/usr/etc/venture/bin/cad2jpg