jellyfin/jellyfin.org
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.org.git synced 2024-11-23 05:49:52 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Create Media Segments Wiki Page (#1179)
Some checks are pending
build / Build (push) Waiting to run
Details
build / Deploy to GitHub Pages (push) Blocked by required conditions
Details
build / Deploy to Cloudflare Pages (push) Blocked by required conditions
Details
lint / Lint TypeScript/JavaScript (push) Waiting to run
Details
lint / Lint Markdown (push) Waiting to run
Details
test / Test URLs (test:blog-urls) (push) Waiting to run
Details
test / Test URLs (test:docs-urls) (push) Waiting to run
Details
test / Test URLs (test:web-urls) (push) Waiting to run
Details

Browse Source 
Co-authored-by: JPVenson <github@jpb.email>
Co-authored-by: JPVenson <ger-delta-07@hotmail.de>
Co-authored-by: Niels van Velzen <nielsvanvelzen@users.noreply.github.com>
Co-authored-by: 1hitsong <3330318+1hitsong@users.noreply.github.com>
Co-authored-by: Gauvain Perchey <68083474+Gauvino@users.noreply.github.com>
Co-authored-by: Joshua M. Boniface <joshua@boniface.me>
This commit is contained in:
felix920506 2024-10-31 14:38:51 -04:00 committed by GitHub
parent 09fac07dd0
commit 89521a41c6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/general/server/metadata/media-segments.md Normal file
View File

@ -0,0 +1,53 @@
---
uid: server-metadata-media-segments
title: Media segments
---
# Media segments
Media segments are a type of metadata for media files stored in Jellyfin. Unlike chapters, which have no type, media segments can contain type information, allowing different actions based on the type of each segment.
## Getting started
There's a few steps to follow if you want to use media segments:
1. Update your server to version 10.10 or above.
2. First, you'll need one or multiple plugins that can provide media segments. Read the [plugins section](#plugin-support) below to find out more.
3. Run the `Media segment scan` task in the dashboard to create segments immediately, this task also runs automatically in the background.
4. Enable actions for the different segment types, the way you do this differs per client, but they are generally found in the playback settings of the client.
## Types
The following types are currently available:
- Commercial
- Preview
- Recap
- Outro
- Intro
## An example
A video that is 16 minutes (00:16:00) long could have the following segments:
1. From 00:00:00 until 00:03:08 there is an `Intro` segment.
2. From 00:08:03 until 00:08:59 there is a `Commercial` segment.
3. From 00:14:30 until 00:16:00 there is an `Outro` segment.
Jellyfin can store this information and provide it to clients. Clients can then decide what they want to do with the provided information.
## Creating media segments
Media segments are provided by plugins. [Read more](#plugin-support)
## Clients
Media segments are currently only supported by the web client.
Upon receiving media segment information from the server, clients can choose to provide any number of actions based on the segment type, such as showing a "skip" button to skip the section. Because it is still a new feature, client support is very sparse and will take some time to become more wide-spread.
## Plugin support
Plugins can utilize this system to store their information about intros, outros, commercials and all other types of segments. This information can then be used by clients to provide actions, such as a "skip" button in their user interface. This approach generalizes how segments are handled, so more platforms can be easily supported, without custom modifications to clients.
There is an official `Chapter Segments Provider` plugin that creates media segments from chapters.