Creating a reading scenario using tags

Thanks to a tag system, you can dynamically modify the player's behavior by adding parameters directly to your folder or file names.

Whether you want to create a playback loop, adjust the volume automatically, synchronize multiple players, or even control external devices (such as video projectors or web pages), tags offer you total flexibility.

TABLE DES MATIÈRES

• Introduction to Tags
• Examples of Using Tags for Folders
  • Jump to a Folder with [Jxxx]
  • Loop Playback with [LOOP]
  • Resume Playback with [RESUME]
  • Return to Previous Folder with [RET]
  • Random or Sequential Playback with [RND] or [SEQ]
  • Absolute Volume Adjustment with [Vx]
  • Relative Volume Adjustment with [V+x] or [V-x]
  • Disable Commands with [NT]
  • Disable Retriggering with [NRST]
  • Conditional Playback with [WHL]
  • Play a Defined Number of Files with [NXTxxx]
  • Subtitle Display with [SUBS x] and [SUBE x]
  • Open Web Pages with [WEBS x] and [WEBE x]
  • Close Web Pages with [WEBS OFF] and [WEBE OFF]
  • Projector Control with [PROJS ON/OFF]
  • Activate Output Contacts with [RESxxxxxxxx] and [REExxxxxxxx]
  • Send RS-232 Frames with [RSSxxx] and [RSExxx]
  • Description of SYSTEM and WWW Folders (Optional)
• File Organization Within Folders
• Adding Tags to Filenames to Build a Playback Scenario
• Examples of Using Tags for Files
  • Jump to Folder xxx at the End of File Playback with [Jxxx]
  • Disable Command Events During File Playback with [NT]
  • Set Image Playback Duration with [DUR x] or [DURATION x]
  • Synchronize Players to Start Playback Simultaneously with [SYNCHRO]
  • Open a Web Page at the Start or End of File Playback with [WEBS x] and [WEBE x]
  • Close a Web Page at the Start or End of File Playback with [WEBS OFF] and [WEBE OFF]
  • Manage Projectors with [PROJS ON], [PROJE ON], [PROJS OFF] and [PROJE OFF]

Introduction to Tags

• Definition: Tags are optional parameters enclosed in square brackets [ ].
• Usage: They allow you to build custom playback scenarios.
• Example: 001[LOOP][V50] MyFolder

Case of a folder without tags:
The player plays the current folder in full and randomly, then stops. The folder can be interrupted.

Case of a missing folder:
If a folder is missing but an action designates it, the action is ignored.

Examples of Using Tags for Folders

Jump to a Folder with [Jxxx]

This tag defines the behavior at the end of folder playback. It indicates the number (0 to 999) of the next folder to play. This number can also be the folder itself to play it in a loop. By default, in the absence of this tag, playback stops at the end of the folder.

Example of loop playback on power-up:
000[J000]: Plays files in a loop on power-up.

Other examples:
001[J002]: Jump to folder 002 at the end of folder 001 playback
003[J003]: Jump to folder 003 at the end of folder 003 playback → Creates a loop of the folder
008[J023]: Jump to folder 023 at the end of folder 008 playback
127[J000]: Jump to folder 000 at the end of folder 127 playback
On each loop, the start and end folder tags are executed.

If the destination folder does not exist, playback is stopped.
An empty destination folder is not a special case. Its playback is simply instantaneous since there are no files to play. This means that any tags of an empty destination folder are applied normally. Playback stops in such a folder, unless it has [Jxxx] or [RET] tags.

Loop Playback with [LOOP]

Unlike jumping to itself (e.g., 001[J001]), this tag allows you to play the folder content in a loop without executing the other tags contained in the folder name on each loop. This function is particularly useful when using output contact management tags to avoid sending unnecessary information on each loop.

Example:
001[LOOP]

Resume Playback with [RESUME]

When a folder is left to play another folder and then this folder is played again, the playback list is by default reset. In some cases, it is useful to resume playback where it stopped.

For example, in a folder containing 10 files, the first 5 have been played, a new folder is called for playback, then playback returns to the previous folder. With the [RESUME] tag, playback will resume at file 6 instead of the beginning of the list.

Example:
001[RESUME]

Return to Previous Folder with [RET]

During the playback of a folder, if an event or tag orders to play another folder with a [RET] tag, the player jumps to this new folder and, at the end of its playback, returns to the initial folder. This function can be used to resume playback of a folder interrupted by the playback of a message triggered by an event.

