diff options
| author | Josh Soref <2119212+jsoref@users.noreply.github.com> | 2024-12-07 21:52:54 -1000 |
|---|---|---|
| committer | Josh Soref <2119212+jsoref@users.noreply.github.com> | 2025-01-25 20:05:15 -0500 |
| commit | 044cf9fb8597c6507a249d17cea443305881c4f6 (patch) | |
| tree | b9f98bf97faeb0b7cc5918a6d442ca8702d3c358 /MediaBrowser.Controller/MediaSegments/IMediaSegmentProvider.cs | |
| parent | b318f335991167102a5fa8d65030d200bbec898d (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/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); +} |
