Documentation

Getting Started

These requirements are necessary for the smooth running of the software:

1. System requirements
• Windows 10/11 64bit
• Intel Processor (recommended)
• 8GB RAM
• OpenGL 4.5 is required
• Disable User Account Control (UAC)
2. Required Third-Party Software
• Microsoft Visual C++ 2010 Redistributable Package
• .Net 4.8
3. To avoid problems, PlyCast should be started in the logged-in user's home folder.
   Not in the Programs folder!

Informal

• The PlyCast Package includes the following third-party software (All third-party providers use their own license terms):
  • CasparCG Server
  • FFMpeg
  • Notepad++ Portable
  • Python Portable
• PlyCast is visualized by the Icons8 icons.
• Please do not delete any files in the root folder.
• PlyCast automatically registers a new file extension ".plyt"

THE SOFTWARE (PLYCAST) IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Setup CasparCG

The basic prerequisite for the smooth operation of PlyCast is the correct configuration of CasparCG - The Heart of PlyCast. These configurations must be configured correctly before the first start.

The CasparCG configuration file is called casparcg.config and is located in the PlyCast folder videoserver (~\videoserver\casparcg.config)

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <paths>
    <media-path>media/</media-path>
    <log-path>log/</log-path>
    <data-path>data/</data-path>
    <template-path>template/</template-path>
  </paths>
  <lock-clear-phrase>secret</lock-clear-phrase>
  <channels>
    <channel>
      <video-mode>1080i5000</video-mode>
      <consumers>
        <screen/>
        <system-audio/>
      </consumers>
    </channel>
  </channels>
  <controllers>
    <tcp>
      <port>5250</port>
      <protocol>AMCP</protocol>
    </tcp>
  </controllers>
  <amcp>
    <media-server>
      <host>localhost</host>
      <port>8000</port>
    </media-server>
  </amcp>
</configuration>

The video-mode Node, will set also PlyCast Source Frame.

<video-mode>1080i5000</video-mode>

Setup PlyCast

Before PlyCast can be started for the first time, PlyCast must be configured.

The configuration file is called plycast.config and is located in the Root-PlyCast directory. PlyCast sends emails in case of master errors and supports MySQL/MariaDB for external log storage.

<?xml version="1.0" encoding="utf-8"?>
<PlyCastInstance MailAlert="0" UseMySql="0" PlayChannel="1" AutoSave="5" ListMode="1" DisableLogo="0" DisableCG="0" ShowControl="1" ChapterSupport="1">

  <InstanceName>Primary BroadCast</InstanceName>

  <EmergencyPlaylist></EmergencyPlaylist>

  <mailto></mailto>
  <frommail></frommail>
  <smtp_server></smtp_server>
  <smtp_username></smtp_username>
  <smtp_password></smtp_password>
  <smtp_port></smtp_port>
  <smtp_ssl></smtp_ssl>

  <msg_videoerver>
    <![CDATA[<h4>Video Server is not connected!</h4>]]>
  </msg_videoerver>
  <msg_stop>
    <![CDATA[<h4>PlyCast Server was stopped!</h4>]]>
  </msg_stop>
  <msg_shutdown>
    <![CDATA[<h4>PlyCast Server was Shutdown!</h4>]]>
  </msg_shutdown>
  <msg_emergencyloaded>
    <![CDATA[<h4>Emergency Playlist was loaded!</h4>]]>
  </msg_emergencyloaded>

  <mysql_server></mysql_server>
  <mysql_database></mysql_database>
  <mysql_tablename></mysql_tablename>
  <mysql_port></mysql_port>
  <mysql_username></mysql_username>
  <mysql_password></mysql_password>
  <mysql_sslmode></mysql_sslmode>

</PlyCastInstance>

Attribute Setup

<PlyCastInstance MailAlert="0" UseMySql="0" PlayChannel="1" AutoSave="5" ListMode="1" DisableLogo="0" DisableCG="0" ShowControl="1" ChapterSupport="1"> ...

Node Setup

<InstanceName>Name</InstanceName> ...

HTML based e-mail messages. Use CDATA! <![CDATA[...]]>

Logs

PlyCast creates log files and saves them in order on a daily basis. The log files are located in the logs folder (~\logs). The log files are saved as comma-separated txt files (UTF-8).

Log-Folder Short Acces from Menu:

• Tools
• Folders
• Logs

Logo

Images, movies-files with an alpha channel or HTML5 links with transparency can be used as a logo. Several logos can be used at the same time. Layers 5 to 10 are available for this purpose.

• The Logo layer can be added or removed manually or automatically via FileMatch.

Logo Configuration

<?xml version="1.0" encoding="utf-8"?>
<Logos>
  <Logo>
    <LogoName>Logo 1</LogoName>
    <LogoUri>C:\Users\PlyCast\Logo1.mov</LogoUri>
    <LogoDelay>0</LogoDelay>
    <LogoMix>16</LogoMix>
    <AutoOn>*</AutoOn>
    <AutoOff>W_</AutoOff>
    <PlayLayer>5</PlayLayer>
  </Logo>
  <Logo>
    <LogoName>Logo 2</LogoName>
    <LogoUri>https://plycast.com/downloads/testhtml/</LogoUri>
    <LogoDelay>0</LogoDelay>
    <LogoMix>16</LogoMix>
    <AutoOn>*</AutoOn>
    <AutoOff>W_</AutoOff>
    <PlayLayer>6</PlayLayer>
  </Logo>
</Logos>

Test Files/URL

• Video MOV with Alpha 1080i50
• Image Image (Targa with Alpha 1080)
• URL HTML5 (TestURL 1080)
• ZIP HTML5 (PHP Script 1080)

