reference:text_playlist_import_format_specification
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| reference:text_playlist_import_format_specification [2015/08/29 19:49] – Page moved from misc:text_playlist_import_format_specification to reference:text_playlist_import_format_specification tw | reference:text_playlist_import_format_specification [2020/02/05 11:34] (current) – [Text Playlist Import Format Specification] tw | ||
|---|---|---|---|
| Line 5: | Line 5: | ||
| The purpose of this format is to import playlists from 3rd party music scheduling systems. | The purpose of this format is to import playlists from 3rd party music scheduling systems. | ||
| + | TPI is a text/CSV based format that contains the IDs or filenames of the items to import, plus optional control information. | ||
| ===== General ===== | ===== General ===== | ||
| Line 19: | Line 20: | ||
| * For hourly playlists, the file name must be one of the following: | * For hourly playlists, the file name must be one of the following: | ||
| * '' | * '' | ||
| - | * '' | + | * '' |
| * '' | * '' | ||
| * '' | * '' | ||
| Line 37: | Line 38: | ||
| | 3 | Line Type | | | 3 | Line Type | | ||
| | 4 | Line Data | | | 4 | Line Data | | ||
| - | | 5..x | Reserved for future use, leave empty | | + | | 5..x | Optional columns, depending on line type | |
| ==== Start Time ==== | ==== Start Time ==== | ||
| Line 71: | Line 72: | ||
| | F | File | An audio file, identified by its filename | | | F | File | An audio file, identified by its filename | | ||
| | I | ID | An item from the database library, identified by its ID | | | I | ID | An item from the database library, identified by its ID | | ||
| + | | O | Options | Options for file import | | ||
| | R | Remark | Silently ignored during import | | | R | Remark | Silently ignored during import | | ||
| Line 79: | Line 81: | ||
| ==== B: Block ==== | ==== B: Block ==== | ||
| - | Used to indicate the boundary of a music block. In column 4, the number of the block starting here is given. Column 4 can be left empty, in which case the number of the previous block + 1 is assumed. Timing is ignored and can be left empty. If the file contains no B lines at all, block 1 is assumed for all content. | + | Used to indicate the boundary of a (music or advertising) |
| Example: | Example: | ||
| Line 85: | Line 87: | ||
| 12: | 12: | ||
| | | ||
| - | Indicates the start of music block #2. | + | Indicates the start of music/ |
| Line 116: | Line 118: | ||
| | | ||
| Adds the file '' | Adds the file '' | ||
| - | | + | |
| + | Additional columns can be used to set fields on the imported file: | ||
| + | |||
| + | ^ Column ^ Field ^ | ||
| + | | 5 | Title | | ||
| + | | 6 | Artist | | ||
| + | | 7 | Item Type | | ||
| ==== I: ID ==== | ==== I: ID ==== | ||
| Line 127: | Line 135: | ||
| Adds the item with the ID 120577, with Normal timing. | Adds the item with the ID 120577, with Normal timing. | ||
| | | ||
| + | | ||
| + | ==== O: Options ==== | ||
| + | |||
| + | Specifies the options for the processing of all subsequent F lines. Start time and timing is ignored. Column 4 and 5 contain the name and value of the option. Currently the following options are available: | ||
| + | |||
| + | ^ Name ^ Description ^ | ||
| + | | ItemType | Override playlist item type, e.g. '' | ||
| + | | ImportTasks | Tasks to perform during file import. Comma separated list of one or more of the following values: '' | ||
| ==== R: Remark ==== | ==== R: Remark ==== | ||
| Lines of type R are silently ignored during import. R lines can be used to add comments to TPI file, to make it more readable by humans. | Lines of type R are silently ignored during import. R lines can be used to add comments to TPI file, to make it more readable by humans. | ||
reference/text_playlist_import_format_specification.1440877790.txt.gz · Last modified: 2019/07/09 16:19 (external edit)