2013-04-07 20:55:05 +00:00
|
|
|
|
using MediaBrowser.Controller.Entities;
|
2013-06-23 17:48:30 +00:00
|
|
|
|
using MediaBrowser.Controller.Library;
|
2013-06-28 20:25:58 +00:00
|
|
|
|
using MediaBrowser.Model.Entities;
|
2013-10-30 21:33:27 +00:00
|
|
|
|
using MediaBrowser.Model.Providers;
|
2013-04-07 20:55:05 +00:00
|
|
|
|
using System.Collections.Generic;
|
2013-03-08 05:08:27 +00:00
|
|
|
|
using System.IO;
|
|
|
|
|
using System.Threading;
|
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Providers
|
|
|
|
|
{
|
2013-06-23 17:48:30 +00:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Interface IProviderManager
|
|
|
|
|
/// </summary>
|
2013-04-07 20:55:05 +00:00
|
|
|
|
public interface IProviderManager
|
2013-03-08 05:08:27 +00:00
|
|
|
|
{
|
2014-01-28 18:37:01 +00:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Refreshes the metadata.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="options">The options.</param>
|
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
|
/// <returns>Task.</returns>
|
|
|
|
|
Task RefreshMetadata(IHasMetadata item, MetadataRefreshOptions options, CancellationToken cancellationToken);
|
|
|
|
|
|
2013-06-23 17:48:30 +00:00
|
|
|
|
/// <summary>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// Executes the metadata providers.
|
2013-06-23 17:48:30 +00:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// <param name="force">if set to <c>true</c> [force].</param>
|
|
|
|
|
/// <returns>Task{System.Boolean}.</returns>
|
2014-01-28 18:37:01 +00:00
|
|
|
|
Task<ItemUpdateType?> ExecuteMetadataProviders(BaseItem item, CancellationToken cancellationToken, bool force = false);
|
2013-06-23 17:48:30 +00:00
|
|
|
|
|
2013-03-08 05:08:27 +00:00
|
|
|
|
/// <summary>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// Saves the image.
|
2013-03-08 05:08:27 +00:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// <param name="url">The URL.</param>
|
|
|
|
|
/// <param name="resourcePool">The resource pool.</param>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
2013-03-08 05:08:27 +00:00
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
|
/// <returns>Task.</returns>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
Task SaveImage(BaseItem item, string url, SemaphoreSlim resourcePool, ImageType type, int? imageIndex, CancellationToken cancellationToken);
|
2013-03-08 05:08:27 +00:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// Saves the image.
|
2013-03-08 05:08:27 +00:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// <param name="source">The source.</param>
|
|
|
|
|
/// <param name="mimeType">Type of the MIME.</param>
|
|
|
|
|
/// <param name="type">The type.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
2013-10-22 19:03:21 +00:00
|
|
|
|
/// <param name="sourceUrl">The source URL.</param>
|
2013-03-08 05:08:27 +00:00
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2013-06-28 20:25:58 +00:00
|
|
|
|
/// <returns>Task.</returns>
|
2013-10-22 19:03:21 +00:00
|
|
|
|
Task SaveImage(BaseItem item, Stream source, string mimeType, ImageType type, int? imageIndex, string sourceUrl, CancellationToken cancellationToken);
|
2013-03-08 05:08:27 +00:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Adds the metadata providers.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="providers">The providers.</param>
|
2013-10-30 21:33:27 +00:00
|
|
|
|
/// <param name="imageProviders">The image providers.</param>
|
2014-01-28 18:37:01 +00:00
|
|
|
|
/// <param name="metadataServices">The metadata services.</param>
|
|
|
|
|
/// <param name="metadataProviders">The metadata providers.</param>
|
|
|
|
|
void AddParts(IEnumerable<BaseMetadataProvider> providers, IEnumerable<IImageProvider> imageProviders, IEnumerable<IMetadataService> metadataServices, IEnumerable<IMetadataProvider> metadataProviders);
|
2013-10-30 21:33:27 +00:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the available remote images.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2013-11-01 01:48:14 +00:00
|
|
|
|
/// <param name="providerName">Name of the provider.</param>
|
|
|
|
|
/// <param name="type">The type.</param>
|
2013-10-30 21:33:27 +00:00
|
|
|
|
/// <returns>Task{IEnumerable{RemoteImageInfo}}.</returns>
|
2013-11-01 01:48:14 +00:00
|
|
|
|
Task<IEnumerable<RemoteImageInfo>> GetAvailableRemoteImages(BaseItem item, CancellationToken cancellationToken, string providerName = null, ImageType? type = null);
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the image providers.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
2014-01-28 18:37:01 +00:00
|
|
|
|
/// <returns>IEnumerable{ImageProviderInfo}.</returns>
|
|
|
|
|
IEnumerable<ImageProviderInfo> GetImageProviderInfo(BaseItem item);
|
2013-03-08 05:08:27 +00:00
|
|
|
|
}
|
|
|
|
|
}
|