Command line options
You can use command line options to control how the Epiphan Capture Tool starts up. Add as many command line options as needed, in any order. Each command line option starts with two dashes and is separated from other options with a space.
The following command line options are supported:
| Option | Description |
|---|---|
| --borderless | Start the capture application in image only mode. Press the Escape key to exit from image only mode. |
| --sn <serial number> | Specify which video grabber to use (when more than one is connected to the video capture workstation). <serial number> is the serial number of the desired video grabber. |
| --hs <value> | Set the horizontal shift value.* |
| --vs <value> | Set the vertical shift value.* |
| --phase <value> | Set the sampling phase value.* Range is 0 to 31. |
| --pll | Set the PLL adjustment.* |
| --offset <value> | Set the offset (brightness).* Range is 0 to 63. |
| --gain <value> | Set the gain (contrast).* Range is 0 to 63. |
| --topmost | Keep the capture application window as the topmost window on your screen. |
| --fullscreen | Start the Epiphan Capture Tool in full-screen mode. |
| "*" - Refer to the Configure your device section for more details | |
Example
You can create a desktop shortcut that includes one or more command line options. For the purposes of this example, the Epiphan Capture Tool's executible file name is v2ugui2.exe and is installed in C:\Program Files\Epiphan\Frame Grabber Software.
- Open Windows Explorer and navigate the following path: C:\Program Files\Epiphan\Frame Grabber Software
- Right click on the file v2ugui2.exe and select Create Shortcut; Windows creates a shortcut file that, depending on your Windows settings, may be named “Shortcut to v2ugui2.exe.lnk”. The “.lnk” may not appear if Windows does not display file extensions.
- If desired, change the name of this file and copy it to another location if required. Don’t change the file extension.
- Right click the shortcut file and select Properties.
- Edit the Target field and add command line options after the closing quote.
For example, to add the --topmost command line option, change the Target line to:
"C:\Program Files\Epiphan\Frame Grabber Software\v2ugui2.exe" –topmost
Or to add --topmost, --borderless, set the horizontal shift to -67, and the vertical shift to 10:
"C:\Program Files\Epiphan\Frame Grabber Software\v2ugui2.exe" –topmost --borderless --hs -67 --vs 10
- Select OK to save your changes to the shortcut.
- Double-click the shortcut to start the video capture application with your specified command line options.
