diff options
| author | Marc Brooks <IDisposable@gmail.com> | 2025-02-03 19:48:59 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-02-03 19:48:59 -0600 |
| commit | e8cbcde02ebd930a5eeb6c95e0875a9e30acb3e8 (patch) | |
| tree | 2ecd43f232012c8f037f4cd6fee4168e46d01aa3 /MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs | |
| parent | 6dc61a430ba3a8480399309f277e5debfd6403ba (diff) | |
| parent | d376b5fbc7cf3ae7440a606a9e885d70605956bd (diff) | |
Merge branch 'master' into sort-nfo-data
Diffstat (limited to 'MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs')
| -rw-r--r-- | MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs b/MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs new file mode 100644 index 000000000..39bb58bef --- /dev/null +++ b/MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Model; +using MediaBrowser.Model.MediaSegments; + +namespace MediaBrowser.Controller; + +/// <summary> +/// Provides methods for Obtaining the Media Segments from an Item. +/// </summary> +public interface IMediaSegmentProvider +{ + /// <summary> + /// Gets the provider name. + /// </summary> + string Name { get; } + + /// <summary> + /// Enumerates all Media Segments from an Media Item. + /// </summary> + /// <param name="request">Arguments to enumerate MediaSegments.</param> + /// <param name="cancellationToken">Abort token.</param> + /// <returns>A list of all MediaSegments found from this provider.</returns> + Task<IReadOnlyList<MediaSegmentDto>> GetMediaSegments(MediaSegmentGenerationRequest request, CancellationToken cancellationToken); + + /// <summary> + /// Should return support state for the given item. + /// </summary> + /// <param name="item">The base item to extract segments from.</param> + /// <returns>True if item is supported, otherwise false.</returns> + ValueTask<bool> Supports(BaseItem item); +} |
