jellyfin/MediaBrowser.Controller/IO/IPathManager.cs

using System.Collections.Generic;
using MediaBrowser.Controller.Entities;

namespace MediaBrowser.Controller.IO;

/// <summary>
/// Interface IPathManager.
/// </summary>
public interface IPathManager
{
    /// <summary>
    /// Gets the path to the trickplay image base folder.
    /// </summary>
    /// <param name="item">The item.</param>
    /// <param name="saveWithMedia">Whether or not the tile should be saved next to the media file.</param>
    /// <returns>The absolute path.</returns>
    public string GetTrickplayDirectory(BaseItem item, bool saveWithMedia = false);

    /// <summary>
    /// Gets the path to the subtitle file.
    /// </summary>
    /// <param name="mediaSourceId">The media source id.</param>
    /// <param name="streamIndex">The stream index.</param>
    /// <param name="extension">The subtitle file extension.</param>
    /// <returns>The absolute path, or <c>null</c> if <paramref name="mediaSourceId"/> is not a valid GUID.</returns>
    public string? GetSubtitlePath(string mediaSourceId, int streamIndex, string extension);

    /// <summary>
    /// Gets the path to the subtitle file.
    /// </summary>
    /// <param name="mediaSourceId">The media source id.</param>
    /// <returns>The absolute path, or <c>null</c> if <paramref name="mediaSourceId"/> is not a valid GUID.</returns>
    public string? GetSubtitleFolderPath(string mediaSourceId);

    /// <summary>
    /// Gets the path to the attachment file.
    /// </summary>
    /// <param name="mediaSourceId">The media source id.</param>
    /// <param name="fileName">The attachmentFileName index.</param>
    /// <returns>The absolute path, or <c>null</c> if <paramref name="mediaSourceId"/> is not a valid GUID.</returns>
    public string? GetAttachmentPath(string mediaSourceId, string fileName);

    /// <summary>
    /// Gets the path to the attachment folder.
    /// </summary>
    /// <param name="mediaSourceId">The media source id.</param>
    /// <returns>The absolute path, or <c>null</c> if <paramref name="mediaSourceId"/> is not a valid GUID.</returns>
    public string? GetAttachmentFolderPath(string mediaSourceId);

    /// <summary>
    /// Gets the chapter images data path.
    /// </summary>
    /// <param name="item">The base item.</param>
    /// <returns>The chapter images data path.</returns>
    public string GetChapterImageFolderPath(BaseItem item);

    /// <summary>
    /// Gets the chapter images path.
    /// </summary>
    /// <param name="item">The base item.</param>
    /// <param name="chapterPositionTicks">The chapter position.</param>
    /// <returns>The chapter images data path.</returns>
    public string GetChapterImagePath(BaseItem item, long chapterPositionTicks);

    /// <summary>
    /// Gets the paths of extracted data folders.
    /// </summary>
    /// <param name="item">The base item.</param>
    /// <returns>The absolute paths.</returns>
    public IReadOnlyList<string> GetExtractedDataPaths(BaseItem item);
}