Playlog playout script

Used especially for mediametry, the Playlog feature allows to print all day long the playback events information in a playlog.tsv report file stored on the http://<device_IP_addr>/.playlog device WebDAV directory.

The Playlog information is printed every 20 minutes by default. This period if defined by the user preference innes.launcher.playlog.local.write-delay.

The Playlog report file is deleted and a new one is created each time the file size is over a defaut limit of 1024 KB defined by the user preference innes.launcher.playlog.local.max-size. To avoid losing the Playlog report information, it is possible to flush the Playlog information daily on a remote WebDAV server in a file containing the flushing date.

PLAYLOG SCRIPT EXAMPLE

COMPATIBILITY

  • PlugnCast 3.10.50
    • App Playzilla 4.11.11
      • Gekkota DME204 4.11.10 (or above)
      • Gekkota DMB400 4.11.10 (or above)
      • Gekkota SMA300 4.11.10 (or above)
      • Gekkota RT 3.12.59 (or above)
        • For Gekkota 3 devices, the PlugnCast Server user preference innes.plugncast.cms.targets.digitalsignage.playzilla4-on-gekkota3 need to be set to true

INFORMATION


USER PREFERENCES TO ACTIVATE/INACTIVATE THE PLAYLOG FEATURE

  • innes.launcher.playlog.enabled: allow to activate/inactivate the Playlog feature
    • values:
      • true: to activate the Playlog feature
      • false (default value): to inactivate the Playlog feature
    • when the Playlog is activated, the playback event information is stored all day long in the .playout/ directory of the device WebDAV server. It allows also to daily flush the Playlog information when the remote WebDAV server is configured.

USER PREFERENCES TO CONFIGURE THE HOSTING OF THE PLAYLOG REPORT ON A REMOTE WEBDAV SERVER

To store a large amount of Playlog report, it is possible to flush the Playlog report on a WebDAV server every day:

  • innes.launcher.playlog.remote.base-uri: URL of the remote WebDAV server hosting the Playlog report
  • innes.launcher.playlog.remote.username: remote WebDAV server identification username
  • innes.launcher.playlog.remote.password: remote WebDAV server identification password
  • innes.launcher.playlog.remote.time: time of the daily Playlog reporting copy on the WebDAV server

The file name pattern of the Playlog report file stored on the remote WebDAV server is:

  • playlog.<id>.<date-iso-utc>.tsv with:
    • <id>: device identification method value
      • <date-iso-utc>: UTC date of the file sending with the ISO_8601 format
        • For example 20181113T112029Z

JOIN THE PLAYLOG PLAYOUT SCRIPT TO YOUR PLAYOUT

Activate and configure the Playlog feature like explained just before. Download the playout script example playlog-V1.10.10.js. Create a playout with PlugnCast server, and add to it the playout script playlog-V1.10.10.js in the Script to execute screen. For further information read the PlugnCast user manual. Publich the playout. Extract of a Playlog report example:

2019-03-15T14:49:24.825Z App-Begin
2019-03-15T14:49:27.948Z Play-Begin udp://239.1.2.3:1234/
2019-03-15T14:50:08.228Z Play-End udp://239.1.2.3:1234/
2019-03-15T14:50:08.231Z Play-Begin .domain-repository/Books/MS-PowerPoint/demo/demo.pptx
2019-03-15T14:51:13.815Z Play-End .domain-repository/Books/MS-PowerPoint/demo/demo.pptx
2019-03-15T14:51:13.825Z Play-Begin http://www.qeedji.tech/
2019-03-15T14:51:53.697Z Play-End http://www.qeedji.tech/
2019-03-15T14:51:53.699Z Play-Begin udp://239.1.2.3:1234/
2019-03-15T14:52:09.910Z Play-End udp://239.1.2.3:1234/
2019-03-15T14:52:22.066Z Play-Begin .domain-repository/Books/MS-PowerPoint/demo/demo.pptx
2019-03-15T14:53:25.531Z Play-End .domain-repository/Books/MS-PowerPoint/demo/demo.pptx
2019-03-15T14:53:25.532Z Play-Begin http://www.qeedji.tech/
2019-03-15T14:54:04.879Z Play-End http://www.qeedji.tech/
2019-03-15T14:54:04.880Z Play-Begin udp://239.1.2.3:1234/
2019-03-15T14:54:04.883Z Play-Error udp://239.1.2.3:1234/
2019-03-15T14:54:14.927Z Play-End udp://239.1.2.3:1234/
2019-03-15T14:49:16.892Z App-End