Installing with Machine License
XSplit's Team License Manager allows system administrators to access a Private Key which can be used to install XSplit application with a fixed license on end-user machines (i.e. machine license). To limit access to the Private Key, this deployment should be done by system administrators as a manual installation, or automated network installation.
XSplit Applications deployed with a machine license deployment do not require end-user login, but limits access to product functions that require user identity. Hence, this type of deployment is only recommended for organizations where deployment with the XSplit account system or SAML SSO is not an option.
Please contact our Sales Team at business@xsplit.com to enable access to this option in your Team License Manager.
If you need to install or remove the license after product installation, please read this article.
Prerequisites
Generating the Private Key
Installation
Verifying the Machine Token
License Redemption
Application Maintenance
A Domain License set up in Team License Manager's domain settings. If you haven't configured it yet, click here.
Administrator copy of the Private Key.
The Team License Domain (for offline machine license installation).
The latest MSI installer here.
Go to the Team Manager's Authentication section in your Dashboard.
Select the domain to use.
Click on the Generate Private key button for your selected domain.
Copy the Private Key. The generated Private Key is linked to your domain and unique for each domain account.
DO NOT share this key with anyone that is not authorized to install the licenses.
Before installing, make sure the machine meets the minimum system requirements for the application. You can check the system requirements from the XSplit Support page.
Note that installing the same version on top of an existing installation in silent mode will automatically proceed to maintenance or "Repair" mode which means custom actions applied will never be executed. In this scenario, it's best to uninstall the existing installation then do a fresh installation of the same version.
There's two ways to install a machine license:
Online Machine License Installation - This generates a machine license during product installation.
Offline Machine License Installation - This prepares the machine license to be applied on first run of application.
The XI_ML (Machine License) command line parameter is required when installing the application with machine license support. The value of this parameter is the team license Private Key which system administrators can retrieve from the Team Manager.
The XI_DN (Domain Name) command line parameter is required for offline machine license installation. The value of this parameter is the Team License Domain in the Team License Manager's domain settings.
The XI_CN (Custom Name) command line parameter is optional which will appear as a prefix on the account name of the redeemed machine license.
The /L*VX “installer.log” (Installer Log File) command line parameter is optional for saving an installer log file to the same location as the installer file.
This method requires the use of XI_ML parameter and internet connectivity.
Run the command line below as administrator.
Format:
Example:
To silent install:
Follow the setup process until installation is complete.
Once installation is complete, the license is automatically redeemed and a Machine Token is created in the Registry.
Internet connectivity is required on initial application run to get resources from the servers.
This method requires the use of XI_ML and XI_DN parameters during the product installation. Then on first run of the XSplit app by the end-user, internet connectivity is required.
Run the command line below as administrator.
Format:
Example:
To silent install:
Follow the setup process until installation is complete.
Run the XSplit app (requires internet connectivity)
Internet connectivity is required on initial application run to get resources from the servers.
Once installation is complete, a temporary machine token information is created in the Registry which will be used to generate the machine license during the first run of application. After running the XSplit application, the license is automatically redeemed and a Machine Token is created in the application's program data folder.
The Machine Token will let the application know that a machine license should be automatically applied and login should be disabled.
To verify machine token from online installation, go to this registry key location Computer\HKEY_LOCAL_MACHINE\SOFTWARE\XSplit\%app name% and you should see a machinetkn entry there.
To verify machine token from offline installation, open this folder location %ProgramData%\XSplit\%app name% and you should see a machine.tkn file there.
Updating the application will not delete the Machine Token.
Uninstalling the application will delete the Machine Token and remove the license in the Team License Manager's account.
Installed application using the Private Key will automatically redeem a slot on the Team Manager's Domain Licenses. Please note that once all slots have been consumed, you will not be able to install the application.
Each machine will have its own license.
Format:
Example:
As long as you have successfully installed and verified the machine license installation, then you can install maintenance or update at any time without having to deploy the XI parameters.
Installed application using the MSI installer by default sets auto-update to disabled. If auto-update is enabled, then whenever the application is online, it can detect if there is a newer version available and allows the end-user to update.
XSplit Applications deployed with a machine license deployment do not require end-user login, but limits access to product functions that require user identity. Hence, this type of deployment is only recommended for organizations where deployment with the XSplit account system or SAML SSO is not an option.
Please contact our Sales Team at business@xsplit.com to enable access to this option in your Team License Manager.
If you need to install or remove the license after product installation, please read this article.
Prerequisites
Generating the Private Key
Installation
Verifying the Machine Token
License Redemption
Application Maintenance
Prerequisites
A Domain License set up in Team License Manager's domain settings. If you haven't configured it yet, click here.
Administrator copy of the Private Key.
The Team License Domain (for offline machine license installation).
The latest MSI installer here.
Generating the Private Key
Go to the Team Manager's Authentication section in your Dashboard.
Select the domain to use.
Click on the Generate Private key button for your selected domain.
Copy the Private Key. The generated Private Key is linked to your domain and unique for each domain account.
DO NOT share this key with anyone that is not authorized to install the licenses.
Installation
Before installing, make sure the machine meets the minimum system requirements for the application. You can check the system requirements from the XSplit Support page.
Note that installing the same version on top of an existing installation in silent mode will automatically proceed to maintenance or "Repair" mode which means custom actions applied will never be executed. In this scenario, it's best to uninstall the existing installation then do a fresh installation of the same version.
There's two ways to install a machine license:
Online Machine License Installation - This generates a machine license during product installation.
Offline Machine License Installation - This prepares the machine license to be applied on first run of application.
Parameters
The XI_ML (Machine License) command line parameter is required when installing the application with machine license support. The value of this parameter is the team license Private Key which system administrators can retrieve from the Team Manager.
The XI_DN (Domain Name) command line parameter is required for offline machine license installation. The value of this parameter is the Team License Domain in the Team License Manager's domain settings.
The XI_CN (Custom Name) command line parameter is optional which will appear as a prefix on the account name of the redeemed machine license.
The /L*VX “installer.log” (Installer Log File) command line parameter is optional for saving an installer log file to the same location as the installer file.
Online Installation
This method requires the use of XI_ML parameter and internet connectivity.
Run the command line below as administrator.
Format:
<XSplit app installer filename> XI_ML=<private key> XI_CN=<custom prefix> /L*VX “<installer log filename>”
Example:
XSplit_VCam_US_2.3.2108.0302.msi XI_ML=7b530740ea4d5d83f9f6b4e31636f0f101a143724ac38ad34fe95b0d84e1 XI_CN=XSplit /L*VX “installer.log”
To silent install:
msiexec /i XSplit_VCam_US_2.3.2108.0302.msi XI_ML=7b530740ea4d5d83f9f6b4e31636f0f101a143724ac38ad34fe95b0d84e1 XI_CN=XSplit /qn /L*VX “installer.log”
Follow the setup process until installation is complete.
Once installation is complete, the license is automatically redeemed and a Machine Token is created in the Registry.
Internet connectivity is required on initial application run to get resources from the servers.
Offline Installation
This method requires the use of XI_ML and XI_DN parameters during the product installation. Then on first run of the XSplit app by the end-user, internet connectivity is required.
Run the command line below as administrator.
Format:
<XSplit app installer filename> XI_ML=<private key> XI_DN=<domain name> XI_CN=<custom prefix> /L*VX “<installer log filename>”
Example:
XSplit_VCam_US_2.3.2108.0302.msi XI_ML=7b530740ea4d5d83f9f6b4e31636f0f101a143724ac38ad34fe95b0d84e1 XI_DN=xsplit.com XI_CN=XSplit /L*VX “installer.log”
To silent install:
msiexec /i XSplit_VCam_US_2.3.2108.0302.msi XI_ML=7b530740ea4d5d83f9f6b4e31636f0f101a143724ac38ad34fe95b0d84e1 XI_DN=xsplit.com XI_CN=XSplit /qn /L*VX “installer.log”
Follow the setup process until installation is complete.
Run the XSplit app (requires internet connectivity)
Internet connectivity is required on initial application run to get resources from the servers.
Once installation is complete, a temporary machine token information is created in the Registry which will be used to generate the machine license during the first run of application. After running the XSplit application, the license is automatically redeemed and a Machine Token is created in the application's program data folder.
Verifying the Machine Token
The Machine Token will let the application know that a machine license should be automatically applied and login should be disabled.
To verify machine token from online installation, go to this registry key location Computer\HKEY_LOCAL_MACHINE\SOFTWARE\XSplit\%app name% and you should see a machinetkn entry there.
To verify machine token from offline installation, open this folder location %ProgramData%\XSplit\%app name% and you should see a machine.tkn file there.
Updating the application will not delete the Machine Token.
Uninstalling the application will delete the Machine Token and remove the license in the Team License Manager's account.
License Redemption
Installed application using the Private Key will automatically redeem a slot on the Team Manager's Domain Licenses. Please note that once all slots have been consumed, you will not be able to install the application.
Each machine will have its own license.
Format:
CUSTOM_NAME+MACHINE_NAME+MACHINE_ID@YOURDOMAIN.COM
Example:
XSPLIT+KARO+cdf9d4224898a9660aaf4f68ac560961d009@xsplit.com
Application Maintenance
As long as you have successfully installed and verified the machine license installation, then you can install maintenance or update at any time without having to deploy the XI parameters.
Installed application using the MSI installer by default sets auto-update to disabled. If auto-update is enabled, then whenever the application is online, it can detect if there is a newer version available and allows the end-user to update.
Updated on: 20/01/2023
Thank you!