Browse Source

add basic filler docs [no docker]

pull/453/head
Jason Dove 4 years ago
parent
commit
373daf9ce6
  1. 6
      README.md
  2. BIN
      docs/images/filler-preset-pad-to-30-with-commercials.png
  3. BIN
      docs/images/filler-preset-trailers-pre-roll.png
  4. 38
      docs/user-guide/filler.md
  5. 1
      mkdocs.yml

6
README.md

@ -18,11 +18,7 @@ Want to join the community or have a question? Join us on [Discord](https://disc
- [Jellyfin](https://jellyfin.org/) media and metadata - [Jellyfin](https://jellyfin.org/) media and metadata
- [Emby](https://emby.media/) media and metadata - [Emby](https://emby.media/) media and metadata
- Music video libraries - Music video libraries
- Pre-roll, mid-roll, post-roll filler options
## Planned Features
- Run as a Windows service
- Spots to fill unscheduled gaps
## License ## License

BIN
docs/images/filler-preset-pad-to-30-with-commercials.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/images/filler-preset-trailers-pre-roll.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

38
docs/user-guide/filler.md

@ -0,0 +1,38 @@
Filler is content that is used to fill otherwise unscheduled gaps, and to pad primary content to a desired time.
## Filler Kinds
There are a number of filler kinds supported by ErsatzTV:
- `Pre-roll`: filler that plays before each media item
- `Mid-roll`: filler that plays between chapters within each media item
- `Post-roll`: filler that plays after each media item
- `Tail`: filler that plays after all media items/filler and before the next schedule item
- `Fallback`: filler that is looped and cut as needed to fill any remaining gaps
## Filler Modes
`Pre-roll`, `mid-roll`, and `post-roll` filler support the following modes:
- `Count`: play a specific number of filler items from the collection
- `Duration`: play as many complete filler items that will fit in the specified duration
- `Pad`: after all other filler has been added, pad using additional filler until the wall clock minutes are a multiple of the selected number
## Filler Presets
To add filler to a schedule, a filler preset must first be created under `Lists` > `Filler Presets`.
Once a filler preset is created, it can be attached to any number of schedule items in the schedule items editor.
### Sample Preset: Trailers Pre-Roll
This preset will play exactly three items from the `All Trailers` smart collection before each media item.
![Trailers Pre-Roll](../images/filler-preset-trailers-pre-roll.png)
### Sample Preset: Pad To 30 Minutes With Commercials
This preset will pad each media item to 30 minutes using items from the `Short Commercials` smart collection.
Because `mid-roll` is selected as the filler kind, the filler will be approximately evenly distributed between chapters.
![Pad To 30 With Commercials](../images/filler-preset-pad-to-30-with-commercials.png)

1
mkdocs.yml

@ -7,6 +7,7 @@ nav:
- 'Create Channels': 'user-guide/create-channels.md' - 'Create Channels': 'user-guide/create-channels.md'
- 'Configure Clients': 'user-guide/configure-clients.md' - 'Configure Clients': 'user-guide/configure-clients.md'
- 'Advanced': - 'Advanced':
- 'Filler': 'user-guide/filler.md'
- 'Local Libraries': 'user-guide/local-libraries.md' - 'Local Libraries': 'user-guide/local-libraries.md'
- 'Search': 'user-guide/search.md' - 'Search': 'user-guide/search.md'
- 'Sample Schedules': 'user-guide/sample-schedules.md' - 'Sample Schedules': 'user-guide/sample-schedules.md'

Loading…
Cancel
Save