VRS Software Development Kit

Software Development API

VRS can be controlled by other programs. For example other software can start or stop recording or specified channels or name the recorded wav files. This is useful for creating automation systems.
VRS Software Development Kit Topics

  Back to top


Using the VRS API

VRSAPI Application Programming Interface

This is a DDE like process to control VRS by finding the window and sending command messages. The file vrsapi.zip includes "readme.html" which explains more. C++ header, source files and examples are included but with a bit of knowledge the code can be used in any other language (eg. VB). To download click here...

VRSAPI is fairly simple to use. For C++ programmers just include the header and source file and call the functions. For other programmers you need to understand some basic Win32 commands like "FindWindow" and "SendMessage". VRSAPI is more suitable for applications where efficiency is more important.

  Back to top


VRS Command Line Options
Command line options can be used to control the running of VRS from a batch file or another application. The following options are supported:

-show
reveals VRS once hidden.

-hide
hides VRS.

-start
starts recording the default line 0 (first listed line)

-start line
starts recording the line. Lines are a zero based index starting from the first line in the main view.
example: -start 1

-start line filename
starts record the line as above and saves the recording into the specified wav file. You should specify a full path for the filename and the file must end in .wav. Generally you should enclose the filename in double quotes.
example: -start 0 “c:\My Recordings\recording.wav “

-stop
stops the recording for the default line 0 (first listed line)

-stop line
stops recording for the specified line. Lines are a zero based index starting from the first line in the main view.

-data line datavalue
sets the recording text data for the specified channel. The datavalue is only valid for the current recording and reset once the recording ends. Note datavalue should be enclosed in double quotes.
example: -data 0 “recording of conference”

-datapersist line datavalue
sets the recording text data for the specified channel. The datavalue will apply for all recording via this line. Note datavalue should be enclosed in double quotes.
example: -datapersist 0 “recording on machine 1”

Examples:

VRS.exe -data 1 “record1” -start 1 -hide
will start VRS and set the recording data to “record1” and then start the recording. VRS will be hidden while recording.

VRS.exe -stop 1
will stop the recording previously started for line 1.

  Back to top


Other Information
If you have problems writing your application, please go to www.nch.com.au/vrs/support.html and use the form to contact us.

If you wish to distribute the VRS packaged with your software you should consider the very easy and affordable OEM license terms for distributing VRS. See https://www.nch.com.au/reseller for more information.

We also offer corporate software development services if you want us to do the development for you or if you need more substancial changes to the VRS. Costs start from around $US100 for a simple function but can increase to $10,000+ for development of a complete new release application. Please see www.nch.com.au/development for contact details to request a quote.

We can also rebrand VRS with your logo and details for a small fee (see https://www.nch.com.au/reseller for more information).

You can distribute the VRS install file with your software (but you may not under any circumstances distribute registration keys or seek to undermine the registration system). See the VRS license terms (on the Help file). Normally your customers would purchase the VRS directly from us. We also provide easy license terms if you do need to distribute registered versions of the VRS. Please see https://www.nch.com.au/reseller under the Software Blanket license heading.

  Back to top


More Information...
For more information see: