From 0bb2cb11089851fffd150e06e2ff086563e59a9e Mon Sep 17 00:00:00 2001 From: DarkFighterLuke <31162436+DarkFighterLuke@users.noreply.github.com> Date: Thu, 12 Sep 2024 16:10:00 +0200 Subject: [PATCH] Update README.md Add playback progress synchronization info --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 6ab472d..57ec07e 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ Once installed, you have to configure the following parameters in the plugin con
  • TubeArchivist instance address
  • TubeArchivist API key
  • Overviews length (channels and videos descriptions)
    • +
  • Playback synchronization settings discussed in the Playback synchronization paragraph
    • ![Plugin configuration](https://github.com/tubearchivist/tubearchivist-jf-plugin/assets/31162436/d34464ea-ddfb-44b3-9d3e-5d5974956c58) @@ -65,6 +66,26 @@ _NOTE: If you are using Docker containers, it is important to mount the TubeArch 4. Scrolling down, uncheck all metadata and image providers except `TubeArchivist`. (You won't find TubeArchivist in seasons providers, so just disable everything there) 5. Save and come back to Home, you will see the newly added library. Jellyfin will have executed the metadata fetching for you after the collection creation and then you will see the metadata and the images of channels and videos + +## Playback synchronization +

    Starting from v1.3.1 this plugin offers playback progress and watched status bidirectional synchronization, but you can choose to enable only a one way synchronization (Jellyfin->TubeArchivist or TubeArchivist->Jellyfin) too.

    + +### Jellyfin->TubeArchivist synchronization +

    This kind of synchronization is done listening for progress and watched status changes while playing the videos for the specified users.
    Furthermore, there is a task that runs at Jellyfin startup to synchronize the whole library.

    +

    In the plugin configuration you will find these settings:

    + +![JF->TA playback synchronization settings](https://github.com/user-attachments/assets/dc6be82f-e685-4896-a502-317681c47fc7) +

    In the text field you can specify one Jellyfin username to synchronize data of to TubeArchivist.

    + +### TubeArchivist->Jellyfin synchronization +

    This kind of synchronization is done using a Jellyfin scheduled task that regularly synchronizes data from TubeArchivist API to Jellyfin.

    +

    In the plugin configuration you will find these settings:

    + +![TA->JF playback synchronization settings](https://github.com/user-attachments/assets/1b4c33af-834f-45b3-9057-71830e7c8b4f) +

    In the first text field you can specify one or more Jellyfin usernames to update data for.
    +In the second field you can specify the interval in seconds the task should run at, so that you can choose according to your system requirements. The lower is the interval the higher will be the resources consuption on your system.

    + + ## Build 1. To build this plugin you will need [.Net 8.x](https://dotnet.microsoft.com/download/dotnet/8.0).