mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-07 11:57:55 +02:00
406 lines
No EOL
15 KiB
C#
406 lines
No EOL
15 KiB
C#
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Controller.Entities.Audio;
|
|
using MediaBrowser.Controller.Entities.TV;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Controller.Resolvers;
|
|
using MediaBrowser.Controller.Sorting;
|
|
using MediaBrowser.Model.Entities;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Controller.Library
|
|
{
|
|
/// <summary>
|
|
/// Interface ILibraryManager
|
|
/// </summary>
|
|
public interface ILibraryManager
|
|
{
|
|
/// <summary>
|
|
/// Resolves the path.
|
|
/// </summary>
|
|
/// <param name="fileInfo">The file information.</param>
|
|
/// <param name="parent">The parent.</param>
|
|
/// <returns>BaseItem.</returns>
|
|
BaseItem ResolvePath(FileSystemInfo fileInfo,
|
|
Folder parent = null);
|
|
|
|
/// <summary>
|
|
/// Resolves a set of files into a list of BaseItem
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <param name="files">The files.</param>
|
|
/// <param name="directoryService">The directory service.</param>
|
|
/// <param name="parent">The parent.</param>
|
|
/// <param name="collectionType">Type of the collection.</param>
|
|
/// <returns>List{``0}.</returns>
|
|
IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemInfo> files,
|
|
IDirectoryService directoryService,
|
|
Folder parent, string
|
|
collectionType = null);
|
|
|
|
/// <summary>
|
|
/// Gets the root folder.
|
|
/// </summary>
|
|
/// <value>The root folder.</value>
|
|
AggregateFolder RootFolder { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a Person
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{Person}.</returns>
|
|
Person GetPerson(string name);
|
|
|
|
/// <summary>
|
|
/// Gets the artist.
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{Artist}.</returns>
|
|
MusicArtist GetArtist(string name);
|
|
|
|
/// <summary>
|
|
/// Gets a Studio
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{Studio}.</returns>
|
|
Studio GetStudio(string name);
|
|
|
|
/// <summary>
|
|
/// Gets a Genre
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{Genre}.</returns>
|
|
Genre GetGenre(string name);
|
|
|
|
/// <summary>
|
|
/// Gets the genre.
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{MusicGenre}.</returns>
|
|
MusicGenre GetMusicGenre(string name);
|
|
|
|
/// <summary>
|
|
/// Gets the game genre.
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>Task{GameGenre}.</returns>
|
|
GameGenre GetGameGenre(string name);
|
|
|
|
/// <summary>
|
|
/// Gets a Year
|
|
/// </summary>
|
|
/// <param name="value">The value.</param>
|
|
/// <returns>Task{Year}.</returns>
|
|
/// <exception cref="System.ArgumentOutOfRangeException"></exception>
|
|
Year GetYear(int value);
|
|
|
|
/// <summary>
|
|
/// Validate and refresh the People sub-set of the IBN.
|
|
/// The items are stored in the db but not loaded into memory until actually requested by an operation.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <param name="progress">The progress.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress);
|
|
|
|
/// <summary>
|
|
/// Reloads the root media folder
|
|
/// </summary>
|
|
/// <param name="progress">The progress.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Queues the library scan.
|
|
/// </summary>
|
|
void QueueLibraryScan();
|
|
|
|
/// <summary>
|
|
/// Gets the default view.
|
|
/// </summary>
|
|
/// <returns>IEnumerable{VirtualFolderInfo}.</returns>
|
|
IEnumerable<VirtualFolderInfo> GetVirtualFolders();
|
|
|
|
/// <summary>
|
|
/// Gets the item by id.
|
|
/// </summary>
|
|
/// <param name="id">The id.</param>
|
|
/// <returns>BaseItem.</returns>
|
|
BaseItem GetItemById(Guid id);
|
|
|
|
/// <summary>
|
|
/// Gets the memory item by identifier.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <returns>BaseItem.</returns>
|
|
BaseItem GetMemoryItemById(Guid id);
|
|
|
|
/// <summary>
|
|
/// Gets the intros.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="user">The user.</param>
|
|
/// <returns>IEnumerable{System.String}.</returns>
|
|
Task<IEnumerable<Video>> GetIntros(BaseItem item, User user);
|
|
|
|
/// <summary>
|
|
/// Gets all intro files.
|
|
/// </summary>
|
|
/// <returns>IEnumerable{System.String}.</returns>
|
|
IEnumerable<string> GetAllIntroFiles();
|
|
|
|
/// <summary>
|
|
/// Adds the parts.
|
|
/// </summary>
|
|
/// <param name="rules">The rules.</param>
|
|
/// <param name="pluginFolders">The plugin folders.</param>
|
|
/// <param name="resolvers">The resolvers.</param>
|
|
/// <param name="introProviders">The intro providers.</param>
|
|
/// <param name="itemComparers">The item comparers.</param>
|
|
/// <param name="postscanTasks">The postscan tasks.</param>
|
|
void AddParts(IEnumerable<IResolverIgnoreRule> rules,
|
|
IEnumerable<IVirtualFolderCreator> pluginFolders,
|
|
IEnumerable<IItemResolver> resolvers,
|
|
IEnumerable<IIntroProvider> introProviders,
|
|
IEnumerable<IBaseItemComparer> itemComparers,
|
|
IEnumerable<ILibraryPostScanTask> postscanTasks);
|
|
|
|
/// <summary>
|
|
/// Sorts the specified items.
|
|
/// </summary>
|
|
/// <param name="items">The items.</param>
|
|
/// <param name="user">The user.</param>
|
|
/// <param name="sortBy">The sort by.</param>
|
|
/// <param name="sortOrder">The sort order.</param>
|
|
/// <returns>IEnumerable{BaseItem}.</returns>
|
|
IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy,
|
|
SortOrder sortOrder);
|
|
|
|
/// <summary>
|
|
/// Ensure supplied item has only one instance throughout
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <returns>The proper instance to the item</returns>
|
|
BaseItem GetOrAddByReferenceItem(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Gets the user root folder.
|
|
/// </summary>
|
|
/// <returns>UserRootFolder.</returns>
|
|
Folder GetUserRootFolder();
|
|
|
|
/// <summary>
|
|
/// Creates the item.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CreateItem(BaseItem item, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Creates the items.
|
|
/// </summary>
|
|
/// <param name="items">The items.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Updates the item.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="updateReason">The update reason.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task.</returns>
|
|
Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Retrieves the item.
|
|
/// </summary>
|
|
/// <param name="id">The id.</param>
|
|
/// <returns>BaseItem.</returns>
|
|
BaseItem RetrieveItem(Guid id);
|
|
|
|
/// <summary>
|
|
/// Occurs when [item added].
|
|
/// </summary>
|
|
event EventHandler<ItemChangeEventArgs> ItemAdded;
|
|
|
|
/// <summary>
|
|
/// Occurs when [item updated].
|
|
/// </summary>
|
|
event EventHandler<ItemChangeEventArgs> ItemUpdated;
|
|
/// <summary>
|
|
/// Occurs when [item removed].
|
|
/// </summary>
|
|
event EventHandler<ItemChangeEventArgs> ItemRemoved;
|
|
|
|
/// <summary>
|
|
/// Reports the item removed.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
void ReportItemRemoved(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Finds the type of the collection.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetContentType(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Gets the type of the inherited content.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetInheritedContentType(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Gets the type of the configured content.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetConfiguredContentType(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Gets the type of the configured content.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns>System.String.</returns>
|
|
string GetConfiguredContentType(string path);
|
|
|
|
/// <summary>
|
|
/// Normalizes the root path list.
|
|
/// </summary>
|
|
/// <param name="paths">The paths.</param>
|
|
/// <returns>IEnumerable{System.String}.</returns>
|
|
IEnumerable<string> NormalizeRootPathList(IEnumerable<string> paths);
|
|
|
|
/// <summary>
|
|
/// Registers the item.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
void RegisterItem(BaseItem item);
|
|
|
|
/// <summary>
|
|
/// Deletes the item.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="options">The options.</param>
|
|
/// <returns>Task.</returns>
|
|
Task DeleteItem(BaseItem item, DeleteOptions options);
|
|
|
|
/// <summary>
|
|
/// Replaces the videos with primary versions.
|
|
/// </summary>
|
|
/// <param name="items">The items.</param>
|
|
/// <returns>IEnumerable{BaseItem}.</returns>
|
|
IEnumerable<BaseItem> ReplaceVideosWithPrimaryVersions(IEnumerable<BaseItem> items);
|
|
|
|
/// <summary>
|
|
/// Gets the named view.
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
/// <param name="name">The name.</param>
|
|
/// <param name="parentId">The parent identifier.</param>
|
|
/// <param name="viewType">Type of the view.</param>
|
|
/// <param name="sortName">Name of the sort.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task<UserView>.</returns>
|
|
Task<UserView> GetNamedView(User user,
|
|
string name,
|
|
string parentId,
|
|
string viewType,
|
|
string sortName,
|
|
CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the named view.
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
/// <param name="name">The name.</param>
|
|
/// <param name="viewType">Type of the view.</param>
|
|
/// <param name="sortName">Name of the sort.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns>Task<UserView>.</returns>
|
|
Task<UserView> GetNamedView(User user,
|
|
string name,
|
|
string viewType,
|
|
string sortName,
|
|
CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Determines whether [is video file] [the specified path].
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns><c>true</c> if [is video file] [the specified path]; otherwise, <c>false</c>.</returns>
|
|
bool IsVideoFile(string path);
|
|
|
|
/// <summary>
|
|
/// Determines whether [is audio file] [the specified path].
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns><c>true</c> if [is audio file] [the specified path]; otherwise, <c>false</c>.</returns>
|
|
bool IsAudioFile(string path);
|
|
|
|
/// <summary>
|
|
/// Gets the season number from path.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns>System.Nullable<System.Int32>.</returns>
|
|
int? GetSeasonNumberFromPath(string path);
|
|
|
|
/// <summary>
|
|
/// Fills the missing episode numbers from path.
|
|
/// </summary>
|
|
/// <param name="episode">The episode.</param>
|
|
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
|
|
bool FillMissingEpisodeNumbersFromPath(Episode episode);
|
|
|
|
/// <summary>
|
|
/// Parses the name.
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns>ItemInfo.</returns>
|
|
ItemLookupInfo ParseName(string name);
|
|
|
|
/// <summary>
|
|
/// Gets the new item identifier.
|
|
/// </summary>
|
|
/// <param name="key">The key.</param>
|
|
/// <param name="type">The type.</param>
|
|
/// <returns>Guid.</returns>
|
|
Guid GetNewItemId(string key, Type type);
|
|
|
|
/// <summary>
|
|
/// Finds the trailers.
|
|
/// </summary>
|
|
/// <param name="owner">The owner.</param>
|
|
/// <param name="fileSystemChildren">The file system children.</param>
|
|
/// <param name="directoryService">The directory service.</param>
|
|
/// <returns>IEnumerable<Trailer>.</returns>
|
|
IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemInfo> fileSystemChildren,
|
|
IDirectoryService directoryService);
|
|
|
|
/// <summary>
|
|
/// Finds the extras.
|
|
/// </summary>
|
|
/// <param name="owner">The owner.</param>
|
|
/// <param name="fileSystemChildren">The file system children.</param>
|
|
/// <param name="directoryService">The directory service.</param>
|
|
/// <returns>IEnumerable<Video>.</returns>
|
|
IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemInfo> fileSystemChildren,
|
|
IDirectoryService directoryService);
|
|
|
|
/// <summary>
|
|
/// Gets the collection folders.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <returns>IEnumerable<Folder>.</returns>
|
|
IEnumerable<Folder> GetCollectionFolders(BaseItem item);
|
|
}
|
|
} |