Example:
001[J100]: Plays folder 001 then jumps to folder 100
002[J100]: Plays folder 002 then jumps to folder 100
100[RET]: Plays folder 100 then returns to the previous folder (001 or 002)
In the example above, at the end of playing folder 001 or 002, folder 100 is played, then playback resumes in the initial folder (001 or 002).

Note: The [RET] tag only includes one level of return, meaning the arrival folder is always the previously played folder, regardless of the number of folders with a [RET] tag played in a row.

Random or Sequential Playback with [RND] or [SEQ]

By default, without this parameter, the directory is played randomly.

[SEQ]: Playback of files in ascending order of the first alphanumeric character of the name (from 1 to infinity, then from A to Z, then from a to z, then special characters, then non-ASCII alphabets). Numbering all files is the best method to adopt.

[RND]: Playback in random order.

Example:
001[SEQ]: Plays folder 001 in sequential mode, then stops
002[RND][J002]: Plays folder 002 in a loop and randomly
003[J001]: Plays folder 003 randomly then jumps to folder 001

Absolute Volume Adjustment with [Vx]

The folder name can affect the output volume. This function is used to change the volume for a particular folder. Once the volume is changed, it is memorized by the player for all remaining files to be played. If the change values exceed the player's maximum or minimum level values, the maximum or minimum values are used.

Example:
001[V5]: Sets the volume value to 5 out of 100 available steps
001[V34]: Sets the volume value to 34 out of 100 available steps
001[V100]: Sets the volume value to its maximum
001[V0]: Sets the volume value to its minimum (Mute)

Relative Volume Adjustment with [V+x] or [V-x]

Unlike the [Vx] tag, using these options allows you to temporarily modify the volume during the playback of the current folder only. When playback jumps to another folder, the previous volume is restored. This function can, for example, increase the volume of an advertisement and then return it to its previous level. The value x is between 0 and 100.

Example:
001[V+5][J002]: Increases the volume by 5 steps during playback of folder 001, then the volume will be restored to its previous value when jumping to folder 002
004[V-24][RET]: Decreases the volume by 24 steps during playback of folder 004, then the volume will be restored to its previous value when returning to the previous folder

Disable Commands with [NT]

If this option is included in the folder name, the files played cannot be interrupted, and the received orders are ignored in the different cases listed in the table below:

Attention, the action is not memorized and the trigger information is lost. However, it is possible to make certain peripherals active despite the NT tag by forcing possible actions in the player's configuration menu.

Without this option, playback of the folder can be interrupted at any time by a command event (input contact, RS-232, Scheduler, etc.).

001[NT]: Commands received are ignored during playback of folder 001. An action on one of the input contacts, via RS-232 or otherwise, is ignored, and playback of the current folder is not stopped.

Disable Retriggering with [NRST]

The folder currently playing cannot be restarted by the order that calls it. Other orders are taken into account.

Conditional Playback with [WHL]

This tag allows you to play the content of a folder as long as the input combination(s) corresponding to this folder is activated. When the input combination(s) associated with the folder is deactivated, the player applies the tags related to exiting the folder. As long as the input combination(s) corresponding to the folder is activated, the folder is played in a loop.

Example:
001[WHL]: Folder 001 is played in a loop as long as input combination 1 is activated. When input combination 1 is deactivated, the player goes to STOP.
002[WHL][J045]: Folder 002 is played in a loop as long as input combination 2 is activated. When input combination 2 is deactivated, the player plays folder 045.
003[WHL][J999]: Folder 003 is played in a loop as long as input combination 3 is activated (inputs 1 and 2 activated). When input combination 3 is deactivated (inputs 1 and 2 deactivated), the player plays folder 999.

The player's dry contact inputs are combinatorial. Therefore, any changes to the combination of activated inputs will be taken into account at any time by the player.

Example:
000[J000]: Folder 000 is played in a loop on power-up
001[WHL][J000]: Folder 001 is played in a loop as long as input combination 1 is activated (input 1 only). If input 2 is activated in addition to input 1, this activates input combination 3, and therefore the player plays folder 003.
002[WHL][J000]: Folder 002 is played in a loop as long as input combination 2 is activated (input 2 only). If input 1 is activated in addition to input 2, this activates input combination 3, and therefore the player plays folder 003.
003[WHL][J000]: Folder 003 is played in a loop as long as input combination 3 is activated (inputs 1 and 2 activated). If input 1 is deactivated, the player plays folder 002, but if input 2 is deactivated, the player plays folder 001.

