DigaSystem registry subkeys and parameters

Parameter name

Description

LogLevel

Determined how many details will be stored into log for this configuration. Only followed values can be specified, otherwise error occurred

• Critical - only very important messages will be logged. Errors aren't included

• Error - very important messages and all errors are logged

• Warning - very important messages, errors and warnings are logged

• Information - very important messages, errors, warnings and verbose messages (include HTTP & WebSocket API calls) are logged. Warning! This level can generate large log files and dramatically decrease service performance. Enable it only if you want to log all API calls

• Debug - all messages (included HTTP & WebSocket API calls) and special information for support are logged.  Warning! This level can generate large log files and dramatically decrease service performance. Enable it only if it requested from support

Default value:
Error

UseDPELog

Enable using DPE log. If DPE log is disabled, service will use file log only. Can be one of followed

• True

• False

Default value:
True

Parameter name

Description

InactivityMetadata

This parameter defines the maximum data lifetime (in milliseconds) for metadata stored in the TurboPlayer Engine's cache. After the specified duration, the cached data will be automatically removed.

Warnings:

1. Minimum Duration:
   Ensure that the value of this parameter is not shorter than the longest duration of any played element. If it is shorter, the TurboPlayer service will repeatedly send all subscribed notifications about played elements to clients once the parameter’s time limit expires.

2. Avoid Excessive Duration:
   Avoid setting this parameter longer than necessary. A longer duration may cause the service to consume excessive memory due to the increased size of the internally cached metadata.

Default value:
600000 (10 minutes)

InactivityTimeout

Closing WebSocket connection due to inactivity from client after timeout (milliseconds). Disabled if zero. If disabled, connection to the client will be closed only after closing event from WebSocket API

Warning! From the safety reasons, it’s strongly recommended to not disabled closing due to inactivity

Default value:
600000 (10 minutes)

RightsCacheLifeTime

Max data lifetime (milliseconds) in the rights cache. After this time, the data will be required from the Rights Service again

Default value:
120000 (2 minutes)

SendDefaultPrelistenAudio

Indicates, is the service sending default audio file, if the prelisten audio file isn't available

• True - service sending default audio file, if the prelisten audio file isn't available

• False - service return error, if the prelisten audio file isn't available

Default value:
True

MaxLocalDataModelsPerClient

Maximum number of local data models can be created dynamically by every client separately

Default value:
20

MaxLocalDataModelsTotal

Maximum total number of local data models from all connections can be created dynamically & existed in the same time

Default value:
15000

KeywordPrefix

Prefix for keywords used in the data model markup language

Default value:
_$_

KeywordPostfix

Postfix for keywords used in the data model markup language

Default value:
_$_

MaxRtfSize

Maximum allowed RTF file size (in bytes) to transfer it from service to client. If the RTF file os larger than this limit, the default text with the description & recommendation to contact with the system administrator will be transferred instead of real RTF content

Default value:
4096

CheckBcsRights

Enable beta-functionality to support BCS rights matrix (BCS rights objects). See BCSTechManual chapter 1.5 “Right Objects“ for details

Can be one of followed

• True

• False

Default value:
False

GroupClassGrantsAccessRightToAll

If this option is “true”, a user with write rights for class X can manipulate (create, update or delete) elements with arbitrary classes in a group of class X. If set to “false”, such a user can only manipulate elements of those classes for which he has write rights, regardless of the class of the elements' parent group.

Can be one of followed

• True

• False

Default value:
True (same as by BCS)

DpeTokenExpirationTime

This parameter defines the maximum lifetime (in milliseconds) for DPE Authenticaion Token stored in the TurboPlayer Engine's cache. After the specified duration, the cached data will be automatically removed and a new token for that user will be requested from DPE.

Default value:
300000 (5 minutes)

Parameter name

Description

Configuration

Contains name of TurboPlayer main section with the TurboPlayer configuration (e.g. TurboPlayer, or TurboPlayer2, or TurboPlayer_News, etc.). This is the main-recommended way to get the service all required TurboPlayer parameters. The service extract all required communication parameters from the TurboPlayer configuration to communicate with it. Followed parameters are not needed to configure if this parameter is defined

• CommunicationType

• EngineAddress

• TreeManagerPortRange

• RundownKernelPortRange

• UseGlobalNamespaceForMMF

Be aware

• Service is always preferring to use the TurboPlayer configuration from configuration name before manual configuration. If this parameter is configured and not empty, manual configuration parameters will be ignored

• Service must have access to the TurboPlayer comfiguration.

  • If the TurboPlayer configuration is stored in local registry by 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 the TurboPlayer configuration is stored in the user registry, the service must be configured to use the same user account for access to the DPE services (see appsettings.json configuration above)

