TurboPlayer Service
6.9.417.0 6.8.401.0 6.7.367.0
TurboPlayer Service
6.9.417.0 6.8.401.0 6.7.367.0
Breadcrumbs

TurboPlayerService\ConfigurationName\TurboPlayer

There are two ways to provide TurboPlayer configuration data to the TurboPlayer Service:

  1. Reference an existing TurboPlayer configuration by specifying the Configuration and ConfigurationHost parameters. TurboPlayer Service retrieves all required settings from the referenced TurboPlayer configuration.

  2. Define configuration parameters directly in TurboPlayer Service by not defining (or leaving empty) the Configuration parameter and providing all required TurboPlayer settings directly in the service configuration.

1. Reference an existing TurboPlayer Configuration

Parameter name

Description

Configuration

To enable communication with TurboPlayer, the service should use the TurboPlayer configuration settings through TurboPlayer configuration Name (e.g., TurboPlayer, TurboPlayer2, TurboPlayer_News, etc.). This is the recommended method for setting up all necessary parameters.

Key Behavior

  • If the TurboPlayer configuration name is provided and not empty, the service will automatically extract all required communication parameters from it. Service always prefers to use the TurboPlayer configuration from configuration name before manual configuration.

  • In this case, manual configuration parameters such as:

    • CommunicationType

    • EngineAddress

    • TreeManagerPortRange

    • RundownKernelPortRange

    • UseGlobalNamespaceForMMF

    • etc…
      ...will be ignored.

Access Requirements

  • The service must have access to the TurboPlayer configuration.

  • If the configuration is stored in the local registry of another workstation, this workstation must be defined in the parameter ConfigurationHost. Otherwise, the local registry from the workstation, where the service is started, will be used.

  • If TurboPlayer configuration is stored in the user registry, the service must be configured to use the same user account that has access to DPE services. Refer to the appsettings.json for user account setup.

Connection Details

  • If TurboPlayer is set to use IP communication for RundownKernel and TreeManager, the configured IP address will be used.

  • Otherwise, the service will use the local IP address, and TurboPlayer must be installed on the same workstation as the service.

GUI Number Check

  • The service performs an extra check to ensure it does not use the same GUI number as TurboPlayer.

  • If both use the same GUI number, the service will not connect to TurboPlayer to avoid potential issues (e.g., frozen TurboPlayer).

  • In such cases, the service will return an error message for any client request.

ConfigurationHost

Specifies the name of the workstation whose local registry contains the TurboPlayer configuration.

  • If the TurboPlayer configuration is stored in the local registry of a different workstation, you must set this parameter to the name of that remote workstation.

  • If this parameter is not defined, the system will default to using the local registry of the workstation where the service is currently running.

This ensures that the correct configuration is accessed, especially in distributed or networked environments.

Default value:
Empty string (local registry from the workstation, where the service is started, will be used)

GuiNumber

Number of TurboPlayer GUI related to the configuration. GUI number of TurboPlayer (Settings/"the GUI number").

Warning! GUI number used by the service must be never equal to the GUI other numbers used by worked TurboPlayer instance. This cause TurboPlayer to frozen

ReadOnly

  • True – The configuration is in read-only mode. Any requests attempting to modify TurboPlayer’s state will be rejected. This ensures that the system remains stable and protected from unintended or unauthorized changes.

  • False – Clients are allowed to perform changes. However, modification requests may still be rejected depending on the user's permissions and access rights.

Default value:
True

Timeout

TurboPlayer Engine connection & request timeout in milliseconds

Default value:
10000 (10 seconds)

2. Define those configuration parameter directly in TurboPlayer Service

If Configuration from above is not defined, the following TurboPlayer parameters can be directly configured in the TurboPlayer Service.

If a valid TurboPlayer configuration is found (via Configuration), all TurboPlayer-related settings from below are ignored. In this case, the configuration obtained from TurboPlayer takes precedence and will be used by the service.


CommunicationType

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

  • MMF - service establish connection to the TurboPlayer Engine via MMF

  • IP - service establish connection to the TurboPlayer Engine via IP

EngineAddress

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

Used only with communication type "IP"

IP address or resolvable name of the TurboPlayer engine

TreeManagerPortRange

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

Used only with communication type "IP"

Port range for Tree Manager as Low-High

Default value:
9991-9999

RundownKernelPortRange

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

Used only with communication type "IP"

Port range for Rundown Kernel as Low-High

Default value:
9981-9989

UseGlobalNamespaceForMMF

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

Used only with communication type "MMF"

  • True - MMF will be created in the global (kernel) namespace.

  • False - MMF should be created in the local namespace.

Default value:
False

Bcs

Parameter is ignored if Configuration parameter is specified. In this case, the parameter will be derived from the TurboPlayer Configuration.

DigaSystem BCS name (not workstation name!) used by TurboPlayer to connect

Default value:
Empty string