Files and folders tags

Files and folders tags

This tutorial will guide you through the use of web browser related tags.

Foreword

To change the behavior of the player, you can add optional tags into the multimedia folders and files names.
Tags are enclosed in square brackets, for instance [ExampleTag].

This tutorial only covers the web browser related tags.
For more information about other tags, please refer to the user manual.

Browsing web pages

The embedded web browser is tightly coupled to the video player engine.
It is possible to display or hide web pages using tags on multimedia folders and files names.

Two tags are available:

  • WEBS executes an action when the playback of a folder or file starts,
  • WEBE executes an action when the playback of a folder or file ends.

These tags need a single parameter:

  • a numeric page identifier to start displaying a web page,
  • the string «OFF» to stop the browser.

When the video player encounters an audio or video file or folder with such a tag, it executes the appropriate action automatically.

Note: the numeric identifier is defined in the web-config.json file whose syntax is described in the Websites configuration tutorial.

Example of usage

Tag Expected action
[WEBS 5] Display the web page number 5 at the beginning of the playback of the folder or file having that tag.
[WEBE 3] Display the web page number 3 at the end of the playback of the folder or file having that tag.
[WEBS OFF] Hide the web browser at the beginning of the playback of the folder or file having that tag.
[WEBE OFF] Hide the web browser at the end of the playback of the folder or file having that tag.

Scenario example

If you create the following folders at the root of your storage media:

  • 000 [WEBS 1][JUMP 1] Start page 1
  • 001 [WEBS 2][JUMP 2] Start page 2
  • 002 [WEBE OFF] Stop browser

Then, when starting to play the folder 000, the video player will execute the following sequence:

  • display page 1 ([WEBS 1]),
  • play the content of folder 000,
  • jump to folder 001 ([JUMP 1]) at end of folder 000,
  • display page 2 ([WEBS 2]),
  • play the content of folder 001,
  • jump to folder 002 ([JUMP 2]) at the end of folder 001,
  • play the content of folder 002,
  • hide the web browser at the end of folder 002 ([WEBE OFF]).

If you don't need to play the video while browsing, you can:

  • use an empty folder with a WEBS or WEBE tag (and no JUMP),
  • use the Player control interface API to stop the playback.