Audio description

Version 1.2.3 · plug-in API >=1.14 <2.0

PublishedHow to add it
On this page

Audio description: Problems

Find what is wrong with Audio description, then follow the numbered answer.

Find your answer
Flow chart: Audio description is not working as it should. The same chart is written out in words after it.Failed or Not answeringNot supportedActive, but somethingis wrongNo Jellyfin keyNo Reelix keyNot checked yetA described film ismissingThe described track isnot keptAudio description isnot working as itshouldWhat does its tabsay?What is wrong?Start it again1Update it or updateStarboard2Add Jellyfin toStarboard3Add Reelix or stoppreferring4Check for describedtitles now5Check the track name6Activate the person7
The chart in words

Start: Audio description is not working as it should

1 Start it again

  1. On Audio description's tab, read the message under its state: it says why it stopped.
  2. Select Try again.
  3. If it stopped soon after an update, select Roll back to and the version you had. Read Updates.
  4. Still failing: go to System, then Logs, and find its name.

It rests after 10 minutes with nothing to do, and Starboard wakes it when it is needed. Resting is not a problem.

2 Update it or update Starboard

Your Starboard's plug-in API is outside what this version of Audio description works with, so Starboard stopped it.

  1. Select Check for an update on its tab.
  2. If there is none, update Starboard. Read Update Starboard.

3 Add Jellyfin to Starboard

"Starboard has no Jellyfin key to give yet: add Jellyfin in Settings, Apps" means Starboard has no Jellyfin key for it to use.

  1. Go to Settings, then Apps, and add Jellyfin with its API key. Read Add an app, in Starboard's help.
  2. Go to Settings, then Plug-ins, then Audio description.
  3. Select Check for described titles now.

4 Add Reelix or stop preferring

"Starboard has no Reelix key to give yet: add Reelix in Settings, Apps" means it cannot add the Audio description format to Reelix.

  • If you use Reelix, add it in Settings, then Apps, then select Apply the Reelix choice now on Audio description's tab.
  • If you do not use Reelix, deactivate Prefer releases with audio description. The rest of the plug-in works without Reelix.

5 Check for described titles now

"Not checked yet" and Checks tonight mean it has not read the library yet. It checks once a night at 04:20, in quiet hours.

  1. Go to Settings, then Plug-ins, then Audio description.
  2. Select Check for described titles now.
  3. Wait a minute or two, then open Titles with audio description.

If it still says "Not checked yet", the card shows what went wrong instead: read Add Jellyfin to Starboard.

6 Check the track name

It finds a described track by its name, because Jellyfin does not read the flag that marks one inside a file.

  • A track counts when its name says "Audio Description", "Audio described", "Descriptive audio", "Described", "DVS" or "AD" on its own, such as "English (Audio Description)".
  • A track whose name mentions commentary never counts.
  • A track with no name, or another name, is not found. In Jellyfin, play the film and open its list of sound tracks: it shows their names.
  • A film added since the last check is found at the next one. Select Check for described titles now to check straight away.

7 Activate the person

Jellyfin cannot pick a described track by itself. For each person activated, Jellyfin remembers the sound track they choose.

  1. Open People who want audio description on Audio description's tab.
  2. Activate the person. Starboard says "Audio description activated for" and their name.
  3. In Jellyfin, they choose the described track once for each film and series.

If Starboard says "That person is not in Jellyfin any more. Reload the page", reload the page and try again.

Report a problem

If none of these helps, tell its maker, with what its tab and the card say: the plug-ins' issues on GitHub.

Find out more

This page on GitHub, where the help is written.