• If TurboPlayer is configured to use IP communciation type for access to RundownKernel and TreeManager, this IP address will be used for connection to TurboPlayer, otherwise local IP will be used (TurboPlayer must be installed on the same workstation with service). See TurboPlayerTechManual for details.

• Because service have access to the TurboPlayer configuration, an extra check for used GUI number is performed. If the service and the TurboPlayer use the same GUI number, service don’t connect to the TurboPlayer to prevent potential damage (e.g. TurboPlayer can be frozen) and return error message for any request from clients.

ConfigurationHost

The remote workstation name with the local registry contains the TurboPlayer configuration. If the TurboPlayer configuration is stored in local registry by another workstation, this workstation must be defined in this parameter. Otherwise, the local registry from the workstation, where the service is started, will be used.

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

GuiNumber

Number of 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 - configuration can be used in read mode only. Any requests with the changes will be rejected

• False - clients can perform changes , but some requests can be rejected dependent on the user rights

Default value:
True

Timeout

TurboPlayer Engine connection & request timeout in milliseconds

Default value:
10000 (10 seconds)

CommunicationType

Used only if the parameter Configuration isn't specified or empty

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

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

EngineAddress

Used only if the parameter Configuration isn't specified or empty

Used only with communication type "IP"

IP address or resolvable name of the TurboPlayer engine

TreeManagerPortRange

Used only if the parameter Configuration isn't specified or empty

Used only with communication type "IP"

Port range for Tree Manager as Low-High

Default value:
9991-9999

RundownKernelPortRange

Used only if the parameter Configuration isn't specified or empty

Used only with communication type "IP"

Port range for Rundown Kernel as Low-High

Default value:
9981-9989

UseGlobalNamespaceForMMF

Used only if the parameter Configuration isn't specified or empty

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

Used only if the parameter Configuration isn't specified or empty

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

Default value:
Empty string

Section name

Macro name to execute. Can be a standard TurboPlayer (e.g. TP_StartEmbedded) or custom macro name from TurboPlayer\Communication\EventsOut (see TurboPlayerTechManual for details)

Rights

Comma separated right names, required to execute macro. User must have all of these rights. If empty, no rights are required, and any user is allowed to execute the macro without any permissions.

Reload service settings

TurboPlayerService.ReloadSettings

Create local data model (see TurboPlayer Service SDK data model for details)

TurboPlayerService.CreateLocalDataModel

Start an element

TurboPlayerService.ElementStart

Stop an element

TurboPlayerService.ElementStop

Prepares an item, a.k.a. loads an item into a specific channel to be started very fast. The channel will be occupied then, of course.

TurboPlayerService.ElementPrepare

Selects one of the element to be played with the next start command.

TurboPlayerService.ElementSelectNextPlay

Selects one of the elements as the current cursor item

TurboPlayerService.ElementSelectCursor

Selects one of the element for prelistening

TurboPlayerService.ElementSelectPrelisten

Inserts an element (unknown to the engine) into the prelisten list and activates the prelisten state for an engine/MultiPlayer prelisten

TurboPlayerService.ElementAddPrelisten

Inserts an element (unknown to the TurboPlayer) into the prelisten list and activates the prelisten state

TurboPlayerService.ElementChangePrelistenState

Allow executing standard TurboPlayer macros

Warning! This command can be very dangerous, because get a full control to all standard TurboPlayer macro commands. Wrong or intentional wrong use of this command can damage or break the planned workflow. Try to avoid using this right but replace it with the specialized rights with limited functionality.

TurboPlayerService.ExecuteCommand

Allow executing any TurboPlayer macros inclusive user defined

Warning! This right can be very dangerous, because provide a full control to all GUI-related actions. Wrong or intentional wrong use of this command can damage or break the planned workflow. Try to avoid using this right but replace it with the specialized rights with limited functionality.

Hint. This right provides access to execute all (inclusive user defined) macros, and may be too dangerous for clients that only need access to certain macros. To avoid it use Grant access to individual macros only

TurboPlayerService.ExecuteMacro

Activate or deactivate TurboPlayer Kernel mode

TurboPlayerService.SetKernelMode

Change TurboPlayer modes for the specified rundown list type

TurboPlayerService.SetRundownListMode

Load jingle group

TurboPlayerService.LoadJingleGroup

Load start show to play by disabled FreeShowList mode

TurboPlayerService.LoadShow

Load shows to play by enabled FreeShowList mode

TurboPlayerService.LoadFreeShowList

Load node into stack

TurboPlayerService.LoadNodeIntoStack

Perform changes in rundown list (insert, update, delete)

TurboPlayerService.ChangeRundownList

Writes real times for the next element in rundown, though it is not playing

TurboPlayerService.AdjustTimes

Performs a de-link for a remote show or track

TurboPlayerService.Delink