Play a Defined Number of Files with [NXTxxx]

This parameter allows you to play files from those present in the folder. Once the files have been played, the player applies the tags related to exiting the folder.

If the number of files requested by this tag is greater than the number of files present in the folder, the player loops in the folder as many times as necessary to play the exact number of files requested.

With this tag, the player memorizes the files that are played. This means that files already played during a previous visit to the folder will not be replayed until all files in the folder have been played. The xxx parameter of the [NXTxxx] tag represents the number of files to play in the folder. It is between 1 and 999.

Example:
001[NXT003]: 3 files are played randomly in folder 001, then the player goes to STOP
002[NXT001][J000]: 1 file is played in folder 002, then the player plays folder 000
003[NXT005][RET]: 5 files are played in folder 003, then the player returns to the previously played folder
004[NXT002][SEQ][J000]: The next 2 files in rotation order are played in folder 004, then the player plays folder 000

Subtitle Display with [SUBS x] and [SUBE x]

These tags define the display modes of subtitles at the start or end of playback of a file or folder.

The parameter can be the ISO639-1, ISO639-2, or ISO639-3 code of the subtitle language to display (e.g., [SUBS ENG] selects the English language).

Example:
000[SUBS NONE]: Videos in folder 000 are played on power-up, subtitles are disabled
001[SUBS AUTO]: Videos in folder 001 are played with subtitles defined in system settings

Open Web Pages with [WEBS x] and [WEBE x]

These tags start a web page (visible or not) at the start or end of folder playback. The parameter x is the index of the web page as defined in the web-config.json file.

Close Web Pages with [WEBS OFF] and [WEBE OFF]

These tags close the current web page at the start or end of folder playback.

Projector Control with [PROJS ON/OFF]

These tags start or turn off a projector at the start or end of folder playback.

Refer to the System Settings menu to configure the connection of a projector using the PJLink protocol.

Activate Output Contacts with [RESxxxxxxxx] and [REExxxxxxxx]

The 8 output contacts are switched by the folder name either at the start of folder playback by the RES tag or at the end of the folder by the REE tag.

[RESxxxxxxxx]: xxxxxxxx represents the state of the 8 output contacts that will be activated or deactivated at the start of folder playback.

[REExxxxxxxx]: xxxxxxxx represents the state of the 8 output contacts that will be activated or deactivated at the end of folder playback.

These two tags allow, for example, to turn on lamps when the folder is played and turn them off at the end of folder playback.

xxxxxxxx represents the 8 outputs: 87654321

If x = 0, the output is not activated, the MOSFET transistor is blocked, current does not pass between the output and GND ground,

If x = 1, the output is activated, the MOSFET transistor is conducting and current passes between the output and GND ground,

If x = #, the MOSFET transistor remains in the previously defined state.

Example:
001[RES00000001]: Output 1 is activated at the start of folder 001 playback
002[REE00000000]: All outputs are deactivated at the end of folder 002 playback
003[RES01010101][REE00000000]: Outputs 1, 3, 5, 7 are activated at the start of folder 003 playback, then deactivated at the end of playback

Send RS-232 Frames with [RSSxxx] and [RSExxx]

When the folder is called, a list of bytes is transmitted via the serial link to control other devices (another player, a switching grid, a projector, etc.). The bytes to be sent are contained in a text file created for this purpose.

[RSSxxx]: xxx designates the line number of the serial.txt file that must be sent when the folder is played.

[RSExxx]: xxx designates the line number of the serial.txt file that must be sent at the end of folder playback.

The file defining the bytes to be sent must be named: serial.txt

It will be copied into the SYSTEM folder of the storage medium.

The baud rate is configurable in the player's configuration file config.txt.

The xxx parameter of the tag represents the number of the frame to send (line identifier in the serial.txt file). It is always written on 3 digits (e.g., 001, 045, 999). It is between 001 and 999.

The file defining the bytes to be sent must be named serial.txt. This file must be placed at the root of the storage medium (SD card or USB drive).

This file is a text file (plain text, no formatting) that can be created with any simple text editor such as Windows "Notepad" or similar. This file must be saved with "ANSI" encoding. Do not use special characters.

The serial.txt file of RS-232 codes is a text file containing one or more lines. Each of these lines contains a series of bytes expressed in hexadecimal (from 00h to FFh) and separated by a space. You should only note the two characters of the desired hexadecimal value.

