jellyfin/MediaBrowser.Controller/Chapters/IChapterManager.cs

using System;
using System.Collections.Generic;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;

namespace MediaBrowser.Controller.Chapters
{
    /// <summary>
    /// Interface IChapterManager.
    /// </summary>
    public interface IChapterManager
    {
        /// <summary>
        /// Saves the chapters.
        /// </summary>
        /// <param name="itemId">The item.</param>
        /// <param name="chapters">The set of chapters.</param>
        void SaveChapters(Guid itemId, IReadOnlyList<ChapterInfo> chapters);

        /// <summary>
        /// Gets all chapters associated with the baseItem.
        /// </summary>
        /// <param name="baseItem">The baseitem.</param>
        /// <returns>A readonly list of chapter instances.</returns>
        IReadOnlyList<ChapterInfo> GetChapters(BaseItemDto baseItem);

        /// <summary>
        /// Gets a single chapter of a BaseItem on a specific index.
        /// </summary>
        /// <param name="baseItem">The baseitem.</param>
        /// <param name="index">The index of that chapter.</param>
        /// <returns>A chapter instance.</returns>
        ChapterInfo? GetChapter(BaseItemDto baseItem, int index);
    }
}