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. 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 generate very large log files. 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

Max data lifetime (milliseconds) in the TurboPlayer Engine metadata cache. After this time, the data will be removed

Default value:
300000 (5 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

Default value:
900000 (15 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

MaxGlobalDataModels

Maximum number of global data models can be created dynamically from all clients. Data models from service configuration are not counted to this limit

Default value:
50

MaxLocalDataModelsPerClient

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

Default value:
20

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:
_$_

Parameter name

Description

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 number used by worked TurboPlayer instance. This cause TurboPlayer to frozen

ReadOnly

• True - configured GUI can be used only in read mode. Any requests with changes will be rejected

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

Default value:
True

CommunicationType

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

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

EngineAddress

Used only with communication type "IP"
IP address or resolvable name of the TurboPlayer engine

TreeManagerPortRange

Used only with communication type "IP"
Port range for Tree Manager as Low-High

Default value:
9991-9999

RundownKernelPortRange

Used only with communication type "IP"
Port range for Rundown Kernel as Low-High

Default value:
9981-9989

Timeout

TurboPlayer Engine connection & request timeout (milliseconds)

Default value:
10000 (10 seconds)

UseGlobalNamespaceForMMF

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

Configuration

An alternate way to configure access to the TurboPlayer. Contains name of TurboPlayer main sections with the TurboPlayer configuration (e.g. TurboPlayer, or TurboPlayer2, or TurboPlayer_News, etc). 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 preferred to use the manually defined communication parameters and use this parameter only if the “CommunicationType” and “EngineAddress” parameters aren’t defined or empty

• Service must have access to the TurboPlayer comfiguration. If the TurboPlayer configuration is stored in local registry, service must be started on the same workstation, to have access to the local registry with the TurboPlayer configuration. If the TurboPlayer configuration is stored in the user registry, 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.

Model0

Mdoel1

...

ModelN

Contains one data-model used for subscription to the changes. Data model can be configured as

• Path to the file with the data model. E.g. D:\DataModels\ElementStarted.json

• Data model source code in JSON. E.g. 

  JSON

  {
    "DataModel": "NextPlayItem",
    "Type": "partial/notification",
    "TransactionId": "",
    "Code": 0,
    "Description": "",
    "Data": {
      "NextPlayItem": {
        "_$_Fields_$_": [
          {
            "Source": "Metadata",
            "Name": null,
            "FieldName": "ItemId",
            "Format": "Text",
            "SendAlways": true
          }
        ],
        "_$_Conditions_$_": [
          {
            "Source": "Metadata",
            "FieldName": "NextPlayItem",
            "ValueSource": "Constant",
            "Value": true,
            "Format": "Boolean",
            "Condition": "Equal",
            "CaseSensitive": false
          }
        ]
      }
    }
  }

Section name

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

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

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

TurboPlayerService.CreateGlobalDataModel

Update global data model (see TurboPlayer Service SDK data model for details)

TurboPlayerService.UpdateGlobalDataModel

Delete global data model (see TurboPlayer Service SDK data model for details)

TurboPlayerService.DeleteGlobalDataModel

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 TurboPlayer macros related to GUI number.

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

Hint. In addition access to the certain TurboPlayer macros can be configured via Grant access to individual macros only

TurboPlayerService.ExecuteGuiMacro

Allow executing TurboPlayer macros not related to GUI number.

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 non-GUI-related 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.ExecuteKernelMacro

Activate or deactivate TurboPlayer Kernel mode

TurboPlayerService.SetKernelMode

Change TurboPlayer modes for the specified rundown list type

TurboPlayerService.SetRundownListMode

Select jingle group

TurboPlayerService.SelectJingleGroup

Select show

TurboPlayerService.SelectShow

Select node

TurboPlayerService.SelectNode

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