TurboPlayerService\ConfigurationName\Service

Parameter name

Description

InactivityMetadata

This parameter specifies the maximum lifetime (in milliseconds) for metadata stored in the TurboPlayer Service’s cache. Once this duration elapses, the cached metadata is automatically removed.

1. Minimum Duration Requirement

Ensure that the cache duration is not shorter than the longest duration of any played element.

• If the duration is too short, TurboPlayer will repeatedly send notifications for the same element once the cache expires.

• This can lead to redundant client updates, increased network traffic, and potential performance degradation.

2. Avoid Excessive Duration

Do not set the cache duration significantly longer than necessary.

• A longer duration causes TurboPlayer to retain more metadata in memory, which can lead to excessive memory consumption.

• This is especially problematic in environments with high playback volume or long-running sessions.

Default value:
600000 (10 minutes)

InactivityTimeout

The WebSocket connection will be automatically closed if the client remains inactive beyond the specified timeout duration (in milliseconds).
Setting the timeout to 0 disables this feature. In such cases, the connection will only close upon receiving a closing event from the WebSocket API.

Important Safety Warning:
For security and resource management reasons, it is strongly recommended not to disable automatic disconnection due to client inactivity.

Default value:
600000 (10 minutes)

RightsCacheLifeTime

Defines the duration for which rights data retrieved from the DPE is stored in the TurboPlayer Service's internal cache. Caching helps reduce the number of requests sent to the DPE by temporarily storing the rights information. Once this time period elapses, the cached data is considered expired, and TurboPlayer Service will request fresh rights data from the DPE.

Default value:
120000 (2 minutes)

SendDefaultPrelistenAudio

Indicates whether the service sends a default audio file when the prelisten audio file is unavailable:

• True – The service sends a default audio file if the prelisten audio file is not available.

• False – The service returns an error if the prelisten audio file is not available.

Default value:
True

MaxLocalDataModelsPerClient

Specifies the maximum number of data model subscriotions that each client can dynamically create independently.

Default value:
20

MaxLocalDataModelsTotal

Defines the maximum total number of dynamically created data model subscriptions that can exist across all client connections at the same time.

Default value:
15000

KeywordPrefix

Sets the prefix string used to identify keywords in the data model markup language. This helps distinguish special tokens from regular text.

Default value:
_$_

KeywordPostfix

Sets the postfix string used to identify keywords in the data model markup language. Used in combination with the prefix to encapsulate keyword tokens.

Default value:
_$_

MaxRtfSize

Defines the maximum allowed size (in bytes) for RTF (Rich Text Format) files that can be transferred from the service to the client.
If the RTF file exceeds this limit, the system will return a default message instead of the actual file content. This message includes a brief description and a recommendation to contact the system administrator for further assistance.

Default value:
4096

CheckBcsRights

This configuration flag controls whether TurboPlayerService enforces user rights based on the BCS rights management system, which consists of a rights matrix and associated rights objects. For detailed technical specifications, refer to Chapter 1.5 “Right Objects” in the BCSTechManual.

This flag acts as the primary control switch for enabling or disabling user rights enforcement within the TurboPlayerService.

• When CheckBcsRights = false, the service bypasses all permission checks, granting users unrestricted access to all functionalities.

• When CheckBcsRights = true, TurboPlayerService enforces user-specific permissions based on the BCS rights matrix, ensuring that access to features and actions is governed by the defined rights objects.

• True

• False

Default value:
False

GroupClassGrantsAccessRightToAll

Controls whether users with write access to a specific class (Class X) can manipulate elements of other classes within the same group.

Behavior:

• True (Default):
  A user with write access to Class X can create, update, or delete elements of any class within a group that belongs to Class X.

• False:
  The user can only manipulate elements of those classes for which they explicitly have write access, regardless of the class of the parent group.

Default value:
True (same as by BCS)

DpeTokenExpirationTime

This parameter specifies the maximum lifetime (in milliseconds) of the DPE Authentication Token stored in the TurboPlayer Service's cache. Once this duration expires, the cached token is automatically discarded, and a new token is requested from DPE for the respective user.

Default value:
300000 (5 minutes)