intro-skipper/README.md
TwistedUmbrellaX e8b70d5396
Hide the padding when hiding input (#75)
* Hide the padding when hiding input

* Fix a typo and add more error padding

* Update macOS documentation for 2024
2024-03-12 14:40:07 -04:00

2.7 KiB

Intro Skipper (beta)

Plugin Banner

Analyzes the audio of television episodes to detect and skip over intros.

System requirements

  • Jellyfin 10.8.4 (or newer)
  • Jellyfin's fork of ffmpeg must be installed, version 5.0.1-5 or newer
    • jellyfin/jellyfin 10.8.z container: preinstalled
    • linuxserver/jellyfin 10.8.z container: preinstalled
    • Debian Linux based native installs: provided by the jellyfin-ffmpeg5 package
    • MacOS native installs: build ffmpeg with chromaprint support (instructions)

Detection parameters

Show introductions will be detected if they are:

  • Located within the first 25% of an episode or the first 10 minutes, whichever is smaller
  • Between 15 seconds and 2 minutes long

Ending credits will be detected if they are shorter than 4 minutes.

These parameters can be configured by opening the plugin settings

Installation

Step 1: Install the plugin

  1. Add this plugin repository to your server: https://raw.githubusercontent.com/jumoog/intro-skipper/master/manifest.json
  2. Install the Intro Skipper plugin from the General section
  3. Restart Jellyfin

Step 2: Configure the plugin

  1. OPTIONAL: Enable automatic skipping or skip button
    1. Go to Dashboard -> Plugins -> Intro Skipper
    2. Check "Automatically skip intros" or "Show skip intro button" and click Save
  2. Go to Dashboard -> Scheduled Tasks -> Analyze Episodes and click the play button
  3. After a season has completed analyzing, play some episodes from it and observe the results
    1. Status updates are logged before analyzing each season of a show

Installation (MacOS)

  1. Build ffmpeg with chromaprint support using brew:
brew uninstall --force --ignore-dependencies ffmpeg
brew install chromaprint amiaopensource/amiaos/decklinksdk
brew tap homebrew-ffmpeg/ffmpeg
brew install homebrew-ffmpeg/ffmpeg/ffmpeg --with-chromaprint
brew link --overwrite ffmpeg
  1. Open ~/.config/jellyfin/encoding.xml and add or edit the following lines
    • Replace [FFMPEG_PATH] with the path returned by whereis ffmpeg
<EncoderAppPath>[FFMPEG_PATH]</EncoderAppPath>
<EncoderAppPathDisplay>[FFMPEG_PATH]</EncoderAppPathDisplay>
  1. Follow the general installation instructions above

Documentation

Documentation about how the API works can be found in api.md.