PlayIt Software Support

Using Scheduled Events, PlayIt Live can run utility commands. Utility commands allow PlayIt Live to perform complex tasks that require multiple parameters. Below you can find the documentation for each of these commands.

Each command has a "verb", for example, "download-ftp-file", and a series of parameters, each prefixed with a --double-dash. Each parameter and value must be separated by a space. Each parameter can be separated with a new line if desired. String parameters should be surrounded by "double quotes".

copy-file

Copies a single file to another location.

  --source         Required. The path of the source file.

  --destination    Required. The path of the destination directory/folder or filename.

copy-newest-file

Copies the newest file in a specific directory/folder to another location.

  --source          Required. The path of the source directory/folder.

  --destination     Required. The path of the destination directory/folder or filename.

  --filter          A wildcard filter to determine which files to consider, for example: *.mp3

                    to consider all .mp3 files.

  --regex-filter    A regular expression filter to determine which files to consider, for

                    example: Part [0-9]+ to download the word Part followed by a number.

  --strategy        (Default: LastModifiedDate) The strategy to use to determine the newest

                    file:

                    LastModifiedDate: Looks at the last modified date of the file. The file

                    with the latest date is used.

                    CreatedDate: Looks at the created date of the file. The file with the

                    latest date is used.

                    FileNameAlpha: Sorts the file in reverse alphabetical order. The first file

                    is used. Useful if the file is named in a sortable format like

                    YYYYMMDDHHMMSS.

download-ftp-directory

Downloads a directory from FTP(S).

  --host                     Required. The host name.

  --port                     (Default: 21) The port number.

  --username                 The username.

  --password                 The password.

  --remote-directory-path    Required. The remote path of directory to download.

  --local-directory-path     Required. The local path to download the files to.

  --filter                   A wildcard filter to determine which files to download, for

                             example: *.mp3 to download all .mp3 files.

  --regex-filter             A regular expression filter to determine which files to download,

                             for example: Part [0-9]+ to download the word Part followed by a

                             number.

  --encryption-mode          (Default: None) The encryption mode for FTPS connections: None |

                             Implicit | Explicit | Auto.

download-ftp-file

Downloads a file from FTP(S).

  --host                Required. The host name.

  --port                (Default: 21) The port number.

  --username            The username.

  --password            The password.

  --remote-file-path    Required. The remote path of file to download.

  --local-file-path     Required. The local path to download the file to.

  --encryption-mode     (Default: None) The encryption mode for FTPS connections: None |

                        Implicit | Explicit | Auto.

For an up-to-date version of the utility commands available with your version of PlayIt Live, you can run the following command from the command line: C:\Program Files (x86)\PlayIt Live\PlayIt.Cli\PlayIt.Cli.exe