Skip to main content
Skip table of contents

TurboPlayer Service Setup (with UI / Wizard)

Installation Procedure

The TurboPlayer Service setup wizard consists of TurboPlayerServiceSetup.exe, TurboPlayerServiceSetup.msi, the .Net 6.0 Runtimes (x86, x64) and the ASP .NET Core 6.0 Runtimes (x86, x64). We recommend to copy the complete installation folder into a local directory, because access to mounted network drives may conflict with elevated privileges required during the installation process.

  • Double click on TurboPlayerServiceSetup.exe to start the TurboPlayer service setup

image-20240522-134358.png

TPS setup folder

User Account Control

  • (1) Click Yes (or Ok in some versions of Windows) to confirm the User Account Control dialog.

UAC dialog

Main Installation

The setup proceeds with the main installation

  • On the Welcome dialog, click the (2) Next> button

Welcome dialog

Installation Folder

  • On the Select Installation Folder dialog, click the (3) Next> button.

Installation Folder dialog

Service Logon Information

  • On the Logon Information dialog enter the credentials under which the TurboPlayer service will run. If you leave (4) User Name, Domain and Password empty the service will start using the LocalSystem account. Choosing a specific user to run the service is useful if the service needs access to files, directories, network shares, and mounted network drives, which usually depends on user rights.

  • Leave Domain field empty if you want to use a local user account.

image-20240514-200557.png

Service Logon dialog

  • If the installation completes successful and if Start TurboPlayer service after installation checkbox is checked, TurboPlayer service will start at the end of the installation.

  • Click the (5) Next> button to check the credentials. While checking, the text Testing Service Logon credentials… is displayed.

  • If the credentials are not valid, an red error text Password does not match or Invalid User Name is displayed. If the credential check fails, the setup can not be continued.

DPE credentials

DPE service connection is required because TurboPlayer service uses the DPE Parameter service, the DPE Rights service and optionally the DPE Logging service.

  • Enter (6) DPE URL, User Name and Password as DPE credentials

DPE credentials dialog

  • After clicking the (7) Next> button, the connection to the URL and the credentials are checked, indicated by blue text Testing DPE credentials….

  • If the credentials are not valid a message box is shown which displays the error. It also contains the option to skip the validation if you want to install DPE later.

Protocols

To use secure protocols (https and wss) a valid SSL certificate had to be installed prior to run the setup (see Pre-installation requirements)

  • Click on (8) Use secure protocols (https, wss)

  • Click on (9) Select Certificate…

image-20240514-204829.png

Protocols dialog

The Select a certificate window opens

  • (10) Select the appropriate valid SSL certificate. It has to be installed in the LocalMachine/My section of the Windows certificate store

image-20240514-204737.png

Certificate selection window

  • Confirm the selection by clicking (11) OK

  • Click the (12) Next> button to continue.

Connections

The connections dialog should be filled correctly with DNS name matching the selected certificate and the default WebSocket port number 8091.

If you had chosen to use unsecure protocols (http, ws) in the prior dialog, the DNS name is empty.

image-20240514-205505.png

Connections dialog

  • Click the (13) Next> button to continue.

Service Instance Configuration

TurboPlayer Service uses the configuration parameters which are stored in the local DigaSystem Registry under Local Settings/TurboPlayerService/<Configuration>. This configuration will be attached to the specified Windows Service and automatically used at service start.

  • Enter a (14) new Configuration name (new is currently a requirement, will be fixed in a later version, if you enter an existing configuration, parameters are not updated).

image-20240514-210114.png

Service instance dialog

  • Click the (15) Next> button to continue.

TurboPlayer connection

TurboPlayer Service can reuse existing TurboPlayer configurations to avoid specifying each connection parameter individually.

  • Select a (16) Computer Registry from the drop-down list, to specify which computer the TurboPlayer service should connect to. After selecting the Computer registry the list of TurboPlayer Configuration Names are filled with the configurations from that computer.

  • Select a (17) TP Configuration Name from the drop-down list , to specify which TurboPlayer configuration should be used to connect.

  • Change the (18) GUI Number if required.
    (warning) All GUI Numbers of TurboPlayer GUIs and TurboPlayer Services which connect to a specific TurboPlayer Engine must be different. Incorrectly configured GUI Numbers can cause TurboPlayer to freeze, which can lead to a disruption in on-air playout.

  • Click the (19) Next> button on the TurboPlayer connection dialog.

image-20240514-210504.png

TurboPlayer connection dialog

Ready to Install

  • On the Ready to Install dialog (20) click on the Install button

image-20240514-210629.png

Ready to Install dialog

Prerequisites (Optional)

The setup first checks if all prerequisites are met and installs them if not available.

  • In case the Windows version does not have ASP .NET Core 6.0 Runtimes (x86, x64) then installation dialogs of the Runtimes are shown.

  • Check the (21) I agree to the license terms and condition.

  • Click on (22) Install. Follow the instructions on the screen.

image-20240514-211332.png
  • After the installation of the runtimes click on (23) Close.

image-20240514-211435.png
  • In case the Windows version does not have .Net 6.0 Runtimes (x86, x64) installed then installation dialogs of the Runtimes are shown.

  • Click on (24) Install. Follow the instructions on the screen.

image-20240514-211528.png

  • After the installation of the runtimes click on (25) Close.

image-20240514-211606.png

Main dialog

  • After the installation process, (26) click on the Finish button.

image-20240514-211707.png

TurboPlayer Service Connection Check

After the installation the TurboPlayer Service Connection Check page is opened in the default browser

  • Click Open WebSocket Connection button. The Connection Status should change to WebSocket Connection is open.

  • Click GetVersion button. The Result column should display the version number of the installed TurboPlayer service.

  • Enter a valid DigaSystem credentials (Username and Password) which has the required rights to monitor or control TurboPlayer.

  • Click Login. The Result column should display OK.

  • Click Heartbeat. The Result column should display OK.

  • Click GetGlobalStatus. If the Result column displays Service has not license, see License File

image-20240514-212412.png

License file

After a successful installation you need the license file TurboPlayerServiceLicense.dll to get access to the full functionality of TurboPlayer Service.

The license file has to be copied to the installation folder.

You can request the license from support@davidsystems.com (question)

Troubleshooting: Installation Log File

In case the setup fails and there is no obvious reason, a log file can help to diagnose the problem. By default, the setup doesn't write log files. Use the following procedure to create a setup log file:

  • Open a console window with elevated rights: Press Windows+R, type cmd, press Ctrl+Shift+Enter.

  • Change to the directory where the TurboPlayerServiceSetup.exe file is located: Type cd /d "<Full path to the TurboPlayerServiceSetup.exe>" and press Enter.

  • Type the following command into the console window: TurboPlayerServiceSetup.exe /L*V setup.log and press Enter.

This procedure creates the file setup.log in the current directory while the TurboPlayer service setup is running. This log file is a great help when it comes to finding the reason for failure.

Troubleshooting: Service Log File

The setup also could fail in case the TurboPlayer service can not be started.

The reason for not starting TurboPlayer service is written to the most recent service log file located in <TPS Installation folder>\Log\<Configuration Name> directory.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.