Each start of a line in this file must present the following parameter: #xxx: xxx line identifier containing the bytes to be sent in relation to the xxx of the tag. [RSS002] → line #002 - The tag [RSS002] will send the series of bytes from line #002 of the serial.txt file.

Example of lines contained in the serial.txt file:
#001:45 85 63 21 78 A5 B2
#002:98 75 21 35 45 98
#100:21 35 45 78 A5 B2

It is also possible to add comments at the end of a line in the file using the "//" character (// comment).

// example file
#001:05 A1 FF E4 // comment in the line
#005:45 85 63 21 78 A5 B2
#100:98 75 35 45 98 // my command
// another command
#064: 48 25 Ce 8b
#128:4C 8E D9 5A //
#999:a4 Fc 48 3e 8B
// comments at the end of the file

Example:
001[RSS001]: Sends the bytes from line #001 of the serial.txt file when playing folder 001
002[RSS064]: Sends the bytes from line #064 of the serial.txt file when playing folder 002

If a folder is played in a loop, the message xxx defined by the tag [RSSxxx] will be sent on each loop of the folder.

Example:
001[J001][RSS099]: Plays folder 001 in a loop. On each loop of the folder, the message written on line 099 of the serial.txt file will be sent on the RS-232 output of the player

Description of SYSTEM and WWW Folders (Optional)

This folder is optional. It can contain additional files to customize the player or provide additional functions:

• SYSTEM\scheduler.tm2 → Scheduling programming file
• SYSTEM\scenario-config.json → Web page indexing file

Other files may be present depending on specific extensions/options for the player.

The WWW folder hosts all the web pages that can be displayed autonomously, whether the player is connected to the network via Ethernet or not.

File Organization Within Folders

Like folders, the name of files has a direct influence on the playback of video, image, or audio files.

File naming is free if playback is random (option "[RND]" or no option in the folder name).

In sequential playback, files are played in ascending order, taking case into account. To ensure the playback order, you can, for example, prefix your file names with a 3-digit number. Playback options (tags) can be added as needed, such as command locking or temporary volume modification.

Examples:
001 [J367] my message.mkv
063 [RS020] filename.wav
845 [V+12] my file.mp3 my song [NT].wav

For more information on file types supported by your player, please refer to the chapter Supported Audio File Formats.

Adding Tags to Filenames to Build a Playback Scenario

To modify the player's behavior, you can add optional parameters, called "tags," to the file name. These parameters are enclosed in square brackets "[ ]". You can use multiple parameters in the file name.

Examples of Using Tags for Files

Jump to Folder xxx at the End of File Playback with [Jxxx]

This tag defines the player's behavior at the end of file or folder playback. It indicates the number of the folder to play next after this file.

• If the destination folder does not exist, playback is stopped.
• An empty destination folder is not a special case. Its playback is simply instantaneous since there are no files to play. This means that any tags of an empty destination folder are applied normally. Playback stops in such a folder, unless it has [Jxxx] or [RET] tags.

Example:
my file [J002].mp3: Jump to folder 002 at the end of file playback.
003[J023].mp3: Jump to folder 023 at the end of file 003 playback.
034[J034].wav: Jump to folder 034 at the end of file 034 playback. This is not a loop with file 034, but a jump to folder 034.

Disable Command Events During File Playback with [NT]

This tag works like the [NT] tag for folders, with the only difference that it applies during file playback, not during folder playback.

Set Image Playback Duration with [DUR x] or [DURATION x]

This tag forces the playback duration of an image file independently of the slideshow image duration setting. The value of x is a number of seconds or the infinite playback parameter INF (or INFINITE).

Example:
[DUR 60]: The image is displayed for 60 seconds
[DUR INF]: The image is displayed indefinitely
[Dur INFINITE]: The image is displayed indefinitely
[DURATION 15]: The image is displayed for 15 seconds
[Duration infinite]: The image is displayed indefinitely

Synchronize Players to Start Playback Simultaneously with [SYNCHRO]

Refer to the chapter "Synchronizing Players at the Start of a File"

Open a Web Page at the Start or End of File Playback with [WEBS x] and [WEBE x]

These tags start a web page (visible or not) at the start or end of file playback. The x parameter is the index of the web page as defined in the web-config.json file.

Close a Web Page at the Start or End of File Playback with [WEBS OFF] and [WEBE OFF]

These tags close the current web page at the start or end of file playback.

Manage Projectors with [PROJS ON], [PROJE ON], [PROJS OFF] and [PROJE OFF]

These tags start or turn off a projector at the start or end of file playback.