TGA information: In order to be able to use TGAs, an alpha channel is required and the image must be saved as 32bit.

• How to Photoshop
• How to GIMP

CG

Images, movies-files with an alpha channel, HTML5 links with transparency or a Python Script can be used as a CG. Several CGs are possible and can also be changed in the playlist. The CG layers are emptied again at each OnAir event.

• The CG layer can be added or removed manually or automatically via FileMatch.

CG Configuration

<?xml version="1.0" encoding="utf-8"?>
<CGs>
  <CG>
    <CGName>CG 1</CGName>
    <CGUri>https://plycast.com/downloads/testhtml/</CGUri>
    <CGUpTime>00:00:00.000</CGUpTime>
    <CGDowntime>00:03:20.000</CGDowntime>
    <CGDuration>00:00:30.000</CGDuration>
    <CGMix>16</CGMix>
    <PostURL>True</PostURL>
    <CGLayer>20</CGLayer>
    <AutoOn>*</AutoOn>
    <AutoOff>W_</AutoOff>
  </CG>
</CGs>

Test Files/URL

• Video MOV with Alpha 1080i50
• Image Image (Targa with Alpha 1080)
• URL HTML5 (TestURL 1080)
• ZIP HTML5 (PHP Script 1080)

TGA information: In order to be able to use TGAs, an alpha channel is required and the image must be saved as 32bit.

• How to Photoshop
• How to GIMP

Playlist Management

The playlist can be operated as usual with the mouse.

• Simply add files to the list by dragging and dropping them from Explorer.
• Copy, cut, delete and paste are performed with the usual combinations.
• PlyCast can be closed. The last File in CasparCG will play until the End.

Shortcuts

Expired Files

PlyCast can display a message when a file has expired. This feature is perfect for ads that should only run within a certain time.

• FileName_EX2022-06-01.mp4
• Use _EX followed by Date YYYY-MM-DD

Events

Events are permanently implemented playlist functions. They are the basic functionality of PlyCast and cannot be modified or enhanced. In order to be able to edit a function, the function must first be selected in the playlist. Then you can modify them with a double click. Just right click in the Playlist and load the Function from the menu.

Chapters

PlyCast supports chapters that are integrated within a file. When importing (drag & drop), the file is automatically segmented. The addition of a corner bracket simplifies that the segmentation was successful.

• Import > TestFile.mp4
• Segmentation > TestFile.mp4 [Name Od Chapter], TestFile.mp4 [Name Od Chapter], TestFile.mp4 [Name Od Chapter] ...
• Remove > TestFile.mp4 (in Playlist Only)

The main file will be removed from the playlist after import.

Test Files

• ZIP Test Package

Create Chapters

With FFMPEG, for example, chapters can be created. It is important that the TIMEBASE is 1/1000. This means: The start and end points must be specified in milliseconds.

FFMpeg Command

Example Chapters.txt

;FFMETADATA1

[CHAPTER]
TIMEBASE=1/1000
START=0
END=5000
title=Chapter 1

[CHAPTER]
TIMEBASE=1/1000
START=5000
END=10000
title=Chapter 2

Categories

Plycast has the possibility to set categories (name and color). The Category configuration file is called cats.xml and is located in the PlyCast Root folder. PlyCast must apply the changes. Automatic confirmation occurs after saving the file.

<?xml version="1.0" encoding="utf-8" ?>
<Categories>
	<item name="Live" color="#ffc75f" automatch="show"></item>
	<item name="Ads" color="#ff6f91" automatch="wj,w"></item>
</Categories>

A category can be reselected with right-click or the complete playlist can be recategorized in the "Tools" menu.

Plug-Ins

With plug-ins you can expand PlyCast according to your needs. Plug-ins can deliver files or perform other miscellaneous tasks. Plug-ins are saved as Python scripts in the plugins folder where is located in the PlyCast Root-folder (~\plugins)

Install PlugIns: File > Import Plugins

This is a simple Plug-In example.

import sys, glob, random, os, socket

def InitGui():
    GuiLoader = "SingleFile"
    print(GuiLoader, end = '')

def InitLoad():
    print("LOAD: "+sys.argv[2])
    f = open("cue.txt", "a")
    f.write("Now the file has more content!")
    f.close()
    print("", end = '')

def Cue():
    print("CUE")
    f = open("cue.txt", "a")
    f.write("Now the file has more content!")
    f.close()

def OnAir():
    print("PLAY")
    f = open("play.txt", "a")
    f.write("Now the file has more content!")
    f.close()

if sys.argv[1] == "cue":
    Cue()

if sys.argv[1] == "onair":
    OnAir()

if sys.argv[1] == "load":
    InitLoad()

if sys.argv[1] == "gui":
    InitGui()

PlyCast sends 4 commands to the plugin.

Files

• Plugin Randomizer
• Plugin VideoHub
• Plugin Atem Macro Switch
• Plugin Live Insert
• Plugin Send Command to CasparCG

Templates

Templates make working with PlyCast easier. You can prepare individual programs or entire days in them. The plug-ins and functions are only executed when they are imported into the main playlist.

How to create a template:

• File
• Create Template...

Templates are independent files that can also be opened directly from Explorer. In order to use a template, it simply has to be dragged and dropped into the playlist.

Support

Changelog

Version 1.0.4.2-rc (20 Nov, 2022)

• Featrue Category support has been enabled and integrated.
• Info The second menu "Tools" has been deleted.
• Bug-Fix The right-click error has been fixed.

Version 1.0.4.1-rc (18 Nov, 2022)

• Bug-Fix Jumping Functions

Version 1.0.4.0-rc (15 Nov, 2022)

• Updated New Core