This article lists and describes the VidyoDesktop installation parameters. It also describes how to configure the parameters on either Windows or Mac.
- VidyoDesktop Installation Parameters
- Configuring VidyoDesktop Installation Parameters for Windows
- Configuring VidyoDesktop Installation Parameters for Mac
VidyoDesktop Installation Parameters
The following table lists and describes the VidyoDesktop installation parameters. If you're using a Mac, the table lists the correct pList file for each of the supported parameters.
| Parameter | Description |
|---|---|
| AUTHMETHOD |
Indicates the authentication method (either VidyoPortal or SAML).
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| CHECKFORUPGRADE |
Controls whether to automatically check for new versions.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| ENABLEAUTOANSWER |
Controls whether incoming calls will be answered automatically.
|
| ENABLEENTRYTONE |
Controls whether an audio indication will be played when other participants join or leave the conference.
|
| ENABLEFEATURES |
Enables or disables chat.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| ENABLEFULLSCREENVIDEO |
Controls whether conferences will start in full screen mode.
|
| ENABLESHOWPARTICIPANT NAME |
Controls whether labels with the participants’ names will be displayed.
|
| ENABLESTARTSHARE |
Controls whether content can be shared during a conference.
|
| ENABLEVIDYOAUTOSTART |
Controls whether to automatically start VidyoDesktop when the machine starts.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| LOCKUSERNAME |
Controls whether the user name can be modified by the user. When this option is enabled, the Mac user name will be used as the default user name.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| MEDIAHIGHPORT |
A numeric value that sets the highest port that can be used for UDP traffic (e.g., "MEDIAHIGHPORT" = "65535”). |
| MEDIALOWPORT | A numeric value that sets the lowest port that can be used for UDP traffic (e.g., "MEDIALOWPORT" = "50000”). |
| PORTALHISTORY |
A multi-string type which contains the default list of VidyoPortal addresses as well as the default user name. Please note that either of these two parameters is optional. The first string determines the VidyoPortal address and user name, which are pre-populated into the respective login screen fields.
|
| PROXYSETTINGS |
The default Web Proxy settings.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
| SAMLAUTHURL |
The SAML authentication URL. This is only used when SAML is the authentication method (e.g., http://saml.vidyo.com). On Macintosh, this parameter is included in com.vidyo.VidyoDesktop3.plist. |
| VIDEOMODE |
The default video preference. VIDEOMODE is the same as the registry: HKEY_CURRENT_USER\Software\Vidyo\Vidyo Desktop\2.0\VideoPreferences. It can be modified by opening the Configuration page on the Video tab and setting the desired preference. Once the Apply button is pressed, the registry is changed.
On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
| WEBPROXYADDRESS |
The default Web Proxy address (e.g., "Web Proxy Address" = "172.3.2.111"). On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
| WEBPROXYPACSCRIPT |
The location of the PAC script (e.g., "Web Proxy PAC script" = "/path/to/script"). On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
| WEBPROXYPASSWORD |
The default Web Proxy user name and password. On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
| WEBPROXYPORT |
The port number used for Web Proxy (e.g., “Web Proxy Port” = “60332”). On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist.
|
| WEBPROXYUSERNAME |
The default Web Proxy user name (e.g., “Web Proxy Username” = “WebProxyUsername”). On Macintosh, this parameter is included in com.vidyo.VidyoDesktop.plist. |
Configuring VidyoDesktop Installation Parameters for Windows
For Windows, you can use the parameters as part of the VidyoDesktop installation in two ways:
- Pass the parameters as command line properties.
- Pass the parameters through an MST file.
Both methods are explained in the following subsections.
Passing VidyoDesktop Installation Parameters via Command Line Properties
You can add command line properties when running the msiexec command. For example:
msiexec /i path_to_the_msi_folder\UnifiedVidyoDesktopMsiInstaller.msi PORTALHISTORY="portal=https://vidyoportal.example.com&un=jsmith" CHECKFORUPGRADE=0t
Separate more than one parameter with a space using the following syntax:
exe /MSI_parameter1 /MSI_parameter2 /MSI_parameter3
Passing VidyoDesktop Installation Parameters through an MST File
When you add the parameters to an MST file, it is read by the Microsoft Windows installer when running the VidyoDesktop installation. The MST file contains software configuration options, allows custom parameters to be used for the installation, and is used to configure test software.
In order to generate a .mst file, you must use a tool called ORCA.
To generate the .mst file:
- Install ORCA.
- Copy the .msi file to a local folder and open it with ORCA.
The .msi is generated as a part of the VidyoDesktop build process and should be available in the release folder. - Create a new transform:
- Click on Properties in the list of tables on the right-hand side.
You will see all the properties that are already programmed as well as the custom secure properties that can be programmed externally. The properties that are in capital letters are public properties and can be modified. - Right-click in the Property/Value section, select Add Row, and insert the property and value.
You can look up the property from the list of custom properties. For more information and examples, see the VidyoDesktop installation parameters article. - Once all the required changes to properties are done, select Transform > Generate Transform.
This creates a .mst file. - Save the .mst file.
- Click on Properties in the list of tables on the right-hand side.
- Execute the MSI with the transforms by running the following through a command line or in a batch script:
msiexec /i path_to_the_msi_folder\UnifiedVidyoDesktopMsiInstaller.msi TRANSFORMS=path_to_the_mst_folder\demomsi.mst - Launch the app either from the Start menu or from the Program Files > VidyoDesktop.
Configuring VidyoDesktop Installation Parameters for Mac
VidyoDesktop uses two pList files called com.vidyo.VidyoDesktop3.plist and com.vidyo.VidyoDesktop.plist. You must modify each of the installer parameters in the appropriate pList file.
See the table at the beginning of this article for a list of the supported VidyoDesktop installation parameters and the correct pList file for each of the parameters.
Comments
0 comments
Please sign in to leave a comment.