Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-26 14:30:25 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/overlays/direct_play.md

2.4 KiB
Raw Blame History

Direct Play Overlay

The direct_play Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)

This file works with Movie and Show Libraries.

Config

The below YAML in your config.yml will create the overlays:

libraries:
  Movies:
    overlay_path:
      - pmm: direct_play
  TV Shows:
    overlay_path:
      - pmm: direct_play
      - pmm: direct_play
        template_variables:
          overlay_level: season
      - pmm: direct_play
        template_variables:
          overlay_level: episode

Template Variables

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the templates_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All Shared Overlay Variables are available with the default values below as well as the additional Variables below which can be used to customize the file.

Variable Default
horizontal_offset 0
horizontal_align center
vertical_offset 150
vertical_align bottom
back_color #00000099
back_radius 30
back_width 305
back_height 170
Variable Description & Values
overlay_level Description: Choose the Overlay Level.
Values: season or episode

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    overlay_path:
      - pmm: direct_play
        template_variables:
          overlay_level: episode