aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs
diff options
context:
space:
mode:
authorJosh Soref <2119212+jsoref@users.noreply.github.com>2024-12-07 21:52:54 -1000
committerJosh Soref <2119212+jsoref@users.noreply.github.com>2025-01-25 20:05:15 -0500
commit044cf9fb8597c6507a249d17cea443305881c4f6 (patch)
treeb9f98bf97faeb0b7cc5918a6d442ca8702d3c358 /MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs
parentb318f335991167102a5fa8d65030d200bbec898d (diff)
chore: fix spelling
* a * acceleration * addition * altogether * api clients * artist * associated * bandwidth * cannot * capabilities * case-insensitive * case-sensitive * configuration * delimiter * dependent * diacritics * directors * enable * explicitly * filters * finish * have * hierarchy * implicit * include * information * into * its * keepalive * localization * macos * manual * matching * metadata * nonexistent * options * overridden * parsed * parser * playback * preferring * processes * processing * provider * ratings * retrieval * running * segments * separate * should * station * subdirectories * superseded * supported * system * than * the * throws * transpose * valid * was link: forum or chat rooms Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Diffstat (limited to 'MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs')
-rw-r--r--MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs80
1 files changed, 0 insertions, 80 deletions
diff --git a/MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs b/MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs
deleted file mode 100644
index 672f27eca2..0000000000
--- a/MediaBrowser.Controller/MediaSegements/IMediaSegmentManager.cs
+++ /dev/null
@@ -1,80 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
-using Jellyfin.Data.Entities;
-using Jellyfin.Data.Enums;
-using MediaBrowser.Controller.Entities;
-using MediaBrowser.Model.MediaSegments;
-
-namespace MediaBrowser.Controller;
-
-/// <summary>
-/// Defines methods for interacting with media segments.
-/// </summary>
-public interface IMediaSegmentManager
-{
- /// <summary>
- /// Uses all segment providers enabled for the <see cref="BaseItem"/>'s library to get the Media Segments.
- /// </summary>
- /// <param name="baseItem">The Item to evaluate.</param>
- /// <param name="overwrite">If set, will remove existing segments and replace it with new ones otherwise will check for existing segments and if found any, stops.</param>
- /// <param name="cancellationToken">stop request token.</param>
- /// <returns>A task that indicates the Operation is finished.</returns>
- Task RunSegmentPluginProviders(BaseItem baseItem, bool overwrite, CancellationToken cancellationToken);
-
- /// <summary>
- /// Returns if this item supports media segments.
- /// </summary>
- /// <param name="baseItem">The base Item to check.</param>
- /// <returns>True if supported otherwise false.</returns>
- bool IsTypeSupported(BaseItem baseItem);
-
- /// <summary>
- /// Creates a new Media Segment associated with an Item.
- /// </summary>
- /// <param name="mediaSegment">The segment to create.</param>
- /// <param name="segmentProviderId">The id of the Provider who created this segment.</param>
- /// <returns>The created Segment entity.</returns>
- Task<MediaSegmentDto> CreateSegmentAsync(MediaSegmentDto mediaSegment, string segmentProviderId);
-
- /// <summary>
- /// Deletes a single media segment.
- /// </summary>
- /// <param name="segmentId">The <see cref="MediaSegment.Id"/> to delete.</param>
- /// <returns>a task.</returns>
- Task DeleteSegmentAsync(Guid segmentId);
-
- /// <summary>
- /// Obtains all segments accociated with the itemId.
- /// </summary>
- /// <param name="itemId">The id of the <see cref="BaseItem"/>.</param>
- /// <param name="typeFilter">filteres all media segments of the given type to be included. If null all types are included.</param>
- /// <param name="filterByProvider">When set filteres the segments to only return those that which providers are currently enabled on their library.</param>
- /// <returns>An enumerator of <see cref="MediaSegmentDto"/>'s.</returns>
- Task<IEnumerable<MediaSegmentDto>> GetSegmentsAsync(Guid itemId, IEnumerable<MediaSegmentType>? typeFilter, bool filterByProvider = true);
-
- /// <summary>
- /// Obtains all segments accociated with the itemId.
- /// </summary>
- /// <param name="item">The <see cref="BaseItem"/>.</param>
- /// <param name="typeFilter">filteres all media segments of the given type to be included. If null all types are included.</param>
- /// <param name="filterByProvider">When set filteres the segments to only return those that which providers are currently enabled on their library.</param>
- /// <returns>An enumerator of <see cref="MediaSegmentDto"/>'s.</returns>
- Task<IEnumerable<MediaSegmentDto>> GetSegmentsAsync(BaseItem item, IEnumerable<MediaSegmentType>? typeFilter, bool filterByProvider = true);
-
- /// <summary>
- /// Gets information about any media segments stored for the given itemId.
- /// </summary>
- /// <param name="itemId">The id of the <see cref="BaseItem"/>.</param>
- /// <returns>True if there are any segments stored for the item, otherwise false.</returns>
- /// TODO: this should be async but as the only caller BaseItem.GetVersionInfo isn't async, this is also not. Venson.
- bool HasSegments(Guid itemId);
-
- /// <summary>
- /// Gets a list of all registered Segment Providers and their IDs.
- /// </summary>
- /// <param name="item">The media item that should be tested for providers.</param>
- /// <returns>A list of all providers for the tested item.</returns>
- IEnumerable<(string Name, string Id)> GetSupportedProviders(BaseItem